SystemInformationToolbarItem.php 10.2 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
<?php
namespace TYPO3\CMS\Backend\Backend\ToolbarItems;

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

17
18
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
19
20
21
use TYPO3\CMS\Backend\Toolbar\ToolbarItemInterface;
use TYPO3\CMS\Backend\Toolbar\Enumeration\InformationStatus;
use TYPO3\CMS\Backend\Utility\BackendUtility;
22
23
use TYPO3\CMS\Core\Imaging\Icon;
use TYPO3\CMS\Core\Imaging\IconFactory;
24
use TYPO3\CMS\Core\Page\PageRenderer;
25
use TYPO3\CMS\Core\Utility\CommandUtility;
26
use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
27
28
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Core\Utility\StringUtility;
29
use TYPO3\CMS\Fluid\View\StandaloneView;
30
31
32
33

/**
 * Render system info toolbar item
 */
34
35
36
37
38
39
class SystemInformationToolbarItem implements ToolbarItemInterface {

	/**
	 * @var StandaloneView
	 */
	protected $standaloneView = NULL;
40
41

	/**
42
	 * Template file for the dropdown menu
43
	 */
44
	const TOOLBAR_MENU_TEMPLATE = 'SystemInformation.html';
45
46
47
48
49
50
51
52
53
54
55

	/**
	 * Number displayed as badge on the dropdown trigger
	 *
	 * @var int
	 */
	protected $totalCount = 0;

	/**
	 * Holds the highest severity
	 *
56
	 * @var InformationStatus
57
	 */
58
	protected $highestSeverity;
59

60
61
62
63
64
65
66
	/**
	 * The CSS class for the badge
	 *
	 * @var string
	 */
	protected $severityBadgeClass = '';

67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
	/**
	 * @var array
	 */
	protected $systemInformation = array();

	/**
	 * @var array
	 */
	protected $systemMessages = array();

	/**
	 * @var \TYPO3\CMS\Extbase\SignalSlot\Dispatcher
	 */
	protected $signalSlotDispatcher = NULL;

82
83
84
85
86
	/**
	 * @var IconFactory
	 */
	protected $iconFactory;

87
88
89
90
91
92
93
	/**
	 * Constructor
	 */
	public function __construct() {
		if (!$this->checkAccess()) {
			return;
		}
94
		$this->iconFactory = GeneralUtility::makeInstance(IconFactory::class);
95

96
97
98
99
		$extPath = ExtensionManagementUtility::extPath('backend');
		/* @var $view StandaloneView */
		$this->standaloneView = GeneralUtility::makeInstance(StandaloneView::class);
		$this->standaloneView->setTemplatePathAndFilename($extPath . 'Resources/Private/Templates/ToolbarMenu/' . static::TOOLBAR_MENU_TEMPLATE);
100

101
		$this->getPageRenderer()->loadRequireJsModule('TYPO3/CMS/Backend/Toolbar/SystemInformationMenu');
102
103

		$this->highestSeverity = InformationStatus::cast(InformationStatus::STATUS_INFO);
104
	}
105

106
107
108
109
	/**
	 * Collect the information for the menu
	 */
	protected function collectInformation() {
110
		$this->getWebServer();
111
112
113
114
115
116
117
118
		$this->getPhpVersion();
		$this->getDatabase();
		$this->getApplicationContext();
		$this->getGitRevision();
		$this->getOperatingSystem();

		$this->emitGetSystemInformation();
		$this->emitLoadMessages();
119

120
		$this->severityBadgeClass = !$this->highestSeverity->equals(InformationStatus::STATUS_NOTICE) ? 'badge-' . (string)$this->highestSeverity : '';
121
122
123
124
125
	}

	/**
	 * Renders the menu for AJAX calls
	 *
126
127
128
	 * @param ServerRequestInterface $request
	 * @param ResponseInterface $response
	 * @return ResponseInterface
129
	 */
130
	public function renderMenuAction(ServerRequestInterface $request, ResponseInterface $response) {
131
		$this->collectInformation();
132
133
134
135

		$response->getBody()->write($this->getDropDown());
		$response = $response->withHeader('Content-Type', 'text/html; charset=utf-8');
		return $response;
136
137
138
139
	}

