dukt / videos

src/helpers/VideosHelper.php

<?php
/**
 * @link      https://dukt.net/videos/
 * @copyright Copyright (c) Dukt
 * @license   https://github.com/dukt/videos/blob/v2/LICENSE.md
 */

namespace dukt\videos\helpers;

use Craft;
use craft\helpers\FileHelper;
use dukt\videos\errors\ApiResponseException;
use dukt\videos\models\Video;
use dukt\videos\Plugin;

/**
 * Videos helper
 */
class VideosHelper
{
    // Public Methods
    // =========================================================================

    /**
     * Formats seconds to hh:mm:ss.
     *
     * @param $seconds
     *
     * @return string
     */
    public static function getDuration($seconds): string
    {
        $hours = (int)((int)$seconds / 3600);
        $minutes = (($seconds / 60) % 60);
        $seconds %= 60;

        $hms = '';

        if ($hours > 0) {
            $hms .= str_pad($hours, 2, '0', STR_PAD_LEFT) . ':';
        }

        $hms .= str_pad($minutes, 2, '0', STR_PAD_LEFT) . ':';

        $hms .= str_pad($seconds, 2, '0', STR_PAD_LEFT);

        return $hms;
    }

    /**
     * Formats seconds to ISO 8601 duration
     *
     * @param $seconds
     *
     * @return string
     */
    public static function getDuration8601($seconds): string
    {
        $hours = (int)((int)$seconds / 3600);
        $minutes = (($seconds / 60) % 60);
        $seconds %= 60;

        $iso8601 = 'PT';

        if ($hours > 0) {
            $iso8601 .= sprintf('%dH', $hours);
        }

        if ($minutes > 0) {
            $iso8601 .= sprintf('%dM', $minutes);
        }

        return $iso8601 . sprintf('%dS', $seconds);
    }

    /**
     * Returns a video thumbnail’s published URL.
     *
     * @param $gatewayHandle
     * @param $videoId
     * @param $size
     *
     * @return null|string
     * @throws \GuzzleHttp\Exception\GuzzleException
     * @throws \craft\errors\ImageException
     * @throws \yii\base\Exception
     * @throws \yii\base\InvalidConfigException
     */
    public static function getVideoThumbnail($gatewayHandle, $videoId, $size): ?string
    {
        $baseDir = Craft::$app->getPath()->getRuntimePath() . DIRECTORY_SEPARATOR . 'videos' . DIRECTORY_SEPARATOR . 'thumbnails' . DIRECTORY_SEPARATOR . $gatewayHandle . DIRECTORY_SEPARATOR . $videoId;
        $originalDir = $baseDir . DIRECTORY_SEPARATOR . 'original';
        $dir = $baseDir . DIRECTORY_SEPARATOR . $size;

        $file = self::getThumbnailFile($dir);

        if (!$file) {
            // Retrieve original image
            $originalPath = null;

            if (is_dir($originalDir)) {
                $originalFiles = FileHelper::findFiles($originalDir);

                if ($originalFiles !== []) {
                    $originalPath = $originalFiles[0];
                }
            }

            if (!$originalPath) {
                try {
                    $video = Plugin::$plugin->getVideos()->getVideoById($gatewayHandle, $videoId);
                } catch (ApiResponseException $apiResponseException) {
                    Craft::info('Couldn’t get video thumbnail:' . "\r\n"
                        . 'Message: ' . "\r\n" . $apiResponseException->getMessage() . "\r\n"
                        . 'Trace: ' . "\r\n" . $apiResponseException->getTraceAsString(), __METHOD__);
                    return null;
                }

                $url = $video->thumbnailSource;

                $name = pathinfo($url, PATHINFO_BASENAME);
                $originalPath = $originalDir . DIRECTORY_SEPARATOR . $name;

Are you sure $name of type array|string can be used in concatenation?

                FileHelper::createDirectory($originalDir);
                $client = new \GuzzleHttp\Client();
                $response = $client->request('GET', $url, [
                    'sink' => $originalPath,
                ]);

                // Make sure the original file has an extension
                $mimeByExt = FileHelper::getMimeTypeByExtension($originalPath);

                if (!$mimeByExt) {
                    // Add the extension to the filename if it doesn’t have one
                    $mime = FileHelper::getMimeType($originalPath);
                    $ext = FileHelper::getExtensionByMimeType($mime);

                    if ($ext !== '' && $ext !== '0') {
                        $name .= '.' . $ext;
                        $targetPath = $originalDir . DIRECTORY_SEPARATOR . $name;

                        rename($originalPath, $targetPath);

                        $originalPath = $targetPath;
                    }
                }

                if ($response->getStatusCode() !== 200) {
                    return null;
                }
            } else {
                $name = pathinfo($originalPath, PATHINFO_BASENAME);
            }

            // Generate the thumb
            $path = $dir . DIRECTORY_SEPARATOR . $name;
            FileHelper::createDirectory($dir);
            Craft::$app->getImages()->loadImage($originalPath, false, $size)
                ->scaleToFit($size, $size)
                ->saveAs(parse_url($path, PHP_URL_PATH));
        } else {
            $name = pathinfo($file, PATHINFO_BASENAME);
        }

        return Craft::$app->getAssetManager()->getPublishedUrl($dir, true) . sprintf('/%s', $name);

The call to yii\web\AssetManager::getPublishedUrl() has too many arguments starting with true.

Are you sure Craft::app->getAssetManager()->getPublishedUrl($dir, true) of type false|mixed|string can be used in concatenation?

It seems like $name can also be of type array; however, parameter $values of sprintf() does only seem to accept double|integer|string, maybe add an additional type check?

    }

    /**
     * Transforms a video model into an array.
     *
     * @param Video $videoModel
     * @return array
     * @throws \GuzzleHttp\Exception\GuzzleException
     * @throws \craft\errors\ImageException
     * @throws \yii\base\Exception
     * @throws \yii\base\InvalidConfigException
     */
    public static function videoToArray(Video $videoModel): array
    {
        $video = $videoModel->toArray([
            'id',
            'gatewayHandle',
            'title',
            'url',
            'authorName',
            'authorUrl',
            'durationSeconds',
            'plays',
            'private'
        ]);

        if ($videoModel->id && $videoModel->gatewayHandle) {

The expression $videoModel->id of type integer|null is loosely compared to true; this is ambiguous if the integer can be 0. You might want to explicitly use !== null instead.

            $video['thumbnail'] = $videoModel->thumbnailSource;
            $video['embedUrl'] = $videoModel->getEmbedUrl();
            $video['duration'] = $videoModel->getDuration();
        }

        $video['errors'] = $videoModel->getErrors();
        $video['hasErrors'] = $videoModel->hasErrors();

        return $video;
    }

    // Private Methods
    // =========================================================================

    /**
     * Get thumbnail file.
     *
     * @param $dir
     *
     * @return null|string
     */
    private static function getThumbnailFile($dir)
    {
        if (!is_dir($dir)) {
            return null;
        }

        $files = FileHelper::findFiles($dir);

        if ($files === []) {
            return null;
        }

        return $files[0];
    }
}