SilverStripe\Dev\Tasks\MigrateFileTask

Complexity

Total Complexity

24

Size/Duplication

Total Lines	166
Duplicated Lines	0 %

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getDescription()	0	3	1
A	setLogger()	0	5	1
A	addLogHandlers()	0	8	3
A	validateArgs()	0	5	3
A	getStore()	0	3	1
F	run()	0	85	15

<?php

namespace SilverStripe\Dev\Tasks;

use Monolog\Handler\StreamHandler;
use Monolog\Logger;
use Psr\Log\LoggerInterface;
use SilverStripe\AssetAdmin\Helper\ImageThumbnailHelper;

The type SilverStripe\AssetAdmin\Helper\ImageThumbnailHelper was not found. Maybe you did not declare it correctly or list all dependencies?

use SilverStripe\Assets\Dev\Tasks\LegacyThumbnailMigrationHelper;

The type SilverStripe\Assets\Dev\Tasks\LegacyThumbnailMigrationHelper was not found. Maybe you did not declare it correctly or list all dependencies?

use SilverStripe\Assets\FileMigrationHelper;
use SilverStripe\Assets\Storage\AssetStore;
use SilverStripe\Control\Director;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\Logging\PreformattedEchoHandler;
use SilverStripe\Dev\BuildTask;
use SilverStripe\Assets\Dev\Tasks\SecureAssetsMigrationHelper;

The type SilverStripe\Assets\Dev\Tasks\SecureAssetsMigrationHelper was not found. Maybe you did not declare it correctly or list all dependencies?

/**
 * Migrates all 3.x file dataobjects to use the new DBFile field.
 */
class MigrateFileTask extends BuildTask
{
    private static $segment = 'MigrateFileTask';

The private property $segment is not used, and could be removed.

    protected $title = 'Migrate File dataobjects from 3.x and successive iterations in 4.x';

    protected $defaultSubtasks = [
        'move-files',
        'move-thumbnails',
        'generate-cms-thumbnails',
        'fix-folder-permissions',
        'fix-secureassets',
    ];

    private static $dependencies = [

The private property $dependencies is not used, and could be removed.

        'logger' => '%$' . LoggerInterface::class,
    ];

    /** @var Logger */
    private $logger;

    public function run($request)
    {
        $this->addLogHandlers();

        $args = $request->getVars();
        $this->validateArgs($args);

        $subtasks = !empty($args['only']) ? explode(',', $args['only']) : $this->defaultSubtasks;

        if (in_array('move-files', $subtasks)) {
            if (!class_exists(FileMigrationHelper::class)) {
                $this->logger->error("No file migration helper detected");
                return;
            }

            $this->logger->info('### Migrating filesystem and database records (move-files)');

            $this->logger->info('If the task fails or times out, run it again and it will start where it left off.');

            $migrated = FileMigrationHelper::singleton()->run();
            if ($migrated) {
                $this->logger->info("{$migrated} File DataObjects upgraded");
            } else {
                $this->logger->info("No File DataObjects need upgrading");
            }
        }

        if (in_array('move-thumbnails', $subtasks)) {
            if (!class_exists(LegacyThumbnailMigrationHelper::class)) {
                $this->logger->error("LegacyThumbnailMigrationHelper not found");
                return;
            }

            $this->logger->info('### Migrating existing thumbnails (move-thumbnails)');

            $moved = LegacyThumbnailMigrationHelper::singleton()
                ->setLogger($this->logger)
                ->run($this->getStore());

            if ($moved) {
                $this->logger->info(sprintf("%d thumbnails moved", count($moved)));
            } else {
                $this->logger->info("No thumbnails moved");
            }
        }

        if (in_array('generate-cms-thumbnails', $subtasks)) {
            if (!class_exists(ImageThumbnailHelper::class)) {
                $this->logger->error("ImageThumbnailHelper not found");
                return;
            }

            $this->logger->info('### Generating new CMS UI thumbnails (generate-cms-thumbnails)');

            ImageThumbnailHelper::singleton()->run();
        }

        if (in_array('fix-folder-permissions', $subtasks)) {
            if (!class_exists(FixFolderPermissionsHelper::class)) {

The type SilverStripe\Dev\Tasks\FixFolderPermissionsHelper was not found. Maybe you did not declare it correctly or list all dependencies?

                $this->logger->error("FixFolderPermissionsHelper not found");
                return;
            }

            $this->logger->info('### Fixing folder permissions (fix-folder-permissions)');

            $updated = FixFolderPermissionsHelper::singleton()->run();

            if ($updated > 0) {
                $this->logger->info("Repaired {$updated} folders with broken CanViewType settings");
            } else {
                $this->logger->info("No folders required fixes");
            }
        }

        if (in_array('fix-secureassets', $subtasks)) {
            if (!class_exists(SecureAssetsMigrationHelper::class)) {
                $this->logger->error("SecureAssetsMigrationHelper not found");
                return;
            }

            $this->logger->info('### Fixing secure-assets (fix-secureassets)');

            $moved = SecureAssetsMigrationHelper::singleton()

The assignment to $moved is dead and can be removed.

                ->setLogger($this->logger)
                ->run($this->getStore());
        }
    }

    public function getDescription()
    {
        return <<<TXT
Imports all files referenced by File dataobjects into the new Asset Persistence Layer introduced in 4.0.
Moves existing thumbnails, and generates new thumbnail sizes for the CMS UI.
Fixes file permissions.
If the task fails or times out, run it again and it will start where it left off.
You need to flush your cache after running this task via CLI.
See https://docs.silverstripe.org/en/4/developer_guides/files/file_migration/.
TXT;
    }

    /**
     * @param LoggerInterface $logger
     */
    public function setLogger(LoggerInterface $logger)
    {
        $this->logger = $logger;

$logger is of type Psr\Log\LoggerInterface, but the property $logger was declared to be of type Monolog\Logger. Are you sure that you always receive this specific sub-class here, or does it make sense to add an instanceof check?

        return $this;
    }

    /**
     * @return AssetStore
     */
    protected function getStore()
    {
        return singleton(AssetStore::class);
    }

    /**
     * @param array $args
     * @throws \InvalidArgumentException
     */
    protected function validateArgs($args)
    {
        if (!empty($args['only'])) {
            if (array_diff(explode(',', $args['only']), $this->defaultSubtasks)) {
                throw new \InvalidArgumentException('Invalid subtasks detected: ' . $args['only']);
            }
        }
    }

    /**
     * TODO Refactor this whole mess into Symfony Console on a TaskRunner level,
     * with a thin wrapper to show coloured console output via a browser:
     * https://github.com/silverstripe/silverstripe-framework/issues/5542
     * @throws \Exception
     */
    protected function addLogHandlers()
    {
        if ($logger = Injector::inst()->get(LoggerInterface::class)) {
            if (Director::is_cli()) {
                $logger->pushHandler(new StreamHandler('php://stdout'));
                $logger->pushHandler(new StreamHandler('php://stderr', Logger::WARNING));
            } else {
                $logger->pushHandler(new PreformattedEchoHandler());
            }
        }
    }
}