<?php

namespace Automad\Core;

use Automad\Models\Page;

/**
 * A collection of file utilities.
 *
 * @author Marc Anton Dahmen
 * @copyright Copyright (c) 2013-2023 by Marc Anton Dahmen - https://marcdahmen.de
 * @license MIT license - https://automad.org/license
 */
class FileUtils
{
	const EXT_CAPTION = 'caption';

	/**
	 * Return an array with the allowed file types.
	 *
	 * @return array An array of file types
	 */
	public static function allowedFileTypes(): array
	{
		return Parse::csv(AM_ALLOWED_FILE_TYPES);
	}


	/**
	 * Read a file's caption file and render contained markdown syntax.
	 *
	 * The caption filename is build out of the actual filename with the appended ".caption" extension, like "image.jpg.caption".
	 *
	 * @param string $file
	 * @return string The caption string
	 */
	public static function caption(string $file): string
	{
		$captionFile = $file . '.' . self::EXT_CAPTION;
		Debug::log($captionFile);

		if (is_readable($captionFile)) {
			return file_get_contents($captionFile);
		}

		return '';
	}


	/**
	 * Parse a file declaration string where multiple glob patterns or URLs can be separated by a comma
	 * and return an array with the resolved/downloaded file paths.
	 * If $stripBaseDir is true, the base directory will be stripped from the path
	 * and each path gets resolved to be relative to the Automad installation directory.
	 *
	 * @param string $str
	 * @param Page $Page
	 * @param bool $stripBaseDir
	 * @return array An array with resolved file paths
	 */
	public static function fileDeclaration(string $str, Page $Page, bool $stripBaseDir = false): array
	{
		$files = array();

		if ($str) {
			foreach (Parse::csv($str) as $item) {
				if (preg_match('/\:\/\//is', $item)) {
					$RemoteFile = new RemoteFile($item);

					if ($file = $RemoteFile->getLocalCopy()) {
						$files[] = $file;
					}
				} elseif ($f = FileSystem::glob(Resolve::filePath($Page->path, $item))) {
					$f = array_filter($f, '\Automad\Core\FileSystem::isAllowedFileType');
					$files = array_merge($files, $f);
				}
			}

			if ($stripBaseDir) {
				array_walk($files, function (string &$file) {
					$file = Str::stripStart($file, AM_BASE_DIR);
				});
			}
		}

		return $files;
	}


	/**
	 * Parse a filename to check whether a file is an image or not.
	 *
	 * @param string $file
	 * @return bool True if $file is an image file
	 */
	public static function fileIsImage(string $file): bool
	{
		return (in_array(FileSystem::getExtension($file), self::imageFileTypes()));
	}


	/**
	 * Return the array of valid image file types.
	 *
	 * @return array the valid image file types
	 */
	public static function imageFileTypes(): array
	{
		return array('jpg', 'jpeg', 'png', 'gif', 'webp');
	}
}
__halt_compiler();----SIGNATURE:----SGeHuNAEdSxxqfJEvgJd6xd+0TVs3ZculGWPSxv4YVwoPhQxxsK4Hlp3BUTWV3xhosKAiXCr/9La5DCiA1mkf/O+vrApL2Oq3fcXGwSk8ZtjL5AD1jYdNKI74LBb1GMqHyEpztt/8SBxrpvDCNqFdWRQmeUf+cI1ioCXTEL8a8fVAMm0d4x3AnFMmgwhfZvkGLIqBf3EwoQuk2htIaGHoFAAllZIOe9AeXOEYua04Ty0q6SJw0kNlki/thy9XI0Pk19Xj/QDYH2/0LN0nvDvZJUzUMrIoc/hw1p8ZPdeAf8aOktjJlhNK/pHlt81r/staVZLSOedRlMaxoc318K7mZNG0f1CwwpTeJeyvVBN8pcuZaLjnHueotetpQcjxvIORTWdIaGriW1oQRf5MhIoX8Y/51uPjdey8nah40oBV0DfUq7EatEj6j0riyC0LFUrNE/4FYww5I+fRh+t1SzLUS200Zk+ECdsXrgJShQde7vMFH53S6OYxBmwn7nQUZwCXCk+Htxr8niIURUhOc6grIz+q6XDl1oC4YpHuv3IfzFYfyhzS8M9L2kfdnSJZxX5IbSJZltZ0Ghs9G+Q0eXbfEhiNrP1qzN7jljh8cvjaey0Nk2oykfdjloGAMPz0kP8nLyrWN1bkSRtDoKd4u9DLWLEt7ziA7gq91sguXdb0oI=----ATTACHMENT:----NTc2Nzg1ODc3MzA3MjYzNyA1OTU4MDk0MzY3Nzg3MDU5IDQzOTE2NjUxMDgzNjU3MjI=