484 lines
14 KiB
PHP
484 lines
14 KiB
PHP
<?php
|
|
|
|
// =============================================================================
|
|
// CUSTOM AVATAR
|
|
// =============================================================================
|
|
|
|
if ( ! function_exists( 'fictioneer_get_custom_avatar_url' ) ) {
|
|
/**
|
|
* Get custom avatar URL
|
|
*
|
|
* @since 4.0.0
|
|
*
|
|
* @param WP_User $user The user to get the avatar for.
|
|
*
|
|
* @return string|boolean The custom avatar URL or false.
|
|
*/
|
|
|
|
function fictioneer_get_custom_avatar_url( $user ) {
|
|
// Override default avatar with external avatar if allowed
|
|
if ( $user && is_object( $user ) && ! $user->fictioneer_enforce_gravatar ) {
|
|
$avatar_url = empty( $user->fictioneer_external_avatar_url ) ? null : $user->fictioneer_external_avatar_url;
|
|
|
|
if ( ! empty( $avatar_url ) ) {
|
|
return $avatar_url;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Filter the avatar URL
|
|
*
|
|
* @since 4.0.0
|
|
*
|
|
* @param string $url The default URL by WordPress.
|
|
* @param int|string $id_or_email User ID or email address.
|
|
* @param WP_User $args Additional arguments.
|
|
*
|
|
* @return string The avatar URL.
|
|
*/
|
|
|
|
function fictioneer_get_avatar_url( $url, $id_or_email, $args ) {
|
|
// Abort conditions...
|
|
if ( ( $args['force_default'] ?? false ) || empty( $id_or_email ) ) {
|
|
return $url;
|
|
}
|
|
|
|
// Setup
|
|
$user = fictioneer_get_user_by_id_or_email( $id_or_email );
|
|
$custom_avatar = fictioneer_get_custom_avatar_url( $user );
|
|
|
|
// Check user and permissions
|
|
if ( $user ) {
|
|
$user_disabled = $user->fictioneer_disable_avatar;
|
|
$admin_disabled = $user->fictioneer_admin_disable_avatar;
|
|
|
|
if ( $user_disabled || $admin_disabled ) {
|
|
return false;
|
|
}
|
|
} else {
|
|
return $url;
|
|
}
|
|
|
|
// Return custom avatar if set
|
|
if ( ! empty( $custom_avatar ) ) {
|
|
return $custom_avatar;
|
|
}
|
|
|
|
// Return default avatar
|
|
return $url;
|
|
};
|
|
add_filter( 'get_avatar_url', 'fictioneer_get_avatar_url', 10, 3 );
|
|
|
|
// =============================================================================
|
|
// FALLBACK AVATAR
|
|
// =============================================================================
|
|
|
|
if ( ! function_exists( 'fictioneer_get_default_avatar_url' ) ) {
|
|
/**
|
|
* Returns the default avatar URL
|
|
*
|
|
* @since 5.5.3
|
|
*
|
|
* @return string Default avatar URL.
|
|
*/
|
|
|
|
function fictioneer_get_default_avatar_url() {
|
|
$transient = get_transient( 'fictioneer_default_avatar' );
|
|
|
|
// Check Transient
|
|
if (
|
|
empty( $transient ) ||
|
|
! is_array( $transient ) ||
|
|
$transient['timestamp'] + DAY_IN_SECONDS < time()
|
|
) {
|
|
// Get default avatar (and avoid infinite loop)
|
|
remove_filter( 'get_avatar_url', 'fictioneer_get_avatar_url' );
|
|
$default_url = get_avatar_url( 'nonexistentemail@example.com' );
|
|
add_filter( 'get_avatar_url', 'fictioneer_get_avatar_url', 10, 3 );
|
|
|
|
$transient = array(
|
|
'url' => $default_url,
|
|
'timestamp' => time()
|
|
);
|
|
|
|
set_transient( 'fictioneer_default_avatar', $transient );
|
|
} else {
|
|
$default_url = $transient['url'];
|
|
}
|
|
|
|
return $default_url;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Add fallback inline script to avatars
|
|
*
|
|
* @since 5.0.0
|
|
*
|
|
* @param string $avatar HTML for the avatar.
|
|
* @param string $id_or_email ID or email of the user.
|
|
*
|
|
* @return string HTML with fallback script added.
|
|
*/
|
|
|
|
function fictioneer_avatar_fallback( $avatar, $id_or_email ) {
|
|
$default_url = fictioneer_get_default_avatar_url();
|
|
|
|
return str_replace( '<img', '<img onerror="this.src=\'' . $default_url . '\';this.srcset=\'\';this.onerror=\'\';"', $avatar );
|
|
}
|
|
add_filter( 'get_avatar', 'fictioneer_avatar_fallback', 1, 2 );
|
|
|
|
// =============================================================================
|
|
// GET COMMENT BADGE
|
|
// =============================================================================
|
|
|
|
if ( ! function_exists( 'fictioneer_get_comment_badge' ) ) {
|
|
/**
|
|
* Get HTML for comment badge
|
|
*
|
|
* @since 5.0.0
|
|
*
|
|
* @param WP_User|null $user The comment user.
|
|
* @param WP_Comment|null $comment Optional. The comment object.
|
|
* @param int $post_author_id Optional. ID of the author of the post
|
|
* the comment is for.
|
|
*
|
|
* @return string Badge HTML or empty string.
|
|
*/
|
|
|
|
function fictioneer_get_comment_badge( $user, $comment = null, $post_author_id = 0 ) {
|
|
// Pre-setup
|
|
$user_id = $user ? $user->ID : 0;
|
|
$filter_args = array(
|
|
'comment' => $comment,
|
|
'post_author_id' => $post_author_id
|
|
);
|
|
|
|
// Abort conditions...
|
|
if ( empty( $user_id ) || get_the_author_meta( 'fictioneer_hide_badge', $user_id ) ) {
|
|
$filter_args['class'] = 'is-guest';
|
|
$filter_args['badge'] = '';
|
|
|
|
return apply_filters( 'fictioneer_filter_comment_badge', '', $user, $filter_args );
|
|
}
|
|
|
|
// Setup
|
|
$is_post_author = empty( $comment ) ? false : $comment->user_id == $post_author_id;
|
|
$is_moderator = fictioneer_is_moderator( $user_id );
|
|
$is_admin = fictioneer_is_admin( $user_id );
|
|
$badge_body = '<div class="fictioneer-comment__badge %1$s">%2$s</div>';
|
|
$badge_class = '';
|
|
$badge = '';
|
|
$role_has_badge = user_can( $user_id, 'fcn_show_badge' );
|
|
|
|
// Role badge
|
|
if ( $role_has_badge ) {
|
|
if ( $is_post_author ) {
|
|
$badge = fcntr( 'author' );
|
|
$badge_class = 'is-author';
|
|
} elseif ( $is_admin ) {
|
|
$badge = fcntr( 'admin' );
|
|
$badge_class = 'is-admin';
|
|
} elseif ( $is_moderator ) {
|
|
$badge = fcntr( 'moderator' );
|
|
$badge_class = 'is-moderator';
|
|
} elseif ( ! empty( $user->roles ) ) {
|
|
global $wp_roles;
|
|
|
|
$role_slug = $user->roles[0] ?? '';
|
|
$role = $wp_roles->roles[ $role_slug ];
|
|
|
|
if ( ! empty( $role_slug ) ) {
|
|
$badge = $role['name'];
|
|
$badge_class = "is-{$role_slug}";
|
|
}
|
|
}
|
|
}
|
|
|
|
// Patreon badge (if no higher badge set yet)
|
|
if ( empty( $badge ) ) {
|
|
$badge = fictioneer_get_patreon_badge( $user );
|
|
$badge_class = 'is-supporter';
|
|
}
|
|
|
|
// Custom badge (can override all)
|
|
if (
|
|
get_option( 'fictioneer_enable_custom_badges' ) &&
|
|
! get_the_author_meta( 'fictioneer_disable_badge_override', $user_id )
|
|
) {
|
|
$custom_badge = fictioneer_get_override_badge( $user );
|
|
|
|
if ( $custom_badge ) {
|
|
$badge = $custom_badge;
|
|
$badge_class = 'badge-override';
|
|
}
|
|
}
|
|
|
|
// Apply filters
|
|
$output = empty( $badge ) ? '' : sprintf( $badge_body, $badge_class, $badge );
|
|
|
|
$filter_args['class'] = $badge_class;
|
|
$filter_args['badge'] = $badge;
|
|
|
|
$output = apply_filters( 'fictioneer_filter_comment_badge', $output, $user, $filter_args );
|
|
|
|
// Return badge or empty sting
|
|
return $output;
|
|
}
|
|
}
|
|
|
|
// =============================================================================
|
|
// GET CUSTOM BADGE
|
|
// =============================================================================
|
|
|
|
if ( ! function_exists( 'fictioneer_get_override_badge' ) ) {
|
|
/**
|
|
* Get an user's custom badge (if any)
|
|
*
|
|
* @since 4.0.0
|
|
*
|
|
* @param WP_User $user The user.
|
|
* @param string|boolean $default Default value or false.
|
|
*
|
|
* @return string|boolean The badge label, default, or false.
|
|
*/
|
|
|
|
function fictioneer_get_override_badge( $user, $default = false ) {
|
|
// Abort conditions...
|
|
if (
|
|
! $user ||
|
|
get_the_author_meta( 'fictioneer_hide_badge', $user->ID )
|
|
) {
|
|
return $default;
|
|
}
|
|
|
|
// Setup
|
|
$badge = get_the_author_meta( 'fictioneer_badge_override', $user->ID );
|
|
|
|
// Return badge of found and not disabled
|
|
if ( $badge && ! get_the_author_meta( 'fictioneer_disable_badge_override', $user->ID ) ) {
|
|
return $badge;
|
|
}
|
|
|
|
// Return default
|
|
return $default;
|
|
}
|
|
}
|
|
|
|
// =============================================================================
|
|
// PATREON
|
|
// =============================================================================
|
|
|
|
if ( ! function_exists( 'fictioneer_get_patreon_badge' ) ) {
|
|
/**
|
|
* Get an user's Patreon badge (if any)
|
|
*
|
|
* @since 5.0.0
|
|
*
|
|
* @param WP_User $user The user.
|
|
* @param string|boolean $default Default value or false.
|
|
*
|
|
* @return string|boolean The badge label, default, or false.
|
|
*/
|
|
|
|
function fictioneer_get_patreon_badge( $user, $default = false ) {
|
|
// Abort conditions...
|
|
if ( ! $user ) {
|
|
return $default;
|
|
}
|
|
|
|
// Check if still valid if not empty
|
|
if ( fictioneer_patreon_tiers_valid( $user ) ) {
|
|
$label = get_option( 'fictioneer_patreon_label' );
|
|
|
|
return empty( $label ) ? _x( 'Patron', 'Default Patreon supporter badge label.', 'fictioneer' ) : $label;
|
|
}
|
|
|
|
return $default;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Checks whether the user's Patreon data is still valid
|
|
*
|
|
* Note: Patreon data expires after a set amount of time, one week
|
|
* by default defined as FICTIONEER_PATREON_EXPIRATION_TIME.
|
|
*
|
|
* @since 5.15.0
|
|
*
|
|
* @param int|WP_User|null $user The user object or user ID. Defaults to current user.
|
|
*
|
|
* @return boolean True if still valid, false if expired.
|
|
*/
|
|
|
|
function fictioneer_patreon_tiers_valid( $user = null ) {
|
|
// Setup
|
|
$user = $user ?? wp_get_current_user();
|
|
$user_id = is_numeric( $user ) ? $user : $user->ID;
|
|
|
|
// Abort conditions...
|
|
if ( ! $user_id ) {
|
|
return apply_filters( 'fictioneer_filter_user_patreon_validation', false, $user_id, [] );
|
|
}
|
|
|
|
// Setup
|
|
$patreon_tiers = get_user_meta( $user_id, 'fictioneer_patreon_tiers', true );
|
|
$patreon_tiers = is_array( $patreon_tiers ) ? $patreon_tiers : [];
|
|
$last_updated = empty( $patreon_tiers ) ? 0 : ( reset( $patreon_tiers )['timestamp'] ?? 0 );
|
|
|
|
// Check
|
|
$valid = current_time( 'U', true ) <= ( $last_updated + FICTIONEER_PATREON_EXPIRATION_TIME );
|
|
|
|
// Filter and return
|
|
return apply_filters( 'fictioneer_filter_user_patreon_validation', $valid, $user_id, $patreon_tiers );
|
|
}
|
|
|
|
/**
|
|
* Returns Patreon data of the user
|
|
*
|
|
* @since 5.17.0
|
|
*
|
|
* @param int|WP_User|null $user The user object or user ID. Defaults to current user.
|
|
*
|
|
* @return array Empty array if not a patron, associative array otherwise. Includes the
|
|
* keys 'valid', 'lifetime_support_cents', 'last_charge_date',
|
|
* 'last_charge_status', 'next_charge_date', 'patron_status', and 'tiers'.
|
|
* Tiers is an array of tiers with the keys 'id', 'title', 'description',
|
|
* 'published', 'amount_cents', and 'timestamp'.
|
|
*/
|
|
|
|
function fictioneer_get_user_patreon_data( $user = null ) {
|
|
// Setup
|
|
$user = $user ?? wp_get_current_user();
|
|
$user_id = is_numeric( $user ) ? $user : $user->ID;
|
|
|
|
// Get meta data
|
|
$membership = get_user_meta( $user_id, 'fictioneer_patreon_membership', true );
|
|
$membership = is_array( $membership ) ? $membership : [];
|
|
|
|
if ( $membership ) {
|
|
$tiers = get_user_meta( $user_id, 'fictioneer_patreon_tiers', true );
|
|
$membership['tiers'] = is_array( $tiers ) ? $tiers : [];
|
|
$membership['valid'] = fictioneer_patreon_tiers_valid( $user_id );
|
|
}
|
|
|
|
// Return
|
|
return $membership;
|
|
}
|
|
|
|
// =============================================================================
|
|
// GET UNIQUE USER FINGERPRINT
|
|
// =============================================================================
|
|
|
|
if ( ! function_exists( 'fictioneer_get_user_fingerprint' ) ) {
|
|
/**
|
|
* Returns an unique MD5 hash for the user
|
|
*
|
|
* In order to differentiate users on the frontend even if they have the same
|
|
* display name (which is possible) but without exposing any sensitive data,
|
|
* a simple cryptic hash is calculated.
|
|
*
|
|
* @since 4.7.0
|
|
*
|
|
* @param int $user_id User ID to get the hash for.
|
|
*
|
|
* @return string The unique fingerprint hash or empty string if not found.
|
|
*/
|
|
|
|
function fictioneer_get_user_fingerprint( $user_id ) {
|
|
// Setup
|
|
$user = get_user_by( 'ID', $user_id );
|
|
|
|
if ( ! $user ) {
|
|
return '';
|
|
}
|
|
|
|
$fingerprint = get_user_meta( $user_id, 'fictioneer_user_fingerprint', true );
|
|
|
|
// If hash does not yet exist, create one
|
|
if ( empty( $fingerprint ) ) {
|
|
$fingerprint = md5( $user->user_login . $user_id );
|
|
update_user_meta( $user_id, 'fictioneer_user_fingerprint', $fingerprint );
|
|
}
|
|
|
|
// Return hash
|
|
return $fingerprint;
|
|
}
|
|
}
|
|
|
|
// =============================================================================
|
|
// DELETE USER COMMENTS
|
|
// =============================================================================
|
|
|
|
if ( ! function_exists( 'fictioneer_soft_delete_user_comments' ) ) {
|
|
/**
|
|
* Soft delete a user's comments
|
|
*
|
|
* Replace the content and meta data of a user's comments with junk
|
|
* but leave the comment itself in the database. This preserves the
|
|
* structure of comment threads.
|
|
*
|
|
* @since 5.0.0
|
|
*
|
|
* @param int $user_id User ID to soft delete the comments for.
|
|
*
|
|
* @return array|false Detailed results about the database update. Accounts
|
|
* for completeness, partial success, and errors. Includes
|
|
* 'complete' (boolean), 'failure' (boolean), 'success' (boolean),
|
|
* 'comment_count' (int), and 'updated_count' (int). Or false.
|
|
*/
|
|
|
|
function fictioneer_soft_delete_user_comments( $user_id ) {
|
|
// Setup
|
|
$comments = get_comments( array( 'user_id' => $user_id ) );
|
|
$comment_count = count( $comments );
|
|
$count = 0;
|
|
$complete_one = true;
|
|
|
|
// Not found or empty
|
|
if ( empty( $comments ) ) {
|
|
return false;
|
|
}
|
|
|
|
// Loop and update comments
|
|
foreach ( $comments as $comment ) {
|
|
$result_one = wp_update_comment(
|
|
array(
|
|
'user_ID' => 0,
|
|
'comment_type' => 'user_deleted',
|
|
'comment_author' => _x( 'Deleted', 'Deleted comment author name.', 'fictioneer' ),
|
|
'comment_ID' => $comment->comment_ID,
|
|
'comment_content' => __( 'Comment has been deleted by user.', 'fictioneer' ),
|
|
'comment_author_email' => '',
|
|
'comment_author_IP' => '',
|
|
'comment_agent' => '',
|
|
'comment_author_url' => ''
|
|
)
|
|
);
|
|
|
|
// Keep track of updated comments
|
|
if ( $result_one ) {
|
|
$count++;
|
|
}
|
|
|
|
// Check whether one or more updates failed
|
|
if ( ! $result_one || is_wp_error( $result_one ) ) {
|
|
$complete_one = false;
|
|
}
|
|
}
|
|
|
|
// Report result
|
|
return array(
|
|
'complete' => $complete_one,
|
|
'failure' => $count == 0,
|
|
'success' => $count == $comment_count && $complete_one,
|
|
'comment_count' => $comment_count,
|
|
'updated_count' => $count
|
|
);
|
|
}
|
|
}
|