SystemInformationToolbarItem.php 13 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
use Psr\Http\Message\ResponseInterface;
18
use TYPO3\CMS\Backend\Routing\UriBuilder;
19
use TYPO3\CMS\Backend\Toolbar\Enumeration\InformationStatus;
20
use TYPO3\CMS\Backend\Toolbar\ToolbarItemInterface;
21
use TYPO3\CMS\Core\Core\Bootstrap;
22
use TYPO3\CMS\Core\Core\SystemEnvironmentBuilder;
23
use TYPO3\CMS\Core\Database\ConnectionPool;
24
use TYPO3\CMS\Core\Http\HtmlResponse;
25
use TYPO3\CMS\Core\Page\PageRenderer;
26
27
28
use TYPO3\CMS\Core\Utility\CommandUtility;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Core\Utility\StringUtility;
29
use TYPO3\CMS\Core\Utility\VersionNumberUtility;
30
31
use TYPO3\CMS\Extbase\Object\ObjectManager;
use TYPO3\CMS\Extbase\SignalSlot\Dispatcher;
32
use TYPO3\CMS\Fluid\View\StandaloneView;
33
34
35
36

/**
 * Render system info toolbar item
 */
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
class SystemInformationToolbarItem implements ToolbarItemInterface
{
    /**
     * Number displayed as badge on the dropdown trigger
     *
     * @var int
     */
    protected $totalCount = 0;

    /**
     * Holds the highest severity
     *
     * @var InformationStatus
     */
    protected $highestSeverity;

    /**
     * The CSS class for the badge
     *
     * @var string
     */
    protected $severityBadgeClass = '';

    /**
     * @var array
     */
63
    protected $systemInformation = [];
64
65
66
67

    /**
     * @var array
     */
68
    protected $systemMessages = [];
69
70

    /**
71
     * @var Dispatcher
72
73
74
     */
    protected $signalSlotDispatcher = null;

75
76
77
78
79
    /**
     * @var int
     */
    protected $maximumCountInBadge = 99;

80
81
82
83
84
85
86
87
88
89
90
91
92
93
    /**
     * Constructor
     */
    public function __construct()
    {
        $this->getPageRenderer()->loadRequireJsModule('TYPO3/CMS/Backend/Toolbar/SystemInformationMenu');
        $this->highestSeverity = InformationStatus::cast(InformationStatus::STATUS_INFO);
    }

    /**
     * Collect the information for the menu
     */
    protected function collectInformation()
    {
94
        $this->getTypo3Version();
95
96
97
98
        $this->getWebServer();
        $this->getPhpVersion();
        $this->getDatabase();
        $this->getApplicationContext();
99
        $this->getComposerMode();
100
101
102
103
104
105
106
107
108
109
110
111
112
113
        $this->getGitRevision();
        $this->getOperatingSystem();

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

        $this->severityBadgeClass = !$this->highestSeverity->equals(InformationStatus::STATUS_NOTICE) ? 'badge-' . (string)$this->highestSeverity : '';
    }

    /**
     * Renders the menu for AJAX calls
     *
     * @return ResponseInterface
     */
114
    public function renderMenuAction(): ResponseInterface
115
116
    {
        $this->collectInformation();
117
        return new HtmlResponse($this->getDropDown());
118
119
120
121
122
123
124
    }

    /**
     * Gets the PHP version
     */
    protected function getPhpVersion()
    {
125
        $this->systemInformation[] = [
126
            'title' => 'LLL:EXT:lang/Resources/Private/Language/locallang_core.xlf:toolbarItems.sysinfo.phpversion',
127
            'value' => PHP_VERSION,
128
            'iconIdentifier' => 'sysinfo-php-version'
129
        ];
130
131
132
133
134
135
136
    }

    /**
     * Get the database info
     */
    protected function getDatabase()
    {
137
138
        foreach (GeneralUtility::makeInstance(ConnectionPool::class)->getConnectionNames() as $connectionName) {
            $this->systemInformation[] = [
139
140
                'title' => 'LLL:EXT:lang/Resources/Private/Language/locallang_core.xlf:toolbarItems.sysinfo.database',
                'titleAddition' => $connectionName,
141
142
143
                'value' => GeneralUtility::makeInstance(ConnectionPool::class)
                    ->getConnectionByName($connectionName)
                    ->getServerVersion(),
144
                'iconIdentifier' => 'sysinfo-database'
145
146
            ];
        }
147
148
149
150
151
152
153
154
    }

