+
+
+
+
+
+` element.
+ * @var string $value The checkbox value.
+ */
+?>
++
+ +
++
+ + +
+
+
+
+
+
+
+
+
+ get_uploader_description( $can_upload, $has_local_avatar ), T::ALLOWED_HTML_LABEL ); ?> +
+ +
+
+ [] ];
+
+?>
++ +
++ +
+
+
+check() ) {
+
+ /**
+ * Create and start the plugin.
+ *
+ * @var Controller
+ */
+ $plugin = Factory::get()->create( Controller::class );
+ $plugin->run();
+ }
+}
+run_avatar_privacy();
diff --git a/includes/avatar-privacy-functions.php b/includes/avatar-privacy-functions.php
new file mode 100644
index 0000000..b5e4280
--- /dev/null
+++ b/includes/avatar-privacy-functions.php
@@ -0,0 +1,54 @@
+
+ *
+ * @phpstan-type AvatarArguments array{ force?: bool, ... }
+ */
+interface Avatar_Handler {
+
+ /**
+ * Retrieves the URL for the given default icon type.
+ *
+ * @since 2.7.0 Removed argument index 'type' as it is not required for all implemntations.
+ *
+ * @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 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 );
+
+ /**
+ * 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 (may contain implementation-specific data).
+ * @param string $extension The requested file extension.
+ *
+ * @return bool Returns `true` if successful, `false` otherwise.
+ */
+ public function cache_image( $type, $hash, $size, $subdir, $extension );
+
+ /**
+ * Retrieves the name of the cache directory 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();
+}
diff --git a/includes/avatar-privacy/avatar-handlers/class-default-icons-handler.php b/includes/avatar-privacy/avatar-handlers/class-default-icons-handler.php
new file mode 100644
index 0000000..b246bb0
--- /dev/null
+++ b/includes/avatar-privacy/avatar-handlers/class-default-icons-handler.php
@@ -0,0 +1,200 @@
+
+ *
+ * @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 '';
+ }
+}
diff --git a/includes/avatar-privacy/avatar-handlers/class-gravatar-cache-handler.php b/includes/avatar-privacy/avatar-handlers/class-gravatar-cache-handler.php
new file mode 100644
index 0000000..11098b9
--- /dev/null
+++ b/includes/avatar-privacy/avatar-handlers/class-gravatar-cache-handler.php
@@ -0,0 +1,249 @@
+
+ *
+ * @phpstan-type AvatarArguments array{
+ * email?: string,
+ * rating?: key-of+ +
+-
+
- +
- +
- +
' . \__( 'Comments', 'avatar-privacy' ) . '
'; + $content .= '' . \__( 'The information in this subsection supersedes the paragraph on Gravatar in the default "Comments" subsection provided by WordPress.', 'avatar-privacy' ) . '
'; + $content .= "{$suggested_text}" . \__( 'At your option, an anonymized string created from your email address (also called a hash) may be provided to the Gravatar service to see if you are using it. The Gravatar service privacy policy is available here: https://automattic.com/privacy/. After approval of your comment, your profile picture is visible to the public in the context of your comment. Neither the hash nor your actual email address will be exposed to the public.', 'avatar-privacy' ) . '
'; + $content .= '' . \__( 'Cookies', 'avatar-privacy' ) . '
'; + $content .= '' . \__( 'The information in this subsection should be included in addition to the information about any other cookies set by either WordPress or another plugin.', 'avatar-privacy' ) . '
'; + $content .= "{$suggested_text}" . \__( 'If you leave a comment on our site and opt-in to display your Gravatar image, your choice will be stored in a cookie. This is for your convenience so that you do not have to fill the checkbox again when you leave another comment. This cookie will last for one year.', 'avatar-privacy' ) . '
'; + + \wp_add_privacy_policy_content( \__( 'Avatar Privacy', 'avatar-privacy' ), $content ); + } + + /** + * Registers an exporter function for the personal data collected by this plugin. + * + * @param array $exporters The registered exporter callbacks. + * + * @return array + * + * @phpstan-param PrivacyExporter[] $exporters + * @phpstan-return PrivacyExporter[] + */ + public function register_personal_data_exporter( array $exporters ) { + $exporters['avatar-privacy-user'] = [ + 'exporter_friendly_name' => \__( 'Avatar Privacy Plugin User Data', 'avatar-privacy' ), + 'callback' => [ $this, 'export_user_data' ], + ]; + $exporters['avatar-privacy-comment-author'] = [ + 'exporter_friendly_name' => \__( 'Avatar Privacy Plugin Comment Author Data', 'avatar-privacy' ), + 'callback' => [ $this, 'export_comment_author_data' ], + ]; + + return $exporters; + } + + /** + * Registers an eraser function for the personal data collected by this plugin. + * + * @param array $erasers The registered eraser callbacks. + * + * @return array + * + * @phpstan-param PrivacyEraser[] $erasers + * @phpstan-return PrivacyEraser[] + */ + public function register_personal_data_eraser( array $erasers ) { + $erasers['avatar-privacy'] = [ + 'eraser_friendly_name' => \__( 'Avatar Privacy Plugin', 'avatar-privacy' ), + 'callback' => [ $this, 'erase_data' ], + ]; + + return $erasers; + } + + /** + * Exports the data associated with a user account. + * + * @since 2.5.0 Unused parameter $page removed. + * + * @param string $email The email address. + * + * @return array { + * @type mixed $data The exported data. + * @type bool $done True if there is no more data to export, false otherwise. + * } + * + * @phpstan-return PrivacyExportResult + */ + public function export_user_data( $email ) { + $user = \get_user_by( 'email', $email ); + if ( empty( $user ) ) { + return [ + 'data' => [], + 'done' => true, + ]; + } + + // Initialize export data. + $user_data = []; + + // Export the hashed email. + $user_data[] = [ + 'name' => \__( 'User Email Hash', 'avatar-privacy' ), + 'value' => $this->registered_user->get_hash( $user->ID ), + ]; + + // Export the `use_gravatar` setting. + if ( $this->registered_user->has_gravatar_policy( $user->ID ) ) { + $user_data[] = [ + 'name' => \__( 'Use Gravatar.com', 'avatar-privacy' ), + 'value' => $this->registered_user->allows_gravatar_use( $user->ID ), + ]; + } + + // Export the `allow_anonymous` setting. + if ( $this->registered_user->has_anonymous_commenting_policy( $user->ID ) ) { + $user_data[] = [ + 'name' => \__( 'Logged-out Commenting', 'avatar-privacy' ), + 'value' => $this->registered_user->allows_anonymous_commenting( $user->ID ), + ]; + } + + // Export the uploaded avatar. + // We don't want to use the filtered value here. + $local_avatar = $this->registered_user->get_local_avatar( $user->ID ); + if ( ! empty( $local_avatar['file'] ) ) { + $user_data[] = [ + 'name' => \__( 'User Profile Picture', 'avatar-privacy' ), + 'value' => \str_replace( \ABSPATH, \trailingslashit( \site_url() ), $local_avatar['file'] ), + ]; + } + + return [ + 'data' => [ + [ + 'group_id' => 'user', // Existing Core group. + 'group_label' => \__( 'User' ), // phpcs:ignore WordPress.WP.I18n.MissingArgDomain -- Missing text domain is intentional to use Core translation. + 'item_id' => "user-{$user->ID}", // Existing Core item ID. + 'data' => $user_data, // The personal data that should be exported. + ], + ], + 'done' => true, + ]; + } + + /** + * Exports the data associated with a comment author email address. + * + * @since 2.5.0 Unused parameter $page removed. + * + * @param string $email The email address. + * + * @return array { + * @type mixed $data The exported data. + * @type bool $done True if there is no more data to export, false otherwise. + * } + * + * @phpstan-return PrivacyExportResult + */ + public function export_comment_author_data( $email ) { + // Load raw data. + $raw_data = $this->comment_author->load( $email ); + if ( empty( $raw_data ) ) { + return [ + 'data' => [], + 'done' => true, + ]; + } + + // Export the avatar privacy ID. + $data = []; + $id = $raw_data->id; + $data[] = [ + 'name' => \__( 'Avatar Privacy Comment Author ID', 'avatar-privacy' ), + 'value' => $id, + ]; + + // Export the email. + $data[] = [ + 'name' => \__( 'Comment Author Email', 'avatar-privacy' ), + 'value' => $raw_data->email, + ]; + + // Export the hashed email. + $data[] = [ + 'name' => \__( 'Comment Author Email Hash', 'avatar-privacy' ), + 'value' => $raw_data->hash, + ]; + + // Export the `use_gravatar` setting. + $data[] = [ + 'name' => \__( 'Use Gravatar.com', 'avatar-privacy' ), + 'value' => $raw_data->use_gravatar, + ]; + + // Export the last modified date. + $data[] = [ + 'name' => \__( 'Last Updated', 'avatar-privacy' ), + 'value' => $raw_data->last_updated, + ]; + + // Export the log message. + $data[] = [ + 'name' => \__( 'Log Message', 'avatar-privacy' ), + 'value' => $raw_data->log_message, + ]; + + return [ + 'data' => [ + [ + 'group_id' => 'avatar-privacy', // An ID to identify this particular group of information. + 'group_label' => \__( 'Avatar Privacy', 'avatar-privacy' ), // A translatable string to label this group of information. + 'item_id' => "avatar-privacy-{$id}", // The item ID of what we're exporting. + 'data' => $data, // The personal data that should be exported. + ], + ], + 'done' => true, + ]; + } + + /** + * Erases the data collected by this plugin. + * + * @since 2.5.0 Unused parameter $page removed. + * + * @param string $email The email address. + * + * @return array { + * @type int $items_removed The number of removed items. + * @type int $items_retained The number of items that were retained and anonymized. + * @type array $messages Any additional information for the admin associated with the removal request. + * @type bool $done True if there is no more data to erase, false otherwise. + * } + * + * @phpstan-return PrivacyEraseResult + */ + public function erase_data( $email ) { + $items_removed = 0; + $items_retained = 0; // We currently don't track this information. + $messages = []; + + // Remove user data. + $user = \get_user_by( 'email', $email ); + if ( ! empty( $user ) ) { + $items_removed += $this->registered_user->delete( $user->ID ); + } + + // Remove comment author data. + $items_removed += $this->comment_author->delete( $email ); + + return [ + 'items_removed' => $items_removed, + 'items_retained' => $items_retained, + 'messages' => $messages, + 'done' => true, + ]; + } +} diff --git a/includes/avatar-privacy/components/class-settings-page.php b/includes/avatar-privacy/components/class-settings-page.php new file mode 100644 index 0000000..18144f9 --- /dev/null +++ b/includes/avatar-privacy/components/class-settings-page.php @@ -0,0 +1,229 @@ + + * + * @phpstan-import-type SettingsFields from Settings + */ +class Settings_Page implements Component { + + /** + * The options handler. + * + * @var Options + */ + private Options $options; + + /** + * The file upload handler. + * + * @var Upload + */ + private Upload $upload; + + /** + * The settings API. + * + * @var Settings + */ + private Settings $settings; + + /** + * The templating handler. + * + * @since 2.4.0 + * + * @var Template + */ + private Template $template; + + /** + * Indiciates whether the settings page is buffering its output. + * + * @var bool + */ + private bool $buffering; + + /** + * Creates a new instance. + * + * @since 2.1.0 Parameter $plugin_file removed. + * @since 2.4.0 Paraemter $core removed, parameter $template added. + * + * @param Options $options The options handler. + * @param Upload $upload The file upload handler. + * @param Settings $settings The settings API. + * @param Template $template The templating handler. + */ + public function __construct( Options $options, Upload $upload, Settings $settings, Template $template ) { + $this->options = $options; + $this->upload = $upload; + $this->settings = $settings; + $this->template = $template; + $this->buffering = false; + } + + /** + * Sets up the various hooks for the plugin component. + * + * @return void + */ + public function run() { + if ( \is_admin() ) { + // Register scripts. + \add_action( 'admin_init', [ $this, 'register_settings' ] ); + + // Add form encoding. + \add_action( 'admin_head-options-discussion.php', [ $this, 'settings_head' ] ); + + // Print scripts. + \add_action( 'admin_footer-options-discussion.php', [ $this, 'settings_footer' ] ); + } + } + + /** + * Run tasks in the settings header. + * + * @return void + */ + public function settings_head() { + if ( \ob_start( [ $this, 'add_form_encoding' ] ) ) { + $this->buffering = true; + } + } + + /** + * Run tasks in the settings footer. + * + * @return void + */ + public function settings_footer() { + // Add show/hide javascript. + if ( \wp_script_is( 'jquery', 'done' ) ) { + $this->template->print_partial( 'admin/partials/sections/avatars-disabled-script.php' ); + } + + // Clean up output buffering. + if ( $this->buffering && \ob_get_level() > 0 ) { + \ob_end_flush(); + $this->buffering = false; + } + } + + /** + * Registers the settings with the settings API. This is only used to display + * an explanation of the wrong gravatar settings. + * + * @return void + */ + public function register_settings() { + \register_setting( 'discussion', $this->options->get_name( Settings::OPTION_NAME ), [ $this, 'sanitize_settings' ] ); + + // Register control render callbacks. + $controls = Control_Factory::initialize( $this->settings->get_fields( $this->get_settings_header() ), $this->options, Settings::OPTION_NAME ); + foreach ( $controls as $control ) { + $control->register( 'discussion' ); + } + } + + /** + * Adds the enctype "multipart/form-data" to the form tag. + * + * @param string $content The captured HTML output. + * + * @return string + */ + public function add_form_encoding( $content ) { + return (string) \preg_replace( '#(