	/**
	 * Gets the PHP version
140
141
	 *
	 * @return void
142
143
144
145
146
147
148
149
150
151
152
	 */
	protected function getPhpVersion() {
		$this->systemInformation[] = array(
			'title' => $this->getLanguageService()->sL('LLL:EXT:lang/locallang_core.xlf:toolbarItems.sysinfo.phpversion', TRUE),
			'value' => PHP_VERSION,
			'icon' => '<span class="fa fa-code"></span>'
		);
	}

	/**
	 * Get the database info
153
154
	 *
	 * @return void
155
156
157
158
159
160
161
162
163
164
165
	 */
	protected function getDatabase() {
		$this->systemInformation[] = array(
			'title' => $this->getLanguageService()->sL('LLL:EXT:lang/locallang_core.xlf:toolbarItems.sysinfo.database', TRUE),
			'value' => $this->getDatabaseConnection()->getServerVersion(),
			'icon' => '<span class="fa fa-database"></span>'
		);
	}

	/**
	 * Gets the application context
166
167
	 *
	 * @return void
168
169
170
171
172
173
	 */
	protected function getApplicationContext() {
		$applicationContext = GeneralUtility::getApplicationContext();
		$this->systemInformation[] = array(
			'title' => $this->getLanguageService()->sL('LLL:EXT:lang/locallang_core.xlf:toolbarItems.sysinfo.applicationcontext', TRUE),
			'value' => (string)$applicationContext,
174
			'status' => $applicationContext->isProduction() ? InformationStatus::STATUS_OK : InformationStatus::STATUS_WARNING,
175
176
177
178
179
180
			'icon' => '<span class="fa fa-tasks"></span>'
		);
	}

	/**
	 * Gets the current GIT revision and branch
181
182
	 *
	 * @return void
183
184
185
	 */
	protected function getGitRevision() {
		if (!StringUtility::endsWith(TYPO3_version, '-dev') || \TYPO3\CMS\Core\Core\SystemEnvironmentBuilder::isFunctionDisabled('exec')) {
186
			return;
187
188
189
190
191
		}
		// check if git exists
		CommandUtility::exec('git --version', $_, $returnCode);
		if ((int)$returnCode !== 0) {
			// git is not available
192
			return;
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
		}

		$revision = trim(CommandUtility::exec('git rev-parse --short HEAD'));
		$branch = trim(CommandUtility::exec('git rev-parse --abbrev-ref HEAD'));
		if (!empty($revision) && !empty($branch)) {
			$this->systemInformation[] = array(
				'title' => $this->getLanguageService()->sL('LLL:EXT:lang/locallang_core.xlf:toolbarItems.sysinfo.gitrevision', TRUE),
				'value' => sprintf('%s [%s]', $revision, $branch),
				'icon' => '<span class="fa fa-git"></span>'
			);
		}
	}

	/**
	 * Gets the system kernel and version
208
209
	 *
	 * @return void
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
	 */
	protected function getOperatingSystem() {
		$kernelName = php_uname('s');
		switch (strtolower($kernelName)) {
			case 'linux':
				$icon = 'linux';
				break;
			case 'darwin':
				$icon = 'apple';
				break;
			default:
				$icon = 'windows';
		}
		$this->systemInformation[] = array(
			'title' => $this->getLanguageService()->sL('LLL:EXT:lang/locallang_core.xlf:toolbarItems.sysinfo.operatingsystem', TRUE),
			'value' => $kernelName . ' ' . php_uname('r'),
			'icon' => '<span class="fa fa-' . htmlspecialchars($icon) . '"></span>'
		);
	}

230
231
232
233
234
235
236
237
238
239
240
	/**
	 * Gets the webserver software
	 */
	protected function getWebServer() {
		$this->systemInformation[] = array(
			'title' => $this->getLanguageService()->sL('LLL:EXT:lang/locallang_core.xlf:toolbarItems.sysinfo.webserver', TRUE),
			'value' => htmlspecialchars($_SERVER['SERVER_SOFTWARE']),
			'icon' => '<span class="fa fa-server"></span>'
		);
	}

241
242
	/**
	 * Emits the "getSystemInformation" signal
243
244
	 *
	 * @return void
245
246
247
248
249
250
251
252
253
254
	 */
	protected function emitGetSystemInformation() {
		list($systemInformation) = $this->getSignalSlotDispatcher()->dispatch(__CLASS__, 'getSystemInformation', array(array()));
		if (!empty($systemInformation)) {
			$this->systemInformation[] = $systemInformation;
		}
	}

