SystemInformationToolbarItem.php 13.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
use TYPO3\CMS\Backend\Toolbar\Enumeration\InformationStatus;
20
use TYPO3\CMS\Backend\Toolbar\ToolbarItemInterface;
21
use TYPO3\CMS\Backend\Utility\BackendUtility;
22
use TYPO3\CMS\Core\Core\Bootstrap;
23
use TYPO3\CMS\Core\Core\SystemEnvironmentBuilder;
24
use TYPO3\CMS\Core\Database\ConnectionPool;
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
use TYPO3\CMS\Fluid\View\StandaloneView;
31
32
33
34

/**
 * Render system info toolbar item
 */
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
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
     */
61
    protected $systemInformation = [];
62
63
64
65

    /**
     * @var array
     */
66
    protected $systemMessages = [];
67
68
69
70
71
72

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

73
74
75
76
77
    /**
     * @var int
     */
    protected $maximumCountInBadge = 99;

78
79
80
81
82
83
84
85
86
87
88
89
90
91
    /**
     * 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()
    {
92
        $this->getTypo3Version();
93
94
95
96
        $this->getWebServer();
        $this->getPhpVersion();
        $this->getDatabase();
        $this->getApplicationContext();
97
        $this->getComposerMode();
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
        $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
     *
     * @param ServerRequestInterface $request
     * @param ResponseInterface $response
     * @return ResponseInterface
     */
    public function renderMenuAction(ServerRequestInterface $request, ResponseInterface $response)
    {
        $this->collectInformation();
        $response->getBody()->write($this->getDropDown());
118
        return $response->withHeader('Content-Type', 'text/html; charset=utf-8');
119
120
121
122
123
124
125
    }

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

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

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

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

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

180
181
182
183
184
    /**
     * Gets the current GIT revision and branch
     */
    protected function getGitRevision()
    {
185
        if (!StringUtility::endsWith(TYPO3_version, '-dev') || SystemEnvironmentBuilder::isFunctionDisabled('exec')) {
186
187
188
189
190
191
192
193
194
195
196
197
            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)) {
198
            $this->systemInformation[] = [
199
                'title' => 'LLL:EXT:lang/Resources/Private/Language/locallang_core.xlf:toolbarItems.sysinfo.gitrevision',
200
                'value' => sprintf('%s [%s]', $revision, $branch),
201
                'iconIdentifier' => 'sysinfo-git'
202
            ];
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
        }
    }

    /**
     * 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';
        }
222
        $this->systemInformation[] = [
223
            'title' => 'LLL:EXT:lang/Resources/Private/Language/locallang_core.xlf:toolbarItems.sysinfo.operatingsystem',
224
            'value' => $kernelName . ' ' . php_uname('r'),
225
            'iconIdentifier' => 'sysinfo-os-' . $icon
226
        ];
227
228
229
230
231
232
233
    }

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

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

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

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

269
270
271
272
273
274
275
276
    /**
     * 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
277
     * @param string $params Query string with additional parameters
278
     */
279
    public function addSystemMessage($text, $status = InformationStatus::STATUS_OK, $count = 0, $module = '', $params = '')
280
281
    {
        $this->totalCount += (int)$count;
282
283

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

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

    /**
     * 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
305
     * @param string $iconIdentifier The icon identifier
306
     * @param string $status The status of this system information
307
     */
308
    public function addSystemInformation($title, $value, $iconIdentifier, $status = InformationStatus::STATUS_NOTICE)
309
    {
310
        $this->systemInformation[] = [
311
312
            'title' => $title,
            'value' => $value,
313
            'iconIdentifier' => $iconIdentifier,
314
            'status' => $status
315
        ];
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
    }

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

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

349
350
        $view = $this->getFluidTemplateObject('SystemInformationDropDown.html');
        $view->assignMultiple([
351
            'environmentToolUrl' => BackendUtility::getModuleUrl('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
413
414
415
416
417
418
419
420
421
422
    }

    /**
     * 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
     *
     * @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;
    }
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441

    /**
     * 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;
    }
442
}