%PDF-
%PDF-
Mini Shell
Mini Shell
<?php
namespace WebpConverter\Conversion;
use WebpConverter\Conversion\Format\FormatFactory;
use WebpConverter\Conversion\Method\RemoteMethod;
use WebpConverter\PluginData;
use WebpConverter\Repository\TokenRepository;
use WebpConverter\Service\StatsManager;
use WebpConverter\Settings\Option\ConversionMethodOption;
use WebpConverter\Settings\Option\ExtraFeaturesOption;
use WebpConverter\Settings\Option\OutputFormatsOption;
use WebpConverter\Settings\Option\ServiceModeOption;
use WebpConverter\Settings\Option\SupportedDirectoriesOption;
/**
* Finds paths of images to be converted.
*/
class PathsFinder {
const PATHS_PER_REQUEST_LOCAL = 10;
const PATHS_PER_REQUEST_REMOTE_SMALL = 3;
const PATHS_PER_REQUEST_REMOTE_MEDIUM = 5;
const PATHS_PER_REQUEST_REMOTE_LARGE = 10;
/**
* @var PluginData
*/
private $plugin_data;
/**
* @var TokenRepository
*/
private $token_repository;
/**
* @var StatsManager
*/
private $stats_manager;
/**
* @var OutputPathGenerator
*/
private $output_path;
/**
* @var DirectoryFilesFinder
*/
private $files_finder;
public function __construct(
PluginData $plugin_data,
TokenRepository $token_repository,
FormatFactory $format_factory,
StatsManager $stats_manager = null,
OutputPathGenerator $output_path = null
) {
$this->plugin_data = $plugin_data;
$this->token_repository = $token_repository;
$this->stats_manager = $stats_manager ?: new StatsManager();
$this->output_path = $output_path ?: new OutputPathGenerator( $format_factory );
$this->files_finder = new DirectoryFilesFinder( $plugin_data );
}
/**
* Returns list of chunked server paths of source images to be converted.
*
* @param bool $skip_converted Skip converted images?
* @param string[]|null $allowed_output_formats List of extensions or use selected in plugin settings.
*
* @return mixed[] {
* @type string $path Directory path.
* @type string[] $files Files paths.
* }
*/
public function get_paths_by_chunks( bool $skip_converted = false, array $allowed_output_formats = null ): array {
$allowed_output_formats = $allowed_output_formats
?: $this->plugin_data->get_plugin_settings()[ OutputFormatsOption::OPTION_NAME ];
$paths_chunks = $this->find_source_paths();
$paths_chunks = $this->skip_converted_paths_chunks( $paths_chunks, $skip_converted, $allowed_output_formats );
$count = 0;
foreach ( $paths_chunks as $dir_data ) {
$count += count( $dir_data['files'] );
}
$chunk_size = $this->get_paths_chunk_size( $count );
foreach ( $paths_chunks as $dir_name => $dir_data ) {
$paths_chunks[ $dir_name ]['files'] = array_chunk( $dir_data['files'], $chunk_size );
}
$this->stats_manager->set_regeneration_images( $count );
return $paths_chunks;
}
/**
* @param bool $skip_converted Skip converted images?
* @param string[]|null $allowed_output_formats List of extensions or use selected in plugin settings.
*
* @return string[] Server paths of source images to be converted.
*/
public function get_paths( bool $skip_converted = false, array $allowed_output_formats = null ): array {
$allowed_output_formats = $allowed_output_formats
?: $this->plugin_data->get_plugin_settings()[ OutputFormatsOption::OPTION_NAME ];
$paths_chunks = $this->find_source_paths();
$paths_chunks = $this->skip_converted_paths_chunks( $paths_chunks, $skip_converted, $allowed_output_formats );
$paths = [];
foreach ( $paths_chunks as $dir_data ) {
foreach ( $dir_data['files'] as $source_path ) {
$paths[] = $dir_data['path'] . '/' . $source_path;
}
}
return $paths;
}
/**
* @param string[] $source_paths Server paths of source images.
* @param string[]|null $allowed_output_formats List of extensions or use selected in plugin settings.
* @param bool $force_convert_modified Force re-conversion of images modified after previous conversion.
*
* @return string[] Server paths of source images.
*/
public function skip_converted_paths(
array $source_paths,
array $allowed_output_formats = null,
bool $force_convert_modified = false
): array {
$plugin_settings = $this->plugin_data->get_plugin_settings();
$allowed_output_formats = $allowed_output_formats ?: $plugin_settings[ OutputFormatsOption::OPTION_NAME ];
$force_convert_deleted = ( ! in_array( ExtraFeaturesOption::OPTION_VALUE_ONLY_SMALLER, $plugin_settings[ ExtraFeaturesOption::OPTION_NAME ] ) );
foreach ( $source_paths as $path_index => $source_path ) {
$is_converted = true;
foreach ( $allowed_output_formats as $output_format ) {
$output_path = $this->output_path->get_path( $source_path, false, $output_format );
if ( $output_path && ! $this->is_converted_file( $source_path, $output_path, $force_convert_deleted, false, $force_convert_modified ) ) {
$is_converted = false;
break;
}
}
if ( $is_converted ) {
unset( $source_paths[ $path_index ] );
}
}
return $source_paths;
}
/**
* @param mixed[] $source_dirs Server paths of source images.
* @param bool $skip_converted Skip converted images?
* @param string[]|null $allowed_output_formats List of extensions or use selected in plugin settings.
*
* @return mixed[] Server paths of source images.
*/
private function skip_converted_paths_chunks(
array $source_dirs,
bool $skip_converted,
array $allowed_output_formats = null
): array {
$plugin_settings = $this->plugin_data->get_plugin_settings();
$allowed_output_formats = $allowed_output_formats ?: $plugin_settings[ OutputFormatsOption::OPTION_NAME ];
$force_convert_deleted = ( ! in_array( ExtraFeaturesOption::OPTION_VALUE_ONLY_SMALLER, $plugin_settings[ ExtraFeaturesOption::OPTION_NAME ] ) );
$force_convert_crashed = ( $plugin_settings[ ServiceModeOption::OPTION_NAME ] === 'yes' );
foreach ( $source_dirs as $dir_name => $dir_data ) {
foreach ( $dir_data['files'] as $path_index => $source_file ) {
$source_path = $dir_data['path'] . '/' . $source_file;
$is_converted = true;
foreach ( $allowed_output_formats as $output_format ) {
$output_path = $this->output_path->get_path( $source_path, false, $output_format );
if ( $output_path && ( ! $skip_converted || ! $this->is_converted_file( $source_path, $output_path, $force_convert_deleted, $force_convert_crashed ) ) ) {
$is_converted = false;
break;
}
}
if ( $is_converted ) {
unset( $source_dirs[ $dir_name ]['files'][ $path_index ] );
}
}
}
return $source_dirs;
}
/**
* Returns list of server paths of source images to be converted.
*
* @return mixed[] {
* @type string $path Directory path.
* @type string[] $files Files paths.
* }
*/
private function find_source_paths(): array {
$settings = $this->plugin_data->get_plugin_settings();
$source_dirs = [];
foreach ( $settings[ SupportedDirectoriesOption::OPTION_NAME ] as $dir_name ) {
$source_dirs[ $dir_name ] = apply_filters( 'webpc_dir_path', '', $dir_name );
}
$list = [];
foreach ( $source_dirs as $dir_name => $dir_path ) {
$list[ $dir_name ] = [
'path' => $dir_path,
'files' => $this->files_finder->get_files_by_directory( $dir_path ),
];
}
return $list;
}
/**
* @param string $source_path .
* @param string $output_path .
* @param bool $force_convert_deleted Skip .deleted files.
* @param bool $force_convert_crashed Skip .crashed files.
* @param bool $force_convert_modified .
*
* @return bool
*/
private function is_converted_file(
string $source_path,
string $output_path,
bool $force_convert_deleted,
bool $force_convert_crashed,
bool $force_convert_modified = false
): bool {
if ( file_exists( $output_path ) ) {
return ( $force_convert_modified ) ? ( filemtime( $source_path ) <= filemtime( $output_path ) ) : true;
} elseif ( ! $force_convert_deleted && file_exists( $output_path . '.' . LargerFilesOperator::DELETED_FILE_EXTENSION ) ) {
return true;
} elseif ( ! $force_convert_crashed && file_exists( $output_path . '.' . CrashedFilesOperator::CRASHED_FILE_EXTENSION ) ) {
return true;
}
return false;
}
/**
* @param int $paths_count .
*
* @return int<1, max>
*/
private function get_paths_chunk_size( int $paths_count ): int {
$settings = $this->plugin_data->get_plugin_settings();
if ( $settings[ ConversionMethodOption::OPTION_NAME ] !== RemoteMethod::METHOD_NAME ) {
return self::PATHS_PER_REQUEST_LOCAL;
}
if ( $settings[ ServiceModeOption::OPTION_NAME ] === 'yes' ) {
return self::PATHS_PER_REQUEST_REMOTE_LARGE;
}
$output_formats = count( $settings[ OutputFormatsOption::OPTION_NAME ] ) ?: 1;
$images_count = $paths_count * $output_formats;
$images_limit = $this->token_repository->get_token()->get_images_limit();
$images_to_conversion = min( $images_count, $images_limit );
if ( $images_to_conversion <= 10000 ) {
return self::PATHS_PER_REQUEST_REMOTE_SMALL;
} elseif ( $images_to_conversion <= 120000 ) {
return self::PATHS_PER_REQUEST_REMOTE_MEDIUM;
} else {
return self::PATHS_PER_REQUEST_REMOTE_LARGE;
}
}
}
Zerion Mini Shell 1.0