    /**
     * Gets the application context
     */
    protected function getApplicationContext()
    {
        $applicationContext = GeneralUtility::getApplicationContext();
155
        $this->systemInformation[] = [
156
157
            'title'  => 'LLL:EXT:lang/Resources/Private/Language/locallang_core.xlf:toolbarItems.sysinfo.applicationcontext',
            'value'  => (string)$applicationContext,
158
            'status' => $applicationContext->isProduction() ? InformationStatus::STATUS_OK : InformationStatus::STATUS_WARNING,
159
            'iconIdentifier' => 'sysinfo-application-context'
160
        ];
161
162
    }

163
    /**
164
     * Adds the information if the Composer mode is enabled or disabled to the displayed system information
165
     */
166
    protected function getComposerMode()
167
    {
168
169
170
171
        if (!Bootstrap::usesComposerClassLoading()) {
            return;
        }

172
        $this->systemInformation[] = [
173
            'title' => 'LLL:EXT:lang/Resources/Private/Language/locallang_core.xlf:toolbarItems.sysinfo.composerMode',
174
            'value' => $GLOBALS['LANG']->sL('LLL:EXT:lang/Resources/Private/Language/locallang_core.xlf:labels.enabled'),
175
            'iconIdentifier' => 'sysinfo-composer-mode'
176
        ];
177
178
    }

179
180
181
182
183
    /**
     * Gets the current GIT revision and branch
     */
    protected function getGitRevision()
    {
184
        if (!StringUtility::endsWith(TYPO3_version, '-dev') || SystemEnvironmentBuilder::isFunctionDisabled('exec')) {
185
186
187
188
189
190
191
192
193
194
195
196
            return;
        }
        // check if git exists
        CommandUtility::exec('git --version', $_, $returnCode);
        if ((int)$returnCode !== 0) {
            // git is not available
            return;
        }

        $revision = trim(CommandUtility::exec('git rev-parse --short HEAD'));
        $branch = trim(CommandUtility::exec('git rev-parse --abbrev-ref HEAD'));
        if (!empty($revision) && !empty($branch)) {
197
            $this->systemInformation[] = [
198
                'title' => 'LLL:EXT:lang/Resources/Private/Language/locallang_core.xlf:toolbarItems.sysinfo.gitrevision',
199
                'value' => sprintf('%s [%s]', $revision, $branch),
200
                'iconIdentifier' => 'sysinfo-git'
201
            ];
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
        }
    }

    /**
     * Gets the system kernel and version
     */
    protected function getOperatingSystem()
    {
        $kernelName = php_uname('s');
        switch (strtolower($kernelName)) {
            case 'linux':
                $icon = 'linux';
                break;
            case 'darwin':
                $icon = 'apple';
                break;
            default:
                $icon = 'windows';
        }
221
        $this->systemInformation[] = [
222
            'title' => 'LLL:EXT:lang/Resources/Private/Language/locallang_core.xlf:toolbarItems.sysinfo.operatingsystem',
223
            'value' => $kernelName . ' ' . php_uname('r'),
224
            'iconIdentifier' => 'sysinfo-os-' . $icon
225
        ];
226
227
228
229
230
231
232
    }

    /**
     * Gets the webserver software
     */
    protected function getWebServer()
    {
233
        $this->systemInformation[] = [
234
235
236
            'title' => 'LLL:EXT:lang/Resources/Private/Language/locallang_core.xlf:toolbarItems.sysinfo.webserver',
            'value' => $_SERVER['SERVER_SOFTWARE'],
            'iconIdentifier' => 'sysinfo-webserver'
237
        ];
238
239
    }

240
241
242
243
244
245
    /**
     * Gets the TYPO3 version
     */
    protected function getTypo3Version()
    {
        $this->systemInformation[] = [
246
247
248
            'title' => 'LLL:EXT:lang/Resources/Private/Language/locallang_core.xlf:toolbarItems.sysinfo.typo3-version',
            'value' => VersionNumberUtility::getCurrentTypo3Version(),
            'iconIdentifier' => 'sysinfo-typo3-version'
249
250
251
        ];
    }

252
253
254
255
256
    /**
     * Emits the "getSystemInformation" signal
     */
    protected function emitGetSystemInformation()
    {
257
        $this->getSignalSlotDispatcher()->dispatch(__CLASS__, 'getSystemInformation', [$this]);
258
259
260
261
262
263
264
    }