	/**
	 * Emits the "loadMessages" signal
255
256
	 *
	 * @return void
257
258
259
260
261
262
263
264
265
266
267
268
	 */
	protected function emitLoadMessages() {
		list($message) = $this->getSignalSlotDispatcher()->dispatch(__CLASS__, 'loadMessages', array(array()));
		if (empty($message)) {
			return;
		}

		// increase counter
		if (isset($message['count'])) {
			$this->totalCount += (int)$message['count'];
		}

269
270
		/** @var InformationStatus $messageSeverity */
		$messageSeverity = InformationStatus::cast($message['status']);
271
		// define the severity for the badge
272
273
		if ($messageSeverity->isGreaterThan($this->highestSeverity)) {
			$this->highestSeverity = $messageSeverity;
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
		}

		$this->systemMessages[] = $message;
	}

	/**
	 * Checks whether the user has access to this toolbar item
	 *
	 * @return bool TRUE if user has access, FALSE if not
	 */
	public function checkAccess() {
		return $this->getBackendUserAuthentication()->isAdmin();
	}

	/**
	 * Render system information dropdown
	 *
	 * @return string Icon HTML
	 */
	public function getItem() {
		$title = $this->getLanguageService()->sL('LLL:EXT:lang/locallang_core.xlf:toolbarItems.sysinfo', TRUE);
295
		$icon = $this->iconFactory->getIcon('actions-system-list-open', Icon::SIZE_SMALL)->render();
296
		return '<span title="' . $title . '">' . $icon . '<span id="t3js-systeminformation-counter" class="badge"></span></span>';
297
298
299
300
301
302
303
304
305
306
307
308
	}

	/**
	 * Render drop down
	 *
	 * @return string Drop down HTML
	 */
	public function getDropDown() {
		if (!$this->checkAccess()) {
			return '';
		}

309
310
311
		$request = $this->standaloneView->getRequest();
		$request->setControllerExtensionName('backend');
		$this->standaloneView->assignMultiple(array(
312
313
			'installToolUrl' => BackendUtility::getModuleUrl('system_InstallInstall'),
			'messages' => $this->systemMessages,
314
315
			'count' => $this->totalCount,
			'severityBadgeClass' => $this->severityBadgeClass,
316
317
			'systemInformation' => $this->systemInformation
		));
318
		return $this->standaloneView->render();
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
	}

	/**
	 * No additional attributes needed.
	 *
	 * @return array
	 */
	public function getAdditionalAttributes() {
		return array();
	}

	/**
	 * This item has a drop down
	 *
	 * @return bool
	 */
	public function hasDropDown() {
		return TRUE;
	}

	/**
	 * Position relative to others
	 *
	 * @return int
	 */
	public function getIndex() {
		return 75;
	}

	/**
	 * Returns the current BE user.
	 *
	 * @return \TYPO3\CMS\Core\Authentication\BackendUserAuthentication
	 */
	protected function getBackendUserAuthentication() {
		return $GLOBALS['BE_USER'];
	}

	/**
	 * Returns DatabaseConnection
	 *
	 * @return \TYPO3\CMS\Core\Database\DatabaseConnection
	 */
	protected function getDatabaseConnection() {
		return $GLOBALS['TYPO3_DB'];
	}

	/**
	 * Returns current PageRenderer
	 *
369
	 * @return PageRenderer
370
371
	 */
	protected function getPageRenderer() {
372
		return GeneralUtility::makeInstance(PageRenderer::class);
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
	}

	/**
	 * Returns LanguageService
	 *
	 * @return \TYPO3\CMS\Lang\LanguageService
	 */
	protected function getLanguageService() {
		return $GLOBALS['LANG'];
	}

	/**
	 * Get the SignalSlot dispatcher
	 *
	 * @return \TYPO3\CMS\Extbase\SignalSlot\Dispatcher
	 */
	protected function getSignalSlotDispatcher() {
		if (!isset($this->signalSlotDispatcher)) {
			$this->signalSlotDispatcher = GeneralUtility::makeInstance(\TYPO3\CMS\Extbase\Object\ObjectManager::class)
				->get(\TYPO3\CMS\Extbase\SignalSlot\Dispatcher::class);
		}
		return $this->signalSlotDispatcher;
	}
396
}