250 lines
6.9 KiB
PHP
250 lines
6.9 KiB
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\Core;
|
|
|
|
use Avatar_Privacy\Avatar_Handlers\Avatar_Handler;
|
|
|
|
use Avatar_Privacy\Data_Storage\Filesystem_Cache;
|
|
use Avatar_Privacy\Data_Storage\Options;
|
|
|
|
use Avatar_Privacy\Tools\Images\Image_File;
|
|
use Avatar_Privacy\Tools\Network\Gravatar_Service;
|
|
|
|
/**
|
|
* Handles retrieving and caching Gravatar.com images.
|
|
*
|
|
* @since 1.0.0
|
|
* @since 2.0.0 Class was moved to Avatar_Privacy\Avatar_Handlers and now implements the new Avatar_Handler interface.
|
|
* @since 2.4.0 Internal constants and property $type_mapping removed.
|
|
*
|
|
* @author Peter Putzer <github@mundschenk.at>
|
|
*
|
|
* @phpstan-type AvatarArguments array{
|
|
* email?: string,
|
|
* rating?: key-of<self::GRAVATAR_RATING>,
|
|
* mimetype?: string,
|
|
* force?: bool
|
|
* }
|
|
*/
|
|
class Gravatar_Cache_Handler implements Avatar_Handler {
|
|
|
|
/**
|
|
* Valid Gravatar image ratings.
|
|
*
|
|
* @since 2.7.0.
|
|
*/
|
|
private const GRAVATAR_RATING = [
|
|
'g' => true,
|
|
'pg' => true,
|
|
'r' => true,
|
|
'x' => true,
|
|
];
|
|
|
|
/**
|
|
* The core API.
|
|
*
|
|
* @var Core
|
|
*/
|
|
private Core $core;
|
|
|
|
/**
|
|
* The options handler.
|
|
*
|
|
* @var Options
|
|
*/
|
|
private Options $options;
|
|
|
|
/**
|
|
* The filesystem cache handler.
|
|
*
|
|
* @var Filesystem_Cache
|
|
*/
|
|
private Filesystem_Cache $file_cache;
|
|
|
|
/**
|
|
* The Gravatar network service.
|
|
*
|
|
* @var Gravatar_Service
|
|
*/
|
|
private Gravatar_Service $gravatar;
|
|
|
|
/**
|
|
* Creates a new instance.
|
|
*
|
|
* @since 2.0.0 Parameter $gravatar added.
|
|
*
|
|
* @param Core $core The core API.
|
|
* @param Options $options The options handler.
|
|
* @param Filesystem_Cache $file_cache The file cache handler.
|
|
* @param Gravatar_Service $gravatar The Gravatar network service.
|
|
*/
|
|
public function __construct( Core $core, Options $options, Filesystem_Cache $file_cache, Gravatar_Service $gravatar ) {
|
|
$this->core = $core;
|
|
$this->options = $options;
|
|
$this->file_cache = $file_cache;
|
|
$this->gravatar = $gravatar;
|
|
}
|
|
|
|
/**
|
|
* Retrieves the Gravatar icon URL.
|
|
*
|
|
* Note: Not all of the arguments provided by the `avatar_privacy_gravatar_icon_url`
|
|
* filter hook are actually required.
|
|
*
|
|
* @since 2.7.0 Unused arguments key 'user_id' removed.
|
|
*
|
|
* @param string $url The fallback default icon 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 $email The mail address used to generate the identity hash.
|
|
* @type string $rating Optional. The audience rating (e.g. 'g', 'pg', 'r', 'x'). Default 'g'.
|
|
* @type string $mimetype Optional. The expected MIME type of the Gravatar image. Default 'image/png'.
|
|
* @type bool $force Optional. Whether to force re-caching of the image file. Default false.
|
|
* }
|
|
*
|
|
* @return string
|
|
*
|
|
* @phpstan-param AvatarArguments $args
|
|
*/
|
|
public function get_url( $url, $hash, $size, array $args ) {
|
|
$defaults = [
|
|
'email' => '',
|
|
'rating' => 'g',
|
|
'mimetype' => Image_File::PNG_IMAGE,
|
|
'force' => false,
|
|
];
|
|
|
|
$args = \wp_parse_args( $args, $defaults );
|
|
$filename = "gravatar/{$this->get_sub_dir( $hash )}/{$hash}-{$size}." . Image_File::FILE_EXTENSION[ $args['mimetype'] ];
|
|
|
|
// Only retrieve new Gravatar if necessary.
|
|
if ( $args['force'] || ! \file_exists( "{$this->file_cache->get_base_dir()}{$filename}" ) ) {
|
|
// Retrieve the gravatar icon.
|
|
$icon = $this->gravatar->get_image( $args['email'], $size, $args['rating'] );
|
|
|
|
// Store it (empty files will fail this check).
|
|
if ( ! $this->file_cache->set( $filename, $icon, $args['force'] ) ) {
|
|
// Something went wrong..
|
|
return $url;
|
|
}
|
|
}
|
|
|
|
return $this->file_cache->get_url( $filename );
|
|
}
|
|
|
|
/**
|
|
* Calculates the subdirectory from the given identity hash.
|
|
*
|
|
* @since 2.1.0 Visibility changed to protected.
|
|
* @since 2.4.0 Parameter $user removed.
|
|
*
|
|
* @param string $identity The identity (mail address) hash.
|
|
*
|
|
* @return string
|
|
*/
|
|
protected function get_sub_dir( $identity ) {
|
|
return \implode( '/', \str_split( \substr( $identity, 0, 2 ) ) );
|
|
}
|
|
|
|
/**
|
|
* Caches the image specified by the parameters.
|
|
*
|
|
* @since 2.0.0
|
|
*
|
|
* @param string $type The image (sub-)type. Ignored.
|
|
* @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 ) {
|
|
|
|
// Lookup user and/or email address.
|
|
$user = $this->core->get_user_by_hash( $hash );
|
|
|
|
if ( ! empty( $user ) ) {
|
|
$email = ! empty( $user->user_email ) ? $user->user_email : '';
|
|
} else {
|
|
$email = $this->core->get_comment_author_email( $hash );
|
|
}
|
|
|
|
// Could not find user/comment author.
|
|
if ( empty( $email ) ) {
|
|
return false;
|
|
}
|
|
|
|
// Prepare arguments.
|
|
$args = [
|
|
'email' => $email,
|
|
'rating' => $this->get_avatar_rating(),
|
|
'mimetype' => Image_File::CONTENT_TYPE[ $extension ],
|
|
];
|
|
|
|
// Try to cache the icon.
|
|
return ! empty( $this->get_url( '', $hash, $size, $args ) );
|
|
}
|
|
|
|
/**
|
|
* 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 'gravatar';
|
|
}
|
|
|
|
/**
|
|
* Retrieves the allowed avatar image ratings.
|
|
*
|
|
* @since 2.7.0
|
|
*
|
|
* @return string
|
|
*
|
|
* @phpstan-return key-of<self::GRAVATAR_RATING>
|
|
*/
|
|
protected function get_avatar_rating() {
|
|
$rating = $this->options->get( 'avatar_rating', 'g', true );
|
|
|
|
if ( ! \is_string( $rating ) || empty( self::GRAVATAR_RATING[ $rating ] ) ) {
|
|
$rating = 'g';
|
|
}
|
|
|
|
return $rating; // @phpstan-ignore-line -- https://github.com/phpstan/phpstan/issues/8559
|
|
}
|
|
}
|