    /**
     * Emits the "loadMessages" signal
     */
    protected function emitLoadMessages()
    {
265
        $this->getSignalSlotDispatcher()->dispatch(__CLASS__, 'loadMessages', [$this]);
266
    }
267

268
269
270
271
272
273
274
275
    /**
     * Add a system message.
     * This is a callback method for signal receivers.
     *
     * @param string $text The text to be displayed
     * @param string $status The status of this system message
     * @param int $count Will be added to the total count
     * @param string $module The associated module
276
     * @param string $params Query string with additional parameters
277
     */
278
    public function addSystemMessage($text, $status = InformationStatus::STATUS_OK, $count = 0, $module = '', $params = '')
279
280
    {
        $this->totalCount += (int)$count;
281
282

        /** @var InformationStatus $messageSeverity */
283
        $messageSeverity = InformationStatus::cast($status);
284
285
286
287
288
        // define the severity for the badge
        if ($messageSeverity->isGreaterThan($this->highestSeverity)) {
            $this->highestSeverity = $messageSeverity;
        }

289
        $this->systemMessages[] = [
290
            'module' => $module,
291
            'params' => $params,
292
293
294
            'count' => (int)$count,
            'status' => $messageSeverity,
            'text' => $text
295
        ];
296
297
298
299
300
301
302
303
    }

    /**
     * Add a system information.
     * This is a callback method for signal receivers.
     *
     * @param string $title The title of this system information
     * @param string $value The associated value
304
     * @param string $iconIdentifier The icon identifier
305
     * @param string $status The status of this system information
306
     */
307
    public function addSystemInformation($title, $value, $iconIdentifier, $status = InformationStatus::STATUS_NOTICE)
308
    {
309
        $this->systemInformation[] = [
310
311
            'title' => $title,
            'value' => $value,
312
            'iconIdentifier' => $iconIdentifier,
313
            'status' => $status
314
        ];
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
    }

    /**
     * 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()
    {
334
        return $this->getFluidTemplateObject('SystemInformationToolbarItem.html')->render();
335
336
337
338
339
340
341
342
343
344
345
346
347
    }

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

348
        $uriBuilder = GeneralUtility::makeInstance(UriBuilder::class);
349
350
        $view = $this->getFluidTemplateObject('SystemInformationDropDown.html');
        $view->assignMultiple([
351
            'environmentToolUrl' => (string)$uriBuilder->buildUriFromRoute('tools_toolsenvironment'),
352
            'messages' => $this->systemMessages,
353
            'count' => $this->totalCount > $this->maximumCountInBadge ? $this->maximumCountInBadge . '+' : $this->totalCount,
354
355
            'severityBadgeClass' => $this->severityBadgeClass,
            'systemInformation' => $this->systemInformation
356
        ]);
357
        return $view->render();
358
359
360
361
362
363
364
365
366
    }

    /**
     * No additional attributes needed.
     *
     * @return array
     */
    public function getAdditionalAttributes()
    {
367
        return [];
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
    }

    /**
     * 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 current PageRenderer
     *
     * @return PageRenderer
     */
    protected function getPageRenderer()
    {
        return GeneralUtility::makeInstance(PageRenderer::class);
    }

    /**
     * Get the SignalSlot dispatcher
     *
413
     * @return Dispatcher
414
415
416
417
     */
    protected function getSignalSlotDispatcher()
    {
        if (!isset($this->signalSlotDispatcher)) {
418
            $this->signalSlotDispatcher = GeneralUtility::makeInstance(ObjectManager::class)->get(Dispatcher::class);
419
420
421
        }
        return $this->signalSlotDispatcher;
    }
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440

    /**
     * Returns a new standalone view, shorthand function
     *
     * @param string $filename Which templateFile should be used.
     * @return StandaloneView
     */
    protected function getFluidTemplateObject(string $filename): StandaloneView
    {
        $view = GeneralUtility::makeInstance(StandaloneView::class);
        $view->setLayoutRootPaths(['EXT:backend/Resources/Private/Layouts']);
        $view->setPartialRootPaths(['EXT:backend/Resources/Private/Partials/ToolbarItems']);
        $view->setTemplateRootPaths(['EXT:backend/Resources/Private/Templates/ToolbarItems']);

        $view->setTemplate($filename);

        $view->getRequest()->setControllerExtensionName('Backend');
        return $view;
    }
441
}