ServicesListReport.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Sv\Report;

class ServicesListReport implements \TYPO3\CMS\Reports\ReportInterface {

    protected $reportsModule;

    public function __construct(\TYPO3\CMS\Reports\Controller\ReportController $reportsModule) {
        $this->reportsModule = $reportsModule;
        $GLOBALS['LANG']->includeLLFile('EXT:sv/Resources/Private/Language/locallang.xlf');
    }

    public function getReport() {
        $content = '';
        $content .= $this->renderHelp();
        $content .= $this->renderServicesList();
        $content .= $this->renderExecutablesSearchPathList();
        return $content;
    }

    protected function renderHelp() {
        $help = '<p class="help">' . $GLOBALS['LANG']->getLL('report_explanation') . '</p>';
        $help .= '<p class="help">' . $GLOBALS['LANG']->getLL('externals_explanation') . '</p><br />';
        return $help;
    }

    protected function renderServicesList() {
        $servicesList = '';
        $services = $this->getInstalledServices();
        foreach ($services as $serviceType => $installedServices) {
            $servicesList .= $this->renderServiceTypeList($serviceType, $installedServices);
        }
        return $servicesList;
    }

    protected function renderServiceTypeList($serviceType, $services) {
        $header = '<h4>' . sprintf($GLOBALS['LANG']->getLL('service_type'), $serviceType) . '</h4>';
        $serviceList = '
        <table cellspacing="1" cellpadding="2" border="0" class="tx_sv_reportlist services">
            <tr class="t3-row-header">
                <td style="width: 35%">' . $GLOBALS['LANG']->getLL('service') . '</td>
                <td>' . $GLOBALS['LANG']->getLL('priority') . '</td>
                <td>' . $GLOBALS['LANG']->getLL('quality') . '</td>
                <td style="width: 35%">' . $GLOBALS['LANG']->getLL('subtypes') . '</td>
                <td>' . $GLOBALS['LANG']->getLL('os') . '</td>
                <td>' . $GLOBALS['LANG']->getLL('externals') . '</td>
                <td>' . $GLOBALS['LANG']->getLL('available') . '</td>
            </tr>';
        foreach ($services as $serviceKey => $serviceInformation) {
            $serviceList .= $this->renderServiceRow($serviceKey, $serviceInformation);
        }
        $serviceList .= '
        </table>
        ';
        return $header . $serviceList;
    }

    protected function renderServiceRow($serviceKey, $serviceInformation) {
        $serviceDescription = '
            <p class="service-header">
                <span class="service-title">' . $serviceInformation['title'] . '</span> (' . $serviceInformation['extKey'] . ': ' . $serviceKey . ')
            </p>';
        if (!empty($serviceInformation['description'])) {
            $serviceDescription .= '<p class="service-description">' . $serviceInformation['description'] . '</p>';
        }
        $serviceSubtypes = $serviceInformation['serviceSubTypes'] ? implode(', ', $serviceInformation['serviceSubTypes']) : '-';
        $serviceOperatingSystem = $serviceInformation['os'] ?: $GLOBALS['LANG']->getLL('any');
        $serviceRequiredExecutables = $serviceInformation['exec'] ?: '-';
        $serviceAvailabilityClass = 'typo3-message message-error';
        $serviceAvailable = $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_common.xlf:no');
        try {
            $serviceDetails = \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::findServiceByKey($serviceKey);
            if ($serviceDetails['available']) {
                $serviceAvailabilityClass = 'typo3-message message-ok';
                $serviceAvailable = $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_common.xlf:yes');
            }
        } catch (\TYPO3\CMS\Core\Exception $e) {

        }
        $serviceRow = '
        <tr class="service">
            <td class="first-cell ' . $serviceAvailabilityClass . '">' . $serviceDescription . '</td>
            <td class="cell ' . $serviceAvailabilityClass . '">' . $serviceInformation['priority'] . '</td>
            <td class="cell ' . $serviceAvailabilityClass . '">' . $serviceInformation['quality'] . '</td>
            <td class="cell ' . $serviceAvailabilityClass . '">' . $serviceSubtypes . '</td>
            <td class="cell ' . $serviceAvailabilityClass . '">' . $serviceOperatingSystem . '</td>
            <td class="cell ' . $serviceAvailabilityClass . '">' . $serviceRequiredExecutables . '</td>
            <td class="last-cell ' . $serviceAvailabilityClass . '">' . $serviceAvailable . '</td>
        </tr>';
        return $serviceRow;
    }

    protected function renderExecutablesSearchPathList() {
        $searchPaths = \TYPO3\CMS\Core\Utility\CommandUtility::getPaths(TRUE);
        $content = '<br /><h3 class="divider">' . $GLOBALS['LANG']->getLL('search_paths') . '</h3>';
        if (count($searchPaths) == 0) {
            $content .= '<p>' . $GLOBALS['LANG']->getLL('no_search_paths') . '</p>';
        } else {
            $content .= '
            <table cellspacing="1" cellpadding="2" border="0" class="tx_sv_reportlist paths">
                <thead>
                    <tr class="t3-row-header">
                        <td>' . $GLOBALS['LANG']->getLL('path') . '</td>
                        <td>' . $GLOBALS['LANG']->getLL('valid') . '</td>
                    </tr>
                </thead>
                <tbody>';
            foreach ($searchPaths as $path => $isValid) {
                $pathAccessibleClass = 'typo3-message message-error';
                $pathAccessible = $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_common.xlf:no');
                if ($isValid) {
                    $pathAccessibleClass = 'typo3-message message-ok';
                    $pathAccessible = $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_common.xlf:yes');
                }
                $content .= '
                    <tr>
                        <td class="first-cell ' . $pathAccessibleClass . '">' . \TYPO3\CMS\Core\Utility\GeneralUtility::fixWindowsFilePath($path) . '</td>
                        <td class="last-cell ' . $pathAccessibleClass . '">' . $pathAccessible . '</td>
                    </tr>';
            }
            $content .= '
                </tbody>
            </table>';
        }
        return $content;
    }

    protected function getInstalledServices() {
        $filteredServices = array();
        foreach ($GLOBALS['T3_SERVICES'] as $serviceType => $serviceList) {
            // If the (first) key of the service list is not the same as the service type,
            // it's a "true" service type. Keep it and sort it.
            if (key($serviceList) !== $serviceType) {
                uasort($serviceList, array($this, 'sortServices'));
                $filteredServices[$serviceType] = $serviceList;
            }
        }
        return $filteredServices;
    }

    protected function sortServices(array $a, array $b) {
        $result = 0;
        // If priorities are the same, test quality
        if ($a['priority'] == $b['priority']) {
            if ($a['quality'] != $b['quality']) {
                // Service with highest quality should come first,
                // thus it must be marked as smaller
                $result = $a['quality'] > $b['quality'] ? -1 : 1;
            }
        } else {
            // Service with highest priority should come first,
            // thus it must be marked as smaller
            $result = $a['priority'] > $b['priority'] ? -1 : 1;
        }
        return $result;
    }

}