avatar-privacy/includes/avatar-privacy/avatar-handlers/class-default-icons-handler.php

<?php
/**
 * This file is part of Avatar Privacy.
 *
 * Copyright 2018-2023 Peter Putzer.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 *  ***
 *
 * @package mundschenk-at/avatar-privacy
 * @license http://www.gnu.org/licenses/gpl-2.0.html
 */

namespace Avatar_Privacy\Avatar_Handlers;

use Avatar_Privacy\Avatar_Handlers\Avatar_Handler;
use Avatar_Privacy\Avatar_Handlers\Default_Icons\Icon_Provider; // phpcs:ignore ImportDetection.Imports.RequireImports.Import -- needed for PHPDoc
use Avatar_Privacy\Tools\Network\Remote_Image_Service;

/**
 * Handles image caching for default icons.
 *
 * @since 2.0.0
 *
 * @author Peter Putzer <github@mundschenk.at>
 *
 * @phpstan-type AvatarArguments array{
 *     type?: string,
 *     force?: bool,
 * }
 */
class Default_Icons_Handler implements Avatar_Handler {

	/**
	 * A list of icon providers.
	 *
	 * @var Icon_Provider[]
	 */
	private array $icon_providers = [];

	/**
	 * The mapping of icon types to providers.
	 *
	 * @var Icon_Provider[]
	 */
	private array $icon_provider_mapping = [];

	/**
	 * The remote images handler.
	 *
	 * @var Remote_Image_Service
	 */
	private Remote_Image_Service $remote_images;

	/**
	 * Creates a new instance.
	 *
	 * @since 2.1.0 Parameter $plugin_file removed.
	 * @since 2.3.4 Parameter $remote_images added.
	 * @since 2.4.0 Parameter $file_cache removed.
	 *
	 * @param Icon_Provider[]      $icon_providers An array of icon providers.
	 * @param Remote_Image_Service $remote_images  The remote images handler.
	 */
	public function __construct( array $icon_providers, Remote_Image_Service $remote_images ) {
		$this->icon_providers = $icon_providers;
		$this->remote_images  = $remote_images;
	}

	/**
	 * Returns a mapping from icon types to specific providers.
	 *
	 * @since 2.1.0 Visibility changed to protected.
	 *
	 * @return Icon_Provider[]
	 */
	protected function get_provider_mapping() {
		if ( empty( $this->icon_provider_mapping ) ) {
			foreach ( $this->icon_providers as $provider ) {
				foreach ( $provider->get_provided_types() as $type ) {
					$this->icon_provider_mapping[ $type ] = $provider;
				}
			}
		}

		return $this->icon_provider_mapping;
	}

	/**
	 * Retrieves the URL for the given default icon type.
	 *
	 * @since 2.3.4 Documentation for optional arguments adapted to follow implementation.
	 * @since 2.7.0 Argument key 'default' replaced with 'type' for consistency.
	 *
	 * @param  string $url  The fallback image URL.
	 * @param  string $hash The hashed mail address.
	 * @param  int    $size The size of the avatar image in pixels.
	 * @param  array  $args {
	 *     An array of arguments.
	 *
	 *     @type string $type    The default icon type.
	 *     @type bool   $force   Optional. Whether to force the regeneration of the image file. Default false.
	 * }
	 *
	 * @return string
	 *
	 * @phpstan-param AvatarArguments $args
	 */
	public function get_url( $url, $hash, $size, array $args ) {
		$defaults = [
			'type'  => '',
			'force' => false,
		];

		$args = \wp_parse_args( $args, $defaults );

		// Check for named icon providers first.
		$providers = $this->get_provider_mapping();
		if ( ! empty( $providers[ $args['type'] ] ) ) {
			return $providers[ $args['type'] ]->get_icon_url( $hash, $size, $args['force'] );
		}

		// Check if the given default icon type is a valid image URL (a common
		// pattern due to how the default WordPress implementation uses Gravatar.com).
		if ( $this->remote_images->validate_image_url( $args['type'], 'default_icon' ) ) {
			// Prepare filter arguments.
			$url  = $args['type'];
			$hash = $this->remote_images->get_hash( $url );

			/** This filter is documented in avatar-privacy/components/class-avatar-handling.php */
			return \apply_filters( 'avatar_privacy_legacy_icon_url', $url, $hash, $size, [ 'force' => $args['force'] ] );
		}

		// Return the fallback default icon URL.
		return $url;
	}

	/**
	 * Caches the image specified by the parameters.
	 *
	 * @param  string $type      The image (sub-)type.
	 * @param  string $hash      The hashed mail address.
	 * @param  int    $size      The requested size in pixels.
	 * @param  string $subdir    The requested sub-directory.
	 * @param  string $extension The requested file extension.
	 *
	 * @return bool              Returns `true` if successful, `false` otherwise.
	 */
	public function cache_image( $type, $hash, $size, $subdir, $extension ) {
		return ! empty( $this->get_url( '', $hash, $size, [ 'type' => $type ] ) );
	}

	/**
	 * Adds new images to the list of default avatar images.
	 *
	 * @param  string[] $avatar_defaults The list of default avatar images.
	 *
	 * @return string[] The modified default avatar array.
	 */
	public function avatar_defaults( $avatar_defaults ) {
		// Remove Gravatar logo.
		unset( $avatar_defaults['gravatar_default'] );

		// Add non-default icons.
		foreach ( $this->icon_providers as $provider ) {
			$type = $provider->get_option_value();
			if ( ! isset( $avatar_defaults[ $type ] ) ) {
				$avatar_defaults[ $type ] = $provider->get_name();
			}
		}

		return $avatar_defaults;
	}

	/**
	 * Retrieves the name of the cache subdirectory for avatars provided by this
	 * handler (e.g. 'gravatar'). Implementations may return an empty string if
	 * the actual type can vary.
	 *
	 * @since 2.4.0
	 *
	 * @return string
	 */
	public function get_type() {
		return '';
	}
}