Cecil\Step\StaticFiles\Load

Complexity

Total Complexity

12

Size/Duplication

Total Lines	83
Duplicated Lines	0 %

Test Coverage

Coverage

93.62%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	getName()	0	3	1
A	init()	0	4	3
B	process()	0	60	8

<?php

/**
 * This file is part of Cecil.
 *
 * (c) Arnaud Ligny <arnaud@ligny.fr>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Cecil\Step\StaticFiles;

use Cecil\Step\AbstractStep;
use Cecil\Util;
use Symfony\Component\Finder\Finder;
use wapmorgan\Mp3Info\Mp3Info;

/**
 * Load static files step.
 *
 * This step is responsible for loading static files from the configured static path.
 * It scans the directory for files, excluding any specified in the configuration.
 *
 * The loaded files are processed to extract metadata such as file type, subtype,
 * modification date.
 * If the file is a JPEG image, it extracts EXIF metadata.
 * If the file is an audio file, it extracts audio metadata.
 * If the file is a video file, it extracts duration and resolution.
 */
class Load extends AbstractStep
{
    /**
     * {@inheritdoc}
     */
    public function getName(): string
    {
        return 'Loading static files';
    }

    /**
     * {@inheritdoc}
     */
    public function init(array $options): void
    {
        if (is_dir($this->config->getStaticPath()) && $this->config->isEnabled('static.load')) {
            $this->canProcess = true;
        }
    }

    /**
     * {@inheritdoc}
     */
    public function process(): void
    {
        $files = Finder::create()
            ->files()
            ->in($this->config->getStaticPath());
        if (\is_array($exclude = $this->config->get('static.exclude'))) {
            $files->notName($exclude);
        }
        $files->sortByName(true);
        $total = \count($files);

        if ($total < 1) {
            $message = 'No files';
            $this->builder->getLogger()->info($message);

            return;
        }

        if (\extension_loaded('exif')) {
            $this->builder->getLogger()->debug('EXIF extension is loaded');
        }

        $staticFiles = [];
        $count = 0;
        /** @var \Symfony\Component\Finder\SplFileInfo $file */
        foreach ($files as $file) {
            list($type, $subtype) = Util\File::getMediaType($file->getRealPath());
            $staticFiles[$count]['file'] = $file->getRelativePathname();
            $staticFiles[$count]['path'] = Util::joinPath($file->getRelativePathname());
            $staticFiles[$count]['date'] = (new \DateTime())->setTimestamp($file->getCTime());
            $staticFiles[$count]['updated'] = (new \DateTime())->setTimestamp($file->getMTime());
            $staticFiles[$count]['name'] = $file->getBasename();
            $staticFiles[$count]['basename'] = $file->getBasename('.' . $file->getExtension());
            $staticFiles[$count]['ext'] = $file->getExtension();
            $staticFiles[$count]['type'] = $type;
            $staticFiles[$count]['subtype'] = $subtype;
            if ($subtype == 'image/jpeg') {
                // read EXIF data for JPEG images
                $staticFiles[$count]['exif'] = Util\File::readExif($file->getRealPath());
            }
            if ($type == 'audio') {
                // read audio metadata
                $staticFiles[$count]['audio'] = new Mp3Info($file->getRealPath());
            }
            if ($type == 'video') {
                // read video metadata
                $videoInfos = (new \getID3())->analyze($file->getRealPath());
                $staticFiles[$count]['video'] = [
                    'duration' => $videoInfos['playtime_seconds'] ?? 0,
                    'width'    => $videoInfos['video']['resolution_x'] ?? 0,
                    'height'   => $videoInfos['video']['resolution_y'] ?? 0,
                ];
            }
            $count++;

            $message = \sprintf('File "%s" loaded', $file->getRelativePathname());
            $this->builder->getLogger()->info($message, ['progress' => [$count, $total]]);
        }

        $this->builder->setStatic($staticFiles);
    }
}