AbstractTask.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Core\Resource\Processing;

/*
 * 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 TYPO3\CMS\Core\Resource;
use TYPO3\CMS\Core\Utility\GeneralUtility;

abstract class AbstractTask implements TaskInterface
{
    protected $checksumData = [];

    protected $targetFile;

    protected $sourceFile;

    protected $configuration;

    protected $type;

    protected $name;

    protected $executed = false;

    protected $successful;

    public function __construct(Resource\ProcessedFile $targetFile, array $configuration)
    {
        $this->targetFile = $targetFile;
        $this->sourceFile = $targetFile->getOriginalFile();
        $this->configuration = $configuration;
    }

    protected function getChecksumData()
    {
        return [
            $this->getSourceFile()->getUid(),
            $this->getType() . '.' . $this->getName() . $this->getSourceFile()->getModificationTime(),
            serialize($this->configuration)
        ];
    }

    public function getConfigurationChecksum()
    {
        return GeneralUtility::shortMD5(implode('|', $this->getChecksumData()));
    }

    public function getTargetFilename()
    {
        return $this->targetFile->getNameWithoutExtension()
            . '_' . $this->getConfigurationChecksum()
            . '.' . $this->getTargetFileExtension();
    }

    public function getTargetFileExtension()
    {
        return $this->targetFile->getExtension();
    }

    public function getName()
    {
        return $this->name;
    }

    public function getType()
    {
        return $this->type;
    }

    public function getTargetFile()
    {
        return $this->targetFile;
    }

    public function setTargetFile(Resource\ProcessedFile $targetFile)
    {
        $this->targetFile = $targetFile;
    }

    public function getSourceFile()
    {
        return $this->sourceFile;
    }

    public function setSourceFile(Resource\File $sourceFile)
    {
        $this->sourceFile = $sourceFile;
    }

    public function getConfiguration()
    {
        return $this->configuration;
    }

    abstract protected function isValidConfiguration(array $configuration);

    public function isExecuted()
    {
        return $this->executed;
    }

    public function setExecuted($successful)
    {
        $this->executed = true;
        $this->successful = $successful;
    }

    public function isSuccessful()
    {
        if (!$this->executed) {
            throw new \LogicException('Task has not been executed; cannot determine success.', 1352549235);
        }

        return $this->successful;
    }
}