AbstractService.php

Go to the documentation of this file.

<?php
namespace ‪TYPO3\CMS\Core\Service;
 
/*
 * 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!
 */
 
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerAwareTrait;
use ‪TYPO3\CMS\Core\Security\BlockSerializationTrait;
use ‪TYPO3\CMS\Core\TimeTracker\TimeTracker;
use ‪TYPO3\CMS\Core\Utility\CommandUtility;
use ‪TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
abstract class ‪AbstractService implements LoggerAwareInterface
{
    use ‪BlockSerializationTrait;
    use LoggerAwareTrait;
 
    // General error - something went wrong
    const ‪ERROR_GENERAL = -1;
 
    // During execution it showed that the service is not available and
    // should be ignored. The service itself should call $this->setNonAvailable()
    const ‪ERROR_SERVICE_NOT_AVAILABLE = -2;
 
    // Passed subtype is not possible with this service
    const ‪ERROR_WRONG_SUBTYPE = -3;
 
    // Passed subtype is not possible with this service
    const ‪ERROR_NO_INPUT = -4;
 
    // File not found which the service should process
    const ‪ERROR_FILE_NOT_FOUND = -20;
 
    // File not readable
    const ‪ERROR_FILE_NOT_READABLE = -21;
 
    // File not writable
    // @todo: check writeable vs. writable
    const ‪ERROR_FILE_NOT_WRITEABLE = -22;
 
    // Passed subtype is not possible with this service
    const ‪ERROR_PROGRAM_NOT_FOUND = -40;
 
    // Passed subtype is not possible with this service
    const ‪ERROR_PROGRAM_FAILED = -41;
    public ‪$info = [];
 
    public ‪$error = [];
 
    public ‪$out = '';
 
    public ‪$inputFile = '';
 
    public ‪$inputContent = '';
 
    public ‪$inputType = '';
 
    public ‪$outputFile = '';
 
    public ‪$tempFiles = [];
 
    protected ‪$shutdownRegistry = [];
 
    protected ‪$prefixId = '';
 
    /***************************************
     *
     *   Get service meta information
     *
     ***************************************/
    public function ‪getServiceInfo()
    {
        return ‪$this->info;
    }
 
    public function ‪getServiceKey()
    {
        return $this->info['serviceKey'];
    }
 
    public function ‪getServiceTitle()
    {
        return $this->info['title'];
    }
 
    public function ‪getServiceOption($optionName, $defaultValue = '', $includeDefaultConfig = true)
    {
        $config = null;
        $serviceType = $this->info['serviceType'] ?? '';
        $serviceKey = $this->info['serviceKey'] ?? '';
        $svOptions = ‪$GLOBALS['TYPO3_CONF_VARS']['SVCONF'][$serviceType] ?? [];
        if (isset($svOptions[$serviceKey][$optionName])) {
            $config = $svOptions[$serviceKey][$optionName];
        } elseif ($includeDefaultConfig && isset($svOptions['default'][$optionName])) {
            $config = $svOptions['default'][$optionName];
        }
        if (!isset($config)) {
            $config = $defaultValue;
        }
        return $config;
    }
 
    /***************************************
     *
     *   Error handling
     *
     ***************************************/
    public function ‪devLog($msg, $severity = 0, $dataVar = false)
    {
        trigger_error('AbstractService->devLog() will be removed with TYPO3 v10.0.', E_USER_DEPRECATED);
        $this->logger->debug($this->info['serviceKey'] . ': ' . $msg, (array)$dataVar);
    }
 
    public function ‪errorPush($errNum = self::ERROR_GENERAL, $errMsg = 'Unspecified error occurred')
    {
        $this->error[] = ['nr' => $errNum, 'msg' => $errMsg];
        $timeTracker = GeneralUtility::makeInstance(TimeTracker::class);
        $timeTracker->setTSlogMessage($errMsg, 2);
    }
 
    public function ‪errorPull()
    {
        array_pop($this->error);
    }
 
    public function ‪getLastError()
    {
        // Means all is ok - no error
        $lastError = true;
        if (!empty($this->error)) {
            ‪$error = end($this->error);
            $lastError = ‪$error['nr'];
        }
        return $lastError;
    }
 
    public function ‪getLastErrorMsg()
    {
        $lastErrorMessage = '';
        if (!empty($this->error)) {
            ‪$error = end($this->error);
            $lastErrorMessage = ‪$error['msg'];
        }
        return $lastErrorMessage;
    }
 
    public function ‪getErrorMsgArray()
    {
        $errArr = [];
        if (!empty($this->error)) {
            foreach ($this->error as ‪$error) {
                $errArr[] = ‪$error['msg'];
            }
        }
        return $errArr;
    }
 
    public function ‪getLastErrorArray()
    {
        return end($this->error);
    }
 
    public function ‪resetErrors()
    {
        $this->error = [];
    }
 
    /***************************************
     *
     *   General service functions
     *
     ***************************************/
    public function ‪checkExec($progList)
    {
        $ret = true;
        $progList = GeneralUtility::trimExplode(',', $progList, true);
        foreach ($progList as $prog) {
            if (!‪CommandUtility::checkCommand($prog)) {
                // Program not found
                $this->‪errorPush(self::ERROR_PROGRAM_NOT_FOUND, 'External program not found: ' . $prog);
                $ret = false;
            }
        }
        return $ret;
    }
 
    public function ‪deactivateService()
    {
        ‪ExtensionManagementUtility::deactivateService($this->info['serviceType'], $this->info['serviceKey']);
    }
 
    /***************************************
     *
     *   IO tools
     *
     ***************************************/
    public function ‪checkInputFile($absFile)
    {
        $checkResult = false;
        if (GeneralUtility::isAllowedAbsPath($absFile) && @is_file($absFile)) {
            if (@is_readable($absFile)) {
                $checkResult = $absFile;
            } else {
                $this->‪errorPush(self::ERROR_FILE_NOT_READABLE, 'File is not readable: ' . $absFile);
            }
        } else {
            $this->‪errorPush(self::ERROR_FILE_NOT_FOUND, 'File not found: ' . $absFile);
        }
        return $checkResult;
    }
 
    public function ‪readFile($absFile, $length = 0)
    {
        ‪$out = false;
        if ($this->‪checkInputFile($absFile)) {
            ‪$out = file_get_contents($absFile);
            if (‪$out === false) {
                $this->‪errorPush(self::ERROR_FILE_NOT_READABLE, 'Can not read from file: ' . $absFile);
            }
        }
        return ‪$out;
    }
 
    public function ‪writeFile($content, $absFile = '')
    {
        if (!$absFile) {
            $absFile = $this->‪tempFile($this->prefixId);
        }
        if ($absFile && GeneralUtility::isAllowedAbsPath($absFile)) {
            if ($fd = @fopen($absFile, 'wb')) {
                @fwrite($fd, $content);
                @fclose($fd);
            } else {
                $this->‪errorPush(self::ERROR_FILE_NOT_WRITEABLE, 'Can not write to file: ' . $absFile);
                $absFile = false;
            }
        }
        return $absFile;
    }
 
    public function ‪tempFile($filePrefix)
    {
        $absFile = GeneralUtility::tempnam($filePrefix);
        if ($absFile) {
            $ret = $absFile;
            $this->‪registerTempFile($absFile);
        } else {
            $ret = false;
            $this->‪errorPush(self::ERROR_FILE_NOT_WRITEABLE, 'Can not create temp file.');
        }
        return $ret;
    }
 
    public function ‪registerTempFile($absFile)
    {
        if (!isset($this->shutdownRegistry[__METHOD__])) {
            register_shutdown_function([$this, 'unlinkTempFiles']);
            $this->shutdownRegistry[__METHOD__] = true;
        }
        $this->tempFiles[] = $absFile;
    }
 
    public function ‪unlinkTempFiles()
    {
        foreach ($this->tempFiles as $absFile) {
            GeneralUtility::unlink_tempfile($absFile);
        }
        $this->tempFiles = [];
    }
 
    /***************************************
     *
     *   IO input
     *
     ***************************************/
    public function ‪setInput($content, $type = '')
    {
        $this->inputContent = $content;
        $this->inputFile = '';
        $this->inputType = $type;
    }
 
    public function ‪setInputFile($absFile, $type = '')
    {
        $this->inputContent = '';
        $this->inputFile = $absFile;
        $this->inputType = $type;
    }
 
    public function ‪getInput()
    {
        if ($this->inputContent == '') {
            $this->inputContent = $this->‪readFile($this->inputFile);
        }
        return ‪$this->inputContent;
    }
 
    public function ‪getInputFile($createFile = '')
    {
        if ($this->inputFile) {
            $this->inputFile = $this->‪checkInputFile($this->inputFile);
        } elseif ($this->inputContent) {
            $this->inputFile = $this->‪writeFile($this->inputContent, $createFile);
        }
        return ‪$this->inputFile;
    }
 
    /***************************************
     *
     *   IO output
     *
     ***************************************/
    public function ‪setOutputFile($absFile)
    {
        $this->outputFile = $absFile;
    }
 
    public function ‪getOutput()
    {
        if ($this->outputFile) {
            $this->out = $this->‪readFile($this->outputFile);
        }
        return ‪$this->out;
    }
 
    public function ‪getOutputFile($absFile = '')
    {
        if (!$this->outputFile) {
            $this->outputFile = $this->‪writeFile($this->out, $absFile);
        }
        return ‪$this->outputFile;
    }
 
    /***************************************
     *
     *   Service implementation
     *
     ***************************************/
    public function ‪init()
    {
        // look in makeInstanceService()
        $this->‪reset();
        // Check for external programs which are defined by $info['exec']
        if (trim($this->info['exec'])) {
            $this->‪checkExec($this->info['exec']);
        }
        return $this->‪getLastError() === true;
    }
 
    public function ‪reset()
    {
        $this->‪unlinkTempFiles();
        $this->‪resetErrors();
        $this->out = '';
        $this->inputFile = '';
        $this->inputContent = '';
        $this->inputType = '';
        $this->outputFile = '';
    }
 
    public function ‪__destruct()
    {
        $this->‪unlinkTempFiles();
    }
}