init
This commit is contained in:
@@ -0,0 +1,233 @@
|
||||
<?php //phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
|
||||
/**
|
||||
* Jetpack comments admin menu file.
|
||||
*
|
||||
* @package automattic/jetpack
|
||||
*/
|
||||
/**
|
||||
* Class Jetpack_Comments_Settings
|
||||
* This class represents the comments settings functionality.
|
||||
*/
|
||||
class Jetpack_Comments_Settings {
|
||||
|
||||
/** Variables *************************************************************/
|
||||
|
||||
/**
|
||||
* The Jetpack Comments singleton
|
||||
*
|
||||
* @var Highlander_Comments_Base
|
||||
*/
|
||||
public $jetpack_comments;
|
||||
|
||||
/**
|
||||
* The default comment form greeting - blank to start with
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
public $default_greeting = ''; // Set in constructor.
|
||||
|
||||
/**
|
||||
* The default comment form color scheme - an empty array to start with
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
public $color_schemes = array();
|
||||
|
||||
/**
|
||||
* Initialize class
|
||||
*/
|
||||
public static function init() {
|
||||
static $instance = false;
|
||||
|
||||
if ( ! $instance ) {
|
||||
$instance = new Jetpack_Comments_Settings( Jetpack_Comments::init() );
|
||||
}
|
||||
|
||||
return $instance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Constructor
|
||||
*
|
||||
* @param Highlander_Comments_Base $jetpack_comments The Jetpack Comments singleton.
|
||||
*/
|
||||
public function __construct( Highlander_Comments_Base $jetpack_comments ) {
|
||||
$this->jetpack_comments = $jetpack_comments;
|
||||
|
||||
// Setup settings.
|
||||
add_action( 'admin_init', array( $this, 'add_settings' ) );
|
||||
$this->setup_globals();
|
||||
}
|
||||
|
||||
/** Private Methods ****************************************************** */
|
||||
|
||||
/**
|
||||
* Set any global variables or class variables
|
||||
*
|
||||
* @since 1.4
|
||||
*/
|
||||
protected function setup_globals() {
|
||||
// Default option values.
|
||||
$this->default_greeting = __( 'Leave a Reply', 'jetpack' );
|
||||
|
||||
// Possible color schemes.
|
||||
$this->color_schemes = array(
|
||||
'light' => __( 'Light', 'jetpack' ),
|
||||
'dark' => __( 'Dark', 'jetpack' ),
|
||||
'transparent' => __( 'Transparent', 'jetpack' ),
|
||||
);
|
||||
}
|
||||
|
||||
/** Settings ************************************************************* */
|
||||
|
||||
/**
|
||||
* Add the Jetpack settings to WordPress's discussions page
|
||||
*
|
||||
* @since 1.4
|
||||
*/
|
||||
public function add_settings() {
|
||||
|
||||
// Create the section.
|
||||
add_settings_section(
|
||||
'jetpack_comment_form',
|
||||
__( 'Comments', 'jetpack' ),
|
||||
array( $this, 'comment_form_settings_section' ),
|
||||
'discussion'
|
||||
);
|
||||
|
||||
/**
|
||||
* Clever Greeting
|
||||
*/
|
||||
add_settings_field(
|
||||
'highlander_comment_form_prompt',
|
||||
__( 'Greeting Text', 'jetpack' ),
|
||||
array( $this, 'comment_form_greeting_setting' ),
|
||||
'discussion',
|
||||
'jetpack_comment_form'
|
||||
);
|
||||
|
||||
register_setting(
|
||||
'discussion',
|
||||
'highlander_comment_form_prompt',
|
||||
array( $this, 'comment_form_greeting_sanitize' )
|
||||
);
|
||||
|
||||
/**
|
||||
* Color Scheme
|
||||
*/
|
||||
add_settings_field(
|
||||
'jetpack_comment_form_color_scheme',
|
||||
__( 'Color Scheme', 'jetpack' ),
|
||||
array( $this, 'comment_form_color_scheme_setting' ),
|
||||
'discussion',
|
||||
'jetpack_comment_form'
|
||||
);
|
||||
|
||||
register_setting(
|
||||
'discussion',
|
||||
'jetpack_comment_form_color_scheme',
|
||||
array( $this, 'comment_form_color_scheme_sanitize' )
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Discussions setting section blurb
|
||||
*
|
||||
* @since 1.4
|
||||
*/
|
||||
public function comment_form_settings_section() {
|
||||
?>
|
||||
|
||||
<p id="jetpack-comments-settings"><?php esc_html_e( 'Adjust your Comments form with a clever greeting and color-scheme.', 'jetpack' ); ?></p>
|
||||
|
||||
<?php
|
||||
}
|
||||
|
||||
/**
|
||||
* Custom Comment Greeting Text
|
||||
*
|
||||
* @since 1.4
|
||||
*/
|
||||
public function comment_form_greeting_setting() {
|
||||
|
||||
// The greeting.
|
||||
$greeting = get_option( 'highlander_comment_form_prompt', $this->default_greeting );
|
||||
?>
|
||||
|
||||
<input type="text" name="highlander_comment_form_prompt" id="jetpack-comment-form-greeting" value="<?php echo esc_attr( $greeting ); ?>" class="regular-text">
|
||||
<p class="description"><?php esc_html_e( 'A few catchy words to motivate your readers to comment', 'jetpack' ); ?></p>
|
||||
|
||||
<?php
|
||||
}
|
||||
|
||||
/**
|
||||
* Sanitize the clever comment greeting
|
||||
*
|
||||
* @since 1.4
|
||||
* @param string $val The contact form greeting string.
|
||||
* @return string
|
||||
*/
|
||||
public function comment_form_greeting_sanitize( $val ) {
|
||||
|
||||
// Delete if empty or the default.
|
||||
if ( empty( $val ) || ( $this->default_greeting === $val ) ) {
|
||||
delete_option( 'highlander_comment_form_prompt' );
|
||||
return false;
|
||||
}
|
||||
|
||||
return wp_kses( $val, array() );
|
||||
}
|
||||
|
||||
/**
|
||||
* Comment Form Color Scheme Setting
|
||||
*
|
||||
* @since 1.4
|
||||
*/
|
||||
public function comment_form_color_scheme_setting() {
|
||||
|
||||
// The color scheme.
|
||||
$scheme = get_option( 'jetpack_comment_form_color_scheme', $this->jetpack_comments->default_color_scheme );
|
||||
?>
|
||||
|
||||
<fieldset>
|
||||
<legend class="screen-reader-text"><?php esc_html_e( 'Color Scheme', 'jetpack' ); ?></legend>
|
||||
|
||||
<?php foreach ( $this->color_schemes as $key => $label ) : ?>
|
||||
|
||||
<label>
|
||||
<input type="radio" name="jetpack_comment_form_color_scheme" id="jetpack-comment-form-color-scheme" value="<?php echo esc_attr( $key ); ?>" <?php checked( $scheme, $key ); ?>>
|
||||
<?php echo esc_attr( $label ); ?>
|
||||
</label>
|
||||
<br />
|
||||
|
||||
<?php endforeach; ?>
|
||||
|
||||
</fieldset>
|
||||
|
||||
<?php
|
||||
}
|
||||
|
||||
/**
|
||||
* Sanitize the color scheme
|
||||
*
|
||||
* @since 1.4
|
||||
* @param string $val The color scheme string.
|
||||
* @return string
|
||||
*/
|
||||
public function comment_form_color_scheme_sanitize( $val ) {
|
||||
|
||||
// Delete the option if it's unknown, or the default.
|
||||
if (
|
||||
empty( $val ) || ! array_key_exists( $val, $this->color_schemes )
|
||||
||
|
||||
$val === $this->jetpack_comments->default_color_scheme
|
||||
) {
|
||||
delete_option( 'jetpack_comment_form_color_scheme' );
|
||||
return false;
|
||||
}
|
||||
|
||||
return $val;
|
||||
}
|
||||
}
|
||||
|
||||
Jetpack_Comments_Settings::init();
|
||||
@@ -0,0 +1,350 @@
|
||||
<?php //phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
|
||||
/**
|
||||
* Jetpack comments base file - where the code shared between WP.com Highlander and Jetpack Highlander is defined
|
||||
*
|
||||
* @package automattic/jetpack
|
||||
*/
|
||||
|
||||
use Automattic\Jetpack\Image_CDN\Image_CDN_Core;
|
||||
|
||||
/**
|
||||
* All the code shared between WP.com Highlander and Jetpack Highlander
|
||||
*/
|
||||
class Highlander_Comments_Base {
|
||||
|
||||
/**
|
||||
* Constructor
|
||||
*/
|
||||
public function __construct() {
|
||||
$this->setup_globals();
|
||||
$this->setup_actions();
|
||||
$this->setup_filters();
|
||||
}
|
||||
|
||||
/**
|
||||
* Set any global variables or class variables
|
||||
*
|
||||
* @since 1.4
|
||||
*/
|
||||
protected function setup_globals() {}
|
||||
|
||||
/**
|
||||
* Setup actions for methods in this class
|
||||
*
|
||||
* @since 1.4
|
||||
*/
|
||||
protected function setup_actions() {
|
||||
// Before a comment is posted.
|
||||
add_action( 'pre_comment_on_post', array( $this, 'allow_logged_out_user_to_comment_as_external' ) );
|
||||
|
||||
// After a comment is posted.
|
||||
add_action( 'comment_post', array( $this, 'set_comment_cookies' ) );
|
||||
}
|
||||
|
||||
/**
|
||||
* Setup filters for methods in this class
|
||||
*
|
||||
* @since 1.4
|
||||
*/
|
||||
protected function setup_filters() {
|
||||
add_filter( 'comments_array', array( $this, 'comments_array' ) );
|
||||
add_filter( 'preprocess_comment', array( $this, 'allow_logged_in_user_to_comment_as_guest' ), 0 );
|
||||
}
|
||||
|
||||
/**
|
||||
* Is this a Highlander POST request?
|
||||
* Optionally restrict to one or more credentials slug (facebook, ...)
|
||||
*
|
||||
* @param mixed ...$args Comments credentials slugs.
|
||||
* @return false|string false if it's not a Highlander POST request. The matching credentials slug if it is.
|
||||
*/
|
||||
public function is_highlander_comment_post( ...$args ) {
|
||||
|
||||
// phpcs:disable WordPress.Security.NonceVerification.Missing -- Nonce verification should happen in Jetpack_Comments::pre_comment_on_post(). Internal ref for details: p1645643468937519/1645189749.180299-slack-C02HQGKMFJ8
|
||||
if ( empty( $_POST['hc_post_as'] ) ) {
|
||||
return false;
|
||||
}
|
||||
$hc_post_as = wp_unslash( $_POST['hc_post_as'] ); // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Sanitized here by comparing against known values.
|
||||
// phpcs:enable WordPress.Security.NonceVerification.Missing
|
||||
|
||||
if ( $args ) {
|
||||
foreach ( $args as $id_source ) {
|
||||
if ( $id_source === $hc_post_as ) {
|
||||
return $id_source;
|
||||
}
|
||||
}
|
||||
return false;
|
||||
}
|
||||
return is_string( $hc_post_as ) && in_array( $hc_post_as, $this->id_sources, true ) ? $hc_post_as : false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Signs an array of scalars with the self-hosted blog's Jetpack Token
|
||||
*
|
||||
* If parameter values are not scalars a WP_Error is returned, otherwise a keyed hash value is returned using the HMAC method.
|
||||
*
|
||||
* @param array $parameters Comment parameters.
|
||||
* @param string $key Key used for generating the HMAC variant of the message digest.
|
||||
* @return string HMAC
|
||||
*/
|
||||
public static function sign_remote_comment_parameters( $parameters, $key ) {
|
||||
unset(
|
||||
$parameters['sig'], // Don't sign the signature.
|
||||
$parameters['replytocom'] // This parameter is unsigned - it changes dynamically as the comment form moves from parent comment to parent comment.
|
||||
);
|
||||
|
||||
ksort( $parameters );
|
||||
|
||||
$signing = array();
|
||||
foreach ( $parameters as $k => $v ) {
|
||||
if ( ! is_scalar( $v ) ) {
|
||||
return new WP_Error( 'invalid_input', __( 'Invalid request', 'jetpack' ), array( 'status' => 400 ) );
|
||||
}
|
||||
|
||||
$signing[] = "{$k}={$v}";
|
||||
}
|
||||
|
||||
return hash_hmac( 'sha1', implode( ':', $signing ), $key );
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds comment author email and whether the comment is approved to the comments array
|
||||
*
|
||||
* After commenting as a guest while logged in, the user needs to see both:
|
||||
* ( user_id = blah AND comment_approved = 0 )
|
||||
* and ( comment_author_email = blah AND comment_approved = 0 )
|
||||
* Core only does the first since the user is logged in, so this adds the second to the comments array.
|
||||
*
|
||||
* @param array $comments All comment data.
|
||||
* @return array A modified array of comment data.
|
||||
*/
|
||||
public function comments_array( $comments ) {
|
||||
global $wpdb, $post;
|
||||
|
||||
$commenter = $this->get_current_commenter();
|
||||
|
||||
if ( ! $commenter['user_id'] ) {
|
||||
return $comments;
|
||||
}
|
||||
|
||||
if ( ! $commenter['comment_author'] ) {
|
||||
return $comments;
|
||||
}
|
||||
|
||||
$in_moderation_comments = $wpdb->get_results(
|
||||
$wpdb->prepare(
|
||||
"SELECT * FROM `$wpdb->comments` WHERE `comment_post_ID` = %d AND `user_id` = 0 AND `comment_author` = %s AND `comment_author_email` = %s AND `comment_approved` = '0' ORDER BY `comment_date_gmt` /* Highlander_Comments_Base::comments_array() */",
|
||||
$post->ID,
|
||||
wp_specialchars_decode( $commenter['comment_author'], ENT_QUOTES ),
|
||||
$commenter['comment_author_email']
|
||||
)
|
||||
);
|
||||
|
||||
if ( ! $in_moderation_comments ) {
|
||||
return $comments;
|
||||
}
|
||||
|
||||
// @todo ZOMG this is a bad idea
|
||||
$comments = array_merge( $comments, $in_moderation_comments );
|
||||
usort( $comments, array( $this, 'sort_comments_by_comment_date_gmt' ) );
|
||||
|
||||
return $comments;
|
||||
}
|
||||
|
||||
/**
|
||||
* Comment sort comparator: comment_date_gmt
|
||||
*
|
||||
* @since 1.4
|
||||
* @param object $a The first comment to compare dates with.
|
||||
* @param object $b The second comment to compare dates with.
|
||||
* @return int
|
||||
*/
|
||||
public function sort_comments_by_comment_date_gmt( $a, $b ) {
|
||||
return $a->comment_date_gmt <=> $b->comment_date_gmt;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the current commenter's information from their cookie
|
||||
*
|
||||
* @since 1.4
|
||||
* @return array Commenters information from cookie
|
||||
*/
|
||||
protected function get_current_commenter() {
|
||||
// Defaults.
|
||||
$user_id = 0;
|
||||
$comment_author = '';
|
||||
$comment_author_email = '';
|
||||
$comment_author_url = '';
|
||||
|
||||
if ( isset( $_COOKIE[ 'comment_author_' . COOKIEHASH ] ) ) {
|
||||
$comment_author = sanitize_text_field( wp_unslash( $_COOKIE[ 'comment_author_' . COOKIEHASH ] ) );
|
||||
}
|
||||
|
||||
if ( isset( $_COOKIE[ 'comment_author_email_' . COOKIEHASH ] ) ) {
|
||||
$comment_author_email = sanitize_email( wp_unslash( $_COOKIE[ 'comment_author_email_' . COOKIEHASH ] ) );
|
||||
}
|
||||
|
||||
if ( isset( $_COOKIE[ 'comment_author_url_' . COOKIEHASH ] ) ) {
|
||||
$comment_author_url = esc_url_raw( wp_unslash( $_COOKIE[ 'comment_author_url_' . COOKIEHASH ] ) );
|
||||
}
|
||||
|
||||
if ( is_user_logged_in() ) {
|
||||
$user = wp_get_current_user();
|
||||
$user_id = $user->ID;
|
||||
}
|
||||
|
||||
return compact( 'comment_author', 'comment_author_email', 'comment_author_url', 'user_id' );
|
||||
}
|
||||
|
||||
/**
|
||||
* Allows a logged out user to leave a comment as a facebook/wp.com credentialed user.
|
||||
* Overrides WordPress' core comment_registration option to treat these commenters as "registered" (verified) users.
|
||||
*
|
||||
* @since 1.4
|
||||
*/
|
||||
public function allow_logged_out_user_to_comment_as_external() {
|
||||
// phpcs:ignore WordPress.WP.CapitalPDangit.MisspelledInText
|
||||
if ( ! $this->is_highlander_comment_post( 'facebook', 'wordpress' ) ) {
|
||||
return;
|
||||
}
|
||||
|
||||
add_filter( 'pre_option_comment_registration', '__return_zero' );
|
||||
add_filter( 'pre_option_require_name_email', '__return_zero' );
|
||||
}
|
||||
|
||||
/**
|
||||
* Allow a logged in user to post as a guest, or FB credentialed request.
|
||||
* Bypasses WordPress' core overrides that force a logged in user to comment as that user.
|
||||
* Respects comment_registration option.
|
||||
*
|
||||
* @since 1.4
|
||||
* @param array $comment_data All data for a specific comment.
|
||||
* @return array Modified comment data, or an error if the required fields or a valid email address are not entered.
|
||||
*/
|
||||
public function allow_logged_in_user_to_comment_as_guest( $comment_data ) {
|
||||
// Bail if user registration is allowed.
|
||||
if ( get_option( 'comment_registration' ) ) {
|
||||
return $comment_data;
|
||||
}
|
||||
|
||||
// Bail if user is not logged in or not a post request.
|
||||
if ( ! isset( $_SERVER['REQUEST_METHOD'] ) || 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) || ! is_user_logged_in() ) { // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.MissingUnslash, WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- simple comparison
|
||||
return $comment_data;
|
||||
}
|
||||
|
||||
// Bail if this is not a guest or external service credentialed request.
|
||||
if ( ! $this->is_highlander_comment_post( 'guest', 'facebook' ) ) {
|
||||
return $comment_data;
|
||||
}
|
||||
|
||||
$user = wp_get_current_user();
|
||||
|
||||
foreach ( array(
|
||||
'comment_author' => 'display_name',
|
||||
'comment_author_email' => 'user_email',
|
||||
'comment_author_url' => 'user_url',
|
||||
) as $comment_field => $user_field ) {
|
||||
if ( addslashes( $user->$user_field ) !== $comment_data[ $comment_field ] ) {
|
||||
return $comment_data; // some other plugin already did something funky.
|
||||
}
|
||||
}
|
||||
|
||||
// phpcs:disable WordPress.Security.NonceVerification.Missing -- Nonce verification should happen in Jetpack_Comments::pre_comment_on_post()
|
||||
// phpcs:disable WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Sanitization too
|
||||
if ( get_option( 'require_name_email' ) ) {
|
||||
if ( isset( $_POST['email'] ) && 6 > strlen( wp_unslash( $_POST['email'] ) ) || empty( $_POST['author'] ) ) {
|
||||
wp_die( esc_html__( 'Error: please fill the required fields (name, email).', 'jetpack' ), 400 );
|
||||
} elseif ( ! isset( $_POST['email'] ) || ! is_email( wp_unslash( $_POST['email'] ) ) ) {
|
||||
wp_die( esc_html__( 'Error: please enter a valid email address.', 'jetpack' ), 400 );
|
||||
}
|
||||
}
|
||||
|
||||
$author_change = false;
|
||||
foreach ( array(
|
||||
'comment_author' => 'author',
|
||||
'comment_author_email' => 'email',
|
||||
'comment_author_url' => 'url',
|
||||
) as $comment_field => $post_field ) {
|
||||
if ( ( ! isset( $_POST[ $post_field ] ) || $comment_data[ $comment_field ] !== $_POST[ $post_field ] ) && 'url' !== $post_field ) {
|
||||
$author_change = true;
|
||||
}
|
||||
$comment_data[ $comment_field ] = isset( $_POST[ $post_field ] ) ? wp_unslash( $_POST[ $post_field ] ) : null;
|
||||
}
|
||||
// phpcs:enable WordPress.Security.NonceVerification.Missing, WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
|
||||
|
||||
// Mark as guest comment if name or email were changed.
|
||||
if ( $author_change ) {
|
||||
$comment_data['user_ID'] = 0;
|
||||
$comment_data['user_id'] = $comment_data['user_ID'];
|
||||
}
|
||||
|
||||
return $comment_data;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the comment cookies or bail if comment is invalid
|
||||
*
|
||||
* @since 1.4
|
||||
* @param int $comment_id The comment ID.
|
||||
*/
|
||||
public function set_comment_cookies( $comment_id ) {
|
||||
// Get comment and bail if it's invalid somehow.
|
||||
$comment = get_comment( $comment_id );
|
||||
if ( empty( $comment ) || is_wp_error( $comment ) ) {
|
||||
return;
|
||||
}
|
||||
|
||||
$id_source = $this->is_highlander_comment_post();
|
||||
if ( empty( $id_source ) ) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Set comment author cookies.
|
||||
// We don't set the cookies if they are logged in with WordPress.com because they already have a cookie set.
|
||||
// phpcs:ignore WordPress.WP.CapitalPDangit
|
||||
if ( 'wordpress' !== $id_source ) {
|
||||
// phpcs:disable WordPress.Security.NonceVerification -- Nonce verification should happen in Jetpack_Comments::pre_comment_on_post().
|
||||
$is_consenting_to_cookies = ( isset( $_POST['wp-comment-cookies-consent'] ) );
|
||||
|
||||
$cookie_options = array(
|
||||
'expires' => time() + apply_filters( 'comment_cookie_lifetime', YEAR_IN_SECONDS ),
|
||||
'path' => COOKIEPATH,
|
||||
'domain' => COOKIE_DOMAIN,
|
||||
'secure' => is_ssl(),
|
||||
'httponly' => true,
|
||||
);
|
||||
|
||||
// If there is no consent, remove any cookies that may have been set.
|
||||
if ( ( 'guest' === $id_source ) && ! $is_consenting_to_cookies ) {
|
||||
$cookie_options['expires'] = time() - YEAR_IN_SECONDS;
|
||||
}
|
||||
|
||||
// Set samesite to None if the request is from Jetpack iframe.
|
||||
// This is needed because it is considered third party.
|
||||
if ( isset( $_REQUEST['for'] ) && 'jetpack' === $_REQUEST['for'] ) {
|
||||
$cookie_options['samesite'] = 'None';
|
||||
}
|
||||
// phpcs:enable WordPress.Security.NonceVerification
|
||||
|
||||
// phpcs:disable Jetpack.Functions.SetCookie.MissingTrueHTTPOnly
|
||||
isset( $comment->comment_author ) ? setcookie( 'comment_author_' . COOKIEHASH, $comment->comment_author, $cookie_options ) : null;
|
||||
isset( $comment->comment_author_email ) ? setcookie( 'comment_author_email_' . COOKIEHASH, $comment->comment_author_email, $cookie_options ) : null;
|
||||
isset( $comment->comment_author_url ) ? setcookie( 'comment_author_url_' . COOKIEHASH, esc_url( $comment->comment_author_url ), $cookie_options ) : null;
|
||||
// phpcs:enable Jetpack.Functions.SetCookie.MissingTrueHTTPOnly
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an avatar from Photon
|
||||
*
|
||||
* @since 1.4
|
||||
* @param string $url The avatar URL.
|
||||
* @param int $size The avatar size.
|
||||
* @return string
|
||||
*/
|
||||
protected function photon_avatar( $url, $size ) {
|
||||
$size = (int) $size;
|
||||
|
||||
return Image_CDN_Core::cdn_url( $url, array( 'resize' => "$size,$size" ) );
|
||||
}
|
||||
}
|
||||
File diff suppressed because it is too large
Load Diff
+209
@@ -0,0 +1,209 @@
|
||||
<?php
|
||||
/**
|
||||
* Adds support for Jetpack Subscription Modal On Comment feature
|
||||
* Limited to Atomic sites.
|
||||
*
|
||||
* @package automattic/jetpack-mu-wpcom
|
||||
* @since 12.4
|
||||
*/
|
||||
|
||||
use Automattic\Jetpack\Extensions\Premium_Content\Subscription_Service\Abstract_Token_Subscription_Service;
|
||||
use Automattic\Jetpack\Status\Host;
|
||||
use const Automattic\Jetpack\Extensions\Subscriptions\META_NAME_FOR_POST_LEVEL_ACCESS_SETTINGS;
|
||||
|
||||
/**
|
||||
* Jetpack_Subscription_Modal_On_Comment class.
|
||||
*/
|
||||
class Jetpack_Subscription_Modal_On_Comment {
|
||||
/**
|
||||
* Jetpack_Subscription_Modal_On_Comment singleton instance.
|
||||
*
|
||||
* @var Jetpack_Subscription_Modal_On_Comment|null
|
||||
*/
|
||||
private static $instance;
|
||||
|
||||
/**
|
||||
* Jetpack_Subscription_Modal_On_Comment instance init.
|
||||
*/
|
||||
public static function init() {
|
||||
if ( self::$instance === null ) {
|
||||
self::$instance = new Jetpack_Subscription_Modal_On_Comment();
|
||||
}
|
||||
|
||||
return self::$instance;
|
||||
}
|
||||
|
||||
const BLOCK_TEMPLATE_PART_SLUG = 'jetpack-subscription-modal';
|
||||
|
||||
/**
|
||||
* Returns the block template part ID.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public static function get_block_template_part_id() {
|
||||
return get_stylesheet() . '//' . self::BLOCK_TEMPLATE_PART_SLUG;
|
||||
}
|
||||
|
||||
/**
|
||||
* Jetpack_Subscription_Modal_On_Comment class constructor.
|
||||
* Limited to Atomic sites.
|
||||
*/
|
||||
public function __construct() {
|
||||
if ( ( new Host() )->is_woa_site() && get_option( 'jetpack_verbum_subscription_modal', true ) ) {
|
||||
add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_assets' ) );
|
||||
add_action( 'wp_footer', array( $this, 'add_subscription_modal_to_frontend' ) );
|
||||
add_filter( 'get_block_template', array( $this, 'get_block_template_filter' ), 10, 3 );
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Enqueues JS to load modal.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function enqueue_assets() {
|
||||
if ( ! $this->should_user_see_modal() ) {
|
||||
return;
|
||||
}
|
||||
|
||||
wp_enqueue_style( 'subscription-modal-css', plugins_url( 'subscription-modal.css', __FILE__ ), array(), JETPACK__VERSION );
|
||||
wp_enqueue_script( 'subscription-modal-js', plugins_url( 'subscription-modal.js', __FILE__ ), array( 'wp-dom-ready' ), JETPACK__VERSION, true );
|
||||
wp_localize_script(
|
||||
'subscription-modal-js',
|
||||
'subscriptionData',
|
||||
array(
|
||||
'homeUrl' => wp_parse_url( home_url(), PHP_URL_HOST ),
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds modal with Subscribe Modal content.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function add_subscription_modal_to_frontend() {
|
||||
if ( $this->should_user_see_modal() ) { ?>
|
||||
<div class="jetpack-subscription-modal">
|
||||
<div class="jetpack-subscription-modal__modal-content">
|
||||
<?php block_template_part( self::BLOCK_TEMPLATE_PART_SLUG ); ?>
|
||||
</div>
|
||||
</div>
|
||||
<?php
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Makes get_block_template return the WP_Block_Template for the Subscribe Modal.
|
||||
*
|
||||
* @param WP_Block_Template $block_template The block template to be returned.
|
||||
* @param string $id Template unique identifier (example: theme_slug//template_slug).
|
||||
* @param string $template_type Template type: `'wp_template'` or '`wp_template_part'`.
|
||||
*
|
||||
* @return WP_Block_Template
|
||||
*/
|
||||
public function get_block_template_filter( $block_template, $id, $template_type ) {
|
||||
if ( empty( $block_template ) && $template_type === 'wp_template_part' ) {
|
||||
if ( $id === self::get_block_template_part_id() ) {
|
||||
return $this->get_template();
|
||||
}
|
||||
}
|
||||
|
||||
return $block_template;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a custom template for the Subscribe Modal.
|
||||
*
|
||||
* @return WP_Block_Template
|
||||
*/
|
||||
public function get_template() {
|
||||
$template = new WP_Block_Template();
|
||||
$template->theme = get_stylesheet();
|
||||
$template->slug = self::BLOCK_TEMPLATE_PART_SLUG;
|
||||
$template->id = self::get_block_template_part_id();
|
||||
$template->area = 'uncategorized';
|
||||
$template->content = $this->get_subscribe_template_content();
|
||||
$template->source = 'plugin';
|
||||
$template->type = 'wp_template_part';
|
||||
$template->title = __( 'Jetpack Subscription modal', 'jetpack' );
|
||||
$template->status = 'publish';
|
||||
$template->has_theme_file = false;
|
||||
$template->is_custom = true;
|
||||
$template->description = __( 'A subscribe form that submit a comment.', 'jetpack' );
|
||||
|
||||
return $template;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the initial content of the Subscribe Modal template.
|
||||
* This can then be edited by the user.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function get_subscribe_template_content() {
|
||||
// translators: %s is the name of the site.
|
||||
$discover_more_from = sprintf( __( 'Discover more from %s', 'jetpack' ), get_bloginfo( 'name' ) );
|
||||
$subscribe_text = __( 'Subscribe now to keep reading and get access to the full archive.', 'jetpack' );
|
||||
$continue_reading = __( 'Continue reading', 'jetpack' );
|
||||
|
||||
return <<<HTML
|
||||
<!-- wp:group {"style":{"spacing":{"top":"32px","bottom":"32px","left":"32px","right":"32px"},"margin":{"top":"0","bottom":"0"}},"border":{"color":"#dddddd","width":"1px"}},"layout":{"type":"constrained","contentSize":"450px"}} -->
|
||||
<div class="wp-block-group has-border-color jetpack-subscription-modal__modal-content-form" style="border-color:#dddddd;border-width:1px;margin-top:0;margin-bottom:0;padding:32px">
|
||||
|
||||
<!-- wp:heading {"textAlign":"center","style":{"typography":{"fontStyle":"normal","fontWeight":"600","fontSize":"26px"},"layout":{"selfStretch":"fit","flexSize":null},"spacing":{"margin":{"top":"4px","bottom":"10px"}}}} -->
|
||||
<h2 class="wp-block-heading has-text-align-center" style="margin-top:4px;margin-bottom:10px;font-size:26px;font-style:normal;font-weight:600">$discover_more_from</h2>
|
||||
<!-- /wp:heading -->
|
||||
|
||||
<!-- wp:paragraph {"align":"center","style":{"typography":{"fontSize":"15px"},"spacing":{"margin":{"top":"4px","bottom":"0px"}}}} -->
|
||||
<p class='has-text-align-center' style='margin-top:4px;margin-bottom:0px;font-size:15px'>$subscribe_text</p>
|
||||
<!-- /wp:paragraph -->
|
||||
|
||||
<!-- wp:jetpack/subscriptions {"borderRadius":50,"className":"is-style-compact","appSource":"atomic-subscription-modal-lo"} /-->
|
||||
|
||||
<!-- wp:paragraph {"align":"center","style":{"spacing":{"margin":{"top":"20px"}},"typography":{"fontSize":"14px"}},"className":"jetpack-subscription-modal__close"} -->
|
||||
<p class="has-text-align-center jetpack-subscription-modal__close" style="margin-top:20px;font-size:14px"><a href="#">$continue_reading</a></p>
|
||||
<!-- /wp:paragraph -->
|
||||
</div>
|
||||
<!-- /wp:group -->
|
||||
HTML;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns true if a site visitor should see
|
||||
* the Subscribe Modal.
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function should_user_see_modal() {
|
||||
// Only show when viewing frontend single post.
|
||||
if ( is_admin() || ! is_singular( 'post' ) ) {
|
||||
return false;
|
||||
}
|
||||
|
||||
// Don't show if post is for subscribers only or has paywall block
|
||||
global $post;
|
||||
if ( defined( 'Automattic\\Jetpack\\Extensions\\Subscriptions\\META_NAME_FOR_POST_LEVEL_ACCESS_SETTINGS' ) ) {
|
||||
$access_level = get_post_meta( $post->ID, META_NAME_FOR_POST_LEVEL_ACCESS_SETTINGS, true );
|
||||
} else {
|
||||
$access_level = get_post_meta( $post->ID, '_jetpack_newsletter_access', true );
|
||||
}
|
||||
require_once JETPACK__PLUGIN_DIR . 'extensions/blocks/premium-content/_inc/subscription-service/include.php';
|
||||
$is_accessible_by_everyone = Abstract_Token_Subscription_Service::POST_ACCESS_LEVEL_EVERYBODY === $access_level || empty( $access_level );
|
||||
|
||||
if ( ! $is_accessible_by_everyone ) {
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
Jetpack_Subscription_Modal_On_Comment::init();
|
||||
|
||||
add_action(
|
||||
'rest_api_switched_to_blog',
|
||||
function () {
|
||||
Jetpack_Subscription_Modal_On_Comment::init();
|
||||
}
|
||||
);
|
||||
+68
@@ -0,0 +1,68 @@
|
||||
.jetpack-subscription-modal {
|
||||
visibility: hidden;
|
||||
position: fixed;
|
||||
z-index: 50000;
|
||||
left: 0;
|
||||
top: 0;
|
||||
width: 100%;
|
||||
height: 100%;
|
||||
overflow: auto;
|
||||
opacity: 0;
|
||||
transition: visibility 0s, opacity 0.5s ease;
|
||||
display: flex;
|
||||
justify-content: space-evenly;
|
||||
align-content: center;
|
||||
flex-wrap: wrap;
|
||||
}
|
||||
|
||||
.jetpack-subscription-modal.open {
|
||||
opacity: 1;
|
||||
background-color: rgba(0,0,0,0.3);
|
||||
visibility: visible;
|
||||
}
|
||||
|
||||
.jetpack-subscription-modal__modal-content {
|
||||
text-align: center;
|
||||
background-color: #fefefe;
|
||||
width: 100%;
|
||||
max-width: 650px;
|
||||
box-sizing: border-box;
|
||||
transition: visibility 0s, opacity 0.3s linear;
|
||||
opacity: 0;
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
gap: 5px;
|
||||
justify-content: center;
|
||||
}
|
||||
|
||||
.jetpack-subscription-modal.open .jetpack-subscription-modal__modal-content {
|
||||
opacity: 1;
|
||||
top: 0;
|
||||
visibility: visible;
|
||||
}
|
||||
|
||||
/* Hide the modal content when iframe is present */
|
||||
.jetpack-subscription-modal.has-iframe .jetpack-subscription-modal__modal-content {
|
||||
background: transparent;
|
||||
}
|
||||
|
||||
.jetpack-subscription-modal.has-iframe .jetpack-subscription-modal__modal-content-form {
|
||||
visibility: hidden;
|
||||
opacity: 0;
|
||||
}
|
||||
|
||||
/*
|
||||
* These text-wrap properties still have limited browser
|
||||
* support, but based on feedback still adding them for when
|
||||
* they are supported.
|
||||
*/
|
||||
.jetpack-subscription-modal__modal-content p {
|
||||
text-wrap: pretty;
|
||||
text-wrap: pretty;
|
||||
}
|
||||
|
||||
@media screen and (max-width: 640px) {
|
||||
.jetpack-subscription-modal__modal-content {
|
||||
width: 94%;
|
||||
}
|
||||
}
|
||||
+146
@@ -0,0 +1,146 @@
|
||||
/* global subscriptionData */
|
||||
document.addEventListener( 'DOMContentLoaded', function () {
|
||||
const modal = document.getElementsByClassName( 'jetpack-subscription-modal' )[ 0 ];
|
||||
|
||||
if ( ! modal ) {
|
||||
return;
|
||||
}
|
||||
|
||||
const close = document.getElementsByClassName( 'jetpack-subscription-modal__close' )[ 0 ];
|
||||
|
||||
let redirectUrl = '';
|
||||
let hasLoaded = false;
|
||||
|
||||
function reloadOnCloseSubscriptionModal( customUrl ) {
|
||||
const destinationUrl = customUrl ? new URL( customUrl ) : new URL( redirectUrl );
|
||||
|
||||
// Prevent redirect to external sites.
|
||||
if ( destinationUrl.hostname !== window.location.hostname ) {
|
||||
return;
|
||||
}
|
||||
|
||||
try {
|
||||
localStorage.setItem(
|
||||
'jetpack-subscription-modal-on-comment-scroll-to',
|
||||
destinationUrl.hash
|
||||
);
|
||||
} catch {
|
||||
// Ok if we can't set it.
|
||||
}
|
||||
|
||||
// Add cache-busting parameter
|
||||
destinationUrl.searchParams.set( '_ctn', Date.now() );
|
||||
window.location.href = destinationUrl.toString();
|
||||
}
|
||||
|
||||
function JetpackSubscriptionModalOnCommentMessageListener( event ) {
|
||||
let message = event && event.data;
|
||||
if ( typeof message === 'string' ) {
|
||||
try {
|
||||
message = JSON.parse( message );
|
||||
} catch {
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
const type = message && message.type;
|
||||
const data = message && message.data;
|
||||
|
||||
if ( type !== 'subscriptionModalShow' || typeof data.url === 'undefined' ) {
|
||||
return;
|
||||
}
|
||||
|
||||
if ( subscriptionData.homeUrl !== event.origin ) {
|
||||
return;
|
||||
}
|
||||
|
||||
if ( data.email ) {
|
||||
const emailInput = document.querySelector(
|
||||
'.jetpack-subscription-modal__modal-content input[type=email]'
|
||||
);
|
||||
if ( ! emailInput ) {
|
||||
reloadOnCloseSubscriptionModal( data.url );
|
||||
return;
|
||||
}
|
||||
|
||||
const appSource = document.querySelector(
|
||||
'.jetpack-subscription-modal__modal-content input[name=app_source]'
|
||||
);
|
||||
if ( ! appSource ) {
|
||||
reloadOnCloseSubscriptionModal( data.url );
|
||||
return;
|
||||
}
|
||||
|
||||
emailInput.value = data.email;
|
||||
if ( data.is_logged_in ) {
|
||||
emailInput.setAttribute( 'readonly', 'readonly' );
|
||||
appSource.value = 'atomic-subscription-modal-li';
|
||||
}
|
||||
}
|
||||
|
||||
if ( ! hasLoaded ) {
|
||||
try {
|
||||
const storedCount = parseInt(
|
||||
sessionStorage.getItem( 'jetpack-subscription-modal-shown-count' )
|
||||
);
|
||||
const showCount = ( isNaN( storedCount ) ? 0 : storedCount ) + 1;
|
||||
sessionStorage.setItem( 'jetpack-subscription-modal-shown-count', showCount );
|
||||
|
||||
if ( showCount > 5 ) {
|
||||
new Image().src =
|
||||
document.location.protocol +
|
||||
'//pixel.wp.com/g.gif?v=wpcom-no-pv&x_jetpack-subscribe-modal-comm=hidden_views_limit&r=' +
|
||||
Math.random();
|
||||
|
||||
reloadOnCloseSubscriptionModal( data.url );
|
||||
return;
|
||||
}
|
||||
} catch {
|
||||
// Ignore any errors.
|
||||
}
|
||||
|
||||
new Image().src =
|
||||
document.location.protocol +
|
||||
'//pixel.wp.com/g.gif?v=wpcom-no-pv&x_jetpack-subscribe-modal-comm=showed&r=' +
|
||||
Math.random();
|
||||
|
||||
modal.classList.toggle( 'open' );
|
||||
hasLoaded = true;
|
||||
redirectUrl = data.url;
|
||||
}
|
||||
}
|
||||
|
||||
window.addEventListener( 'message', JetpackSubscriptionModalOnCommentMessageListener );
|
||||
|
||||
if ( close ) {
|
||||
close.onclick = function ( event ) {
|
||||
event.preventDefault();
|
||||
modal.classList.toggle( 'open' );
|
||||
reloadOnCloseSubscriptionModal();
|
||||
};
|
||||
}
|
||||
|
||||
window.onclick = function ( event ) {
|
||||
if ( event.target === modal ) {
|
||||
modal.style.display = 'none';
|
||||
reloadOnCloseSubscriptionModal();
|
||||
}
|
||||
};
|
||||
|
||||
window.addEventListener( 'load', () => {
|
||||
// Scroll to the last comment.
|
||||
const subscriptionScroll = localStorage.getItem(
|
||||
'jetpack-subscription-modal-on-comment-scroll-to'
|
||||
);
|
||||
|
||||
if ( subscriptionScroll ) {
|
||||
window.location.hash = subscriptionScroll;
|
||||
localStorage.removeItem( 'jetpack-subscription-modal-on-comment-scroll-to' );
|
||||
|
||||
const comment = document.querySelector( subscriptionScroll );
|
||||
if ( comment ) {
|
||||
comment.scrollIntoView( { block: 'center', behavior: 'smooth' } );
|
||||
}
|
||||
}
|
||||
} );
|
||||
} );
|
||||
Reference in New Issue
Block a user