reactions_dir ) . trim( $path, '/\\' );
}
/**
* Return the reaction url.
*
* @since 2.4.50
*
* @param string $path url of reaction.
*
* @return string url.
*/
function bb_reaction_url( $path = '' ) {
return trailingslashit( bb_platform_pro()->reactions_url ) . trim( $path, '/\\' );
}
/**
* Get reaction posts and settings.
*
* @since 2.4.50
*
* @param string $mode Reaction mode 'likes', 'emotions'. Default is 'likes'.
* @param bool $is_active Fetch all active reactions. Default is true.
*
* @return array Get list of saved reaction post.
*/
function bb_pro_get_reactions( $mode = 'likes', $is_active = true ) {
if ( ! function_exists( 'bb_load_reaction' ) ) {
return array();
}
return apply_filters( 'bb_pro_get_reactions', bb_load_reaction()->bb_get_reactions( $mode, $is_active ) );
}
/**
* Include template for reaction > emotions field markup.
*
* @since 2.4.50
*
* @return void
*/
function bb_admin_setting_reaction_emotions_field_callback() {
require bb_reaction_path( 'templates/admin/emotion-options.php' );
}
/**
* Include template for reaction > emotions notice field markup.
*
* @since 2.4.50
*
* @param string $print Return type. Default true.
*
* @return void|string
*/
function bb_admin_setting_reaction_notice_field_callback( $print = true ) {
static $html = '';
if ( bb_pro_is_heartbeat() ) {
return $html;
}
if ( empty( $html ) ) {
ob_start();
$status = bb_pro_reaction_get_migration_status();
$migration_data = bb_pro_reaction_get_migration_action();
if (
! empty( $migration_data ) &&
! empty( $migration_data['action'] )
) {
if (
! empty( $status ) &&
'completed' === $status
) {
if ( 'like_to_emotions_action' === $migration_data['action'] ) {
printf(
'',
sprintf(
__( '%1$s were successfully converted to the %2$s emotion.', 'buddyboss-pro' ),
sprintf(
'' . bp_core_number_format( $migration_data['total_reactions'] ) . ' %s ',
$migration_data['from_emotions_name']
),
'' . $migration_data['to_emotions_name'] . ' ' // @todo Update emotion name.
)
);
} elseif ( 'emotions_to_like_action' === $migration_data['action'] ) {
printf(
'',
sprintf(
__( '%1$s reactions were successfully converted %2$s.', 'buddyboss-pro' ),
'' . bp_core_number_format( $migration_data['total_reactions'] ) . ' ',
'' . $migration_data['to_emotions_name'] . ' '
)
);
} elseif ( in_array( $migration_data['action'], array( 'emotions', 'likes' ), true ) ) {
printf(
'',
sprintf(
__( '%1$s reactions were successfully converted %2$s.', 'buddyboss-pro' ),
'' . bp_core_number_format( $migration_data['total_reactions'] ) . ' ',
'' . $migration_data['to_emotions_name'] . ' '
)
);
}
// Delete transient to avoid display notice again if page is reactions settings tab.
$page = isset( $_GET['page'] ) ? sanitize_text_field( $_GET['page'] ) : '';
$tab = isset( $_GET['tab'] ) ? sanitize_text_field( $_GET['tab'] ) : '';
if ( is_admin() && 'bp-settings' === $page && 'bp-reactions' === $tab ) {
bp_delete_option( 'bb_pro_reaction_migration_completed' );
bb_pro_reaction_delete_migration();
}
} elseif (
! empty( $status ) &&
'inprogress' === $status
) {
$total = (int) $migration_data['total_reactions'];
$updated_emotions = (int) ( $migration_data['updated_emotions'] ?? 0 );
$percentage = ! empty( $total ) ? ceil( ( $updated_emotions * 100 ) / $total ) : 0;
printf(
'',
// @todo counts based on migration.
sprintf(
__( '%1$s out of %2$s %3$s reactions have been converted', 'buddyboss-pro' ),
bp_core_number_format( $updated_emotions ),
bp_core_number_format( $total ),
'(' . $percentage . '%)'
),
__( 'This action is being performed in the background, but may take some time based on the amount of data.', 'buddyboss-pro' ),
__( 'Recheck status', 'buddyboss-pro' ),
__( 'Stop', 'buddyboss-pro' )
);
} else {
// Check the current user set 'Do Later', then hide it.
$hide_for = ! empty( $migration_data['hide_for'] ) ? $migration_data['hide_for'] : array();
if (
in_array( $migration_data['action'], array( 'like_to_emotions_action', 'emotions_to_like_action' ), true ) &&
! in_array( get_current_user_id(), $hide_for, true )
) {
$migration_notice = '';
if ( 'like_to_emotions_action' === $migration_data['action'] ) {
$migration_notice = sprintf(
'%1$s
%2$s
',
__( 'Do you want to convert your existing Likes to an Emotion?', 'buddyboss-pro' ),
sprintf(
__( 'You have %s Likes previously submitted on your site which can be converted to an Emotion.', 'buddyboss-pro' ),
'' . bp_core_number_format( $migration_data['total_reactions'] ) . ' '
)
);
} elseif ( 'emotions_to_like_action' === $migration_data['action'] ) {
$migration_notice = sprintf(
'%1$s
%2$s
',
__( 'Do you want to convert your existing reactions to Likes?', 'buddyboss-pro' ),
sprintf(
__( 'You have %s reactions previously submitted on your site which can be converted to Likes.', 'buddyboss-pro' ),
'' . bp_core_number_format( $migration_data['total_reactions'] ) . ' '
)
);
}
if ( ! empty( $migration_notice ) ) {
printf(
'',
$migration_notice,
__( 'Start conversion', 'buddyboss-pro' ),
__( 'Do later', 'buddyboss-pro' )
);
}
}
}
}
$html = ob_get_contents();
ob_end_clean();
}
if ( $print ) {
echo $html;
} else {
return $html;
}
}
/**
* Return reaction icon types.
*
* @since 2.4.50
*
* @return array
*/
function bb_reactions_icon_types() {
return apply_filters(
'bb_reactions_icon_types',
array(
array(
'label' => esc_html__( 'Emojis', 'buddyboss-pro' ),
'value' => 'emotions',
),
array(
'label' => esc_html__( 'Icons', 'buddyboss-pro' ),
'value' => 'bb-icons',
),
array(
'label' => esc_html__( 'Custom', 'buddyboss-pro' ),
'value' => 'custom',
),
)
);
}
/**
* Return reaction icons for given icon type.
*
* @since 2.4.50
*
* @param string $type Type of reaction icon.
*
* @return array Array of reaction icons
*/
function bb_get_default_reaction_icons( $type = 'bb-icons' ) {
$bb_emotion = BB_Reactions_Picker::instance();
$icons = array();
switch ( $type ) {
case 'emotions':
$icons = $bb_emotion->bb_get_emojis_list();
break;
case 'bb-icons':
$icons = $bb_emotion->bb_icon_font_map( 'glyphs' );
break;
case 'custom':
$icons = $bb_emotion->bb_custom_icon_list();
break;
}
return apply_filters( 'bb_get_default_reaction_icons', $icons, $type );
}
/**
* Return default reaction data.
*
* @since 2.4.50
*
* @return array
*/
function bb_pro_get_reaction_default_data() {
return apply_filters(
'bb_pro_get_reaction_default_data',
array(
array(
'name' => 'thumbs-up',
'icon' => 'thumbs-up',
'type' => 'bb-icons',
'icon_text' => 'Like',
'icon_color' => '#3379f6',
'text_color' => '#000000',
'notification_text' => '',
'icon_path' => '',
'mode' => 'emotions',
'is_emotion_active' => true,
),
array(
'name' => 'red heart',
'icon' => '2764-fe0f',
'type' => 'emotions',
'icon_text' => 'Love',
'icon_color' => '#000000',
'text_color' => '#000000',
'notification_text' => '',
'icon_path' => 'https://cdn.jsdelivr.net/gh/twitter/twemoji@latest/assets/svg/2764.svg',
'mode' => 'emotions',
'is_emotion_active' => true,
),
array(
'name' => 'face with tears of joy',
'icon' => '1f602',
'type' => 'emotions',
'icon_text' => 'Laugh',
'icon_color' => '#000000',
'text_color' => '#000000',
'notification_text' => '',
'icon_path' => 'https://cdn.jsdelivr.net/gh/twitter/twemoji@latest/assets/svg/1f602.svg',
'mode' => 'emotions',
'is_emotion_active' => true,
),
array(
'name' => 'angry face',
'icon' => '1f620',
'type' => 'emotions',
'icon_text' => 'Angry',
'icon_color' => '#000000',
'text_color' => '#000000',
'notification_text' => '',
'icon_path' => 'https://cdn.jsdelivr.net/gh/twitter/twemoji@latest/assets/svg/1f620.svg',
'mode' => 'emotions',
'is_emotion_active' => true,
),
array(
'name' => 'sad but relieved face',
'icon' => '1f625',
'type' => 'emotions',
'icon_text' => 'Sad',
'icon_color' => '#000000',
'text_color' => '#000000',
'notification_text' => '',
'icon_path' => 'https://cdn.jsdelivr.net/gh/twitter/twemoji@latest/assets/svg/1f625.svg',
'mode' => 'emotions',
'is_emotion_active' => true,
),
array(
'name' => 'face with open mouth',
'icon' => '1f62e',
'type' => 'emotions',
'icon_text' => 'Wow',
'icon_color' => '#000000',
'text_color' => '#000000',
'notification_text' => '',
'icon_path' => 'https://cdn.jsdelivr.net/gh/twitter/twemoji@latest/assets/svg/1f62e.svg',
'mode' => 'emotions',
'is_emotion_active' => true,
),
)
);
}
/**
* Function to prepare the screen when no emotion data exists for migration.
*
* @since 2.4.50
*
* @param string $reaction_mode The mode of reaction.
*
* @return string
*/
function bb_pro_reaction_get_no_data_screen( $reaction_mode ) {
ob_start();
?>
%s',
__( 'You have no reactions to convert', 'buddyboss-pro' )
);
if ( 'emotions' === $reaction_mode ) {
echo sprintf(
'%s
',
__( 'Unable to find any existing reactions to convert to an Emotion.', 'buddyboss-pro' )
);
} elseif ( 'likes' === $reaction_mode ) {
echo sprintf(
'%s
',
__( 'Unable to find any existing reactions to convert to Likes.', 'buddyboss-pro' )
);
}
return ob_get_clean();
}
/**
* Function to return the migration wizard.
*
* @sicne 2.4.50
*
* @param array $args Array of reaction actions.
*
* @return array Array of reaction migration screens HTML.
*/
function bb_pro_reaction_get_migration_wizard( $args = array() ) {
$r = bp_parse_args(
$args,
array(
'action_type' => '',
'reaction_mode' => bb_get_reaction_mode(),
)
);
// Prepare likes.
$likes = current( bb_pro_get_reactions() );
$likes['count'] = bb_load_reaction()->bb_get_user_reactions_count( array( 'reaction_id' => $likes['id'] ) );
// Prepare emotions.
$emotions = bb_pro_get_reactions( 'emotions', false );
$total_emotion_count = 0;
if ( ! empty( $emotions ) ) {
foreach ( $emotions as $reaction_key => $reaction ) {
// Fetch total count.
$total_count = bb_load_reaction()->bb_get_user_reactions_count( array( 'reaction_id' => $reaction['id'] ) );
$emotions[ $reaction_key ]['count'] = $total_count;
$total_emotion_count = $total_emotion_count + $total_count;
}
}
$total_reaction_count = (int) $total_emotion_count + $likes['count'];
switch ( $r['action_type'] ) {
case 'footer_wizard':
if ( 0 < $total_reaction_count && 'emotions' === $r['reaction_mode'] ) {
ob_start();
?>
%2$s',
esc_attr( $emotion['id'] ),
esc_html( $emotion['icon_text'] )
);
}
}
?>
%s ',
__( 'Likes', 'buddyboss-pro' )
)
);
?>
%1$s %2$s',
bp_core_number_format( $likes['count'] ),
__( 'Likes', 'buddyboss-pro' )
)
);
?>
%1$s %2$s',
bp_core_number_format( $likes['count'] ),
__( 'Likes', 'buddyboss-pro' )
),
'
$wizard_screen1,
'wizard_screen2' => $wizard_screen2,
);
}
/**
* Register a new background job.
*
* @sicne 2.4.50
*
* @param string|int|array $migrate_from_ids Migrate from IDs with comma seperated.
* @param string|int $migrate_to_id Migrate to ID.
* @param string $job_from Where is coming from this job.
* @param string $job_type Job type.
*
* @return void
*/
function bb_pro_reaction_dispatch_migration( $migrate_from_ids, $migrate_to_id, $job_from = 'settings_change', $job_type = 'dispatch' ) {
global $bb_reaction_background_process;
if ( 'dispatch' !== $job_type && $bb_reaction_background_process->is_cancelled() ) {
return;
}
$background_args = array(
'type' => 'migrate_reactions',
'group' => 'bb_pro_migrate_reactions',
'callback' => 'bb_pro_migrate_reactions_callback',
'args' => array( $migrate_from_ids, $migrate_to_id, $job_from ),
'priority' => 5,
);
// Set variable to show notice after completed the migration.
$is_reaction_migration = true;
// When found delete action, then set background args.
if ( 'delete' === $migrate_to_id ) {
$background_args['args'] = array( $migrate_from_ids, 'delete', $job_from );
$background_args['priority'] = 10;
$background_args['secondary_data_id'] = 'delete';
// Set variable to do not show notice after completed the migration for delete the reactions.
$is_reaction_migration = false;
}
if ( 'dispatch' === $job_type ) {
bp_update_option( 'is_reaction_migration', $is_reaction_migration );
$bb_reaction_background_process->data( $background_args )->save()->dispatch();
} else {
$bb_reaction_background_process->data( $background_args )->save()->schedule_event();
}
}
/**
* Migration callback function.
*
* @sicne 2.4.50
*
* @param string|int|array $migrate_from_ids Migrate from IDs with comma seperated.
* @param string|int $migrate_to_id Migrate to ID.
* @param string $job_from Where is coming from this job.
*
* @return void
*/
function bb_pro_migrate_reactions_callback( $migrate_from_ids, $migrate_to_id, $job_from ) {
global $wpdb, $bb_reaction_background_process;
$migrate_from_ids = wp_parse_id_list( $migrate_from_ids );
$migrate_to_id = ( 'delete' === $migrate_to_id ) ? $migrate_to_id : current( wp_parse_id_list( $migrate_to_id ) );
$from_ids_in = implode( ',', wp_parse_id_list( $migrate_from_ids ) );
$migration_data = bb_pro_reaction_get_migration_action();
$limit = (int) apply_filters( 'bb_pro_migrate_reactions_limit', 200 );
$bb_user_reaction_tbl = bb_load_reaction()::$user_reaction_table;
$results = $wpdb->get_results(
$wpdb->prepare(
"SELECT id, user_id, reaction_id, item_type, item_id FROM {$bb_user_reaction_tbl} WHERE `reaction_id` IN ({$from_ids_in}) order by item_id, item_type LIMIT %d",
$limit
),
ARRAY_A
);
if ( empty( $results ) ) {
$migration_data['updated_emotions'] = 0;
bb_pro_reaction_update_migration_action( $migration_data );
return;
}
$reaction_index_ids = array_column( $results, 'id' );
$updated_index = implode( ',', wp_parse_id_list( $reaction_index_ids ) );
if ( 'delete' !== $migrate_to_id ) {
$wpdb->query(
$wpdb->prepare(
"UPDATE {$bb_user_reaction_tbl} SET `reaction_id` = %d WHERE `reaction_id` IN ({$from_ids_in}) AND id IN ({$updated_index})",
$migrate_to_id
)
);
bp_core_reset_incrementor( 'bb_reactions' );
if ( ! empty( $reaction_index_ids ) ) {
foreach ( $reaction_index_ids as $user_reaction_id ) {
wp_cache_delete( $user_reaction_id, 'bb_reactions' );
}
}
} else {
$wpdb->query( "DELETE from {$bb_user_reaction_tbl} WHERE `id` IN ({$updated_index})" );
bp_core_reset_incrementor( 'bb_reactions' );
if ( ! empty( $reaction_index_ids ) ) {
foreach ( $reaction_index_ids as $user_reaction_id ) {
wp_cache_delete( $user_reaction_id, 'bb_reactions' );
}
}
}
$desired_keys = array( 'reaction_id', 'item_type', 'item_id' );
$old_data = array();
$new_data = array();
// Prepare reaction summary data.
foreach ( $results as $reaction ) {
$reaction = array_intersect_key( $reaction, array_flip( $desired_keys ) );
array_push( $old_data, $reaction );
if ( 'delete' !== $migrate_to_id ) {
$reaction['reaction_id'] = $migrate_to_id;
array_push( $new_data, $reaction );
}
}
if ( ! empty( $old_data ) ) {
$old_data = array_unique( $old_data, SORT_REGULAR );
foreach ( $old_data as $reaction ) {
bb_load_reaction()->bb_prepare_reaction_summary_data( $reaction );
}
}
if ( ! empty( $new_data ) ) {
$new_data = array_unique( $new_data, SORT_REGULAR );
foreach ( $new_data as $reaction ) {
bb_load_reaction()->bb_prepare_reaction_summary_data( $reaction );
}
}
if ( $bb_reaction_background_process->is_cancelled() ) {
return;
}
// Update migration data.
$migration_data['updated_emotions'] = ( $migration_data['updated_emotions'] ?? 0 ) + count( $results );
bb_pro_reaction_update_migration_action( $migration_data );
// If a total background job is more than 5, then don't create a new background job.
$total_bg_jobs = $bb_reaction_background_process->get_job_count_by_type_group( 'migrate_reactions', 'bb_pro_migrate_reactions' );
if ( $total_bg_jobs > 5 ) {
return;
}
$is_reaction_migration = (bool) bp_get_option( 'is_reaction_migration' );
if ( 'delete' === $migrate_to_id ) {
// Register a new job abd schedule it.
bb_pro_reaction_dispatch_migration( $migrate_from_ids, $migrate_to_id, $job_from, 'schedule' );
} elseif ( $is_reaction_migration ) {
// Register a new job abd schedule it.
bb_pro_reaction_dispatch_migration( $migrate_from_ids, $migrate_to_id, $job_from, 'schedule' );
}
}
/**
* Function to return migration status.
*
* @sicne 2.4.50
*
* @return string
*/
function bb_pro_reaction_get_migration_status() {
static $cache = null;
if ( null === $cache ) {
$cache = '';
$reaction_process = bp_get_option( 'bb_pro_reaction_migration_completed' );
if (
! empty( $reaction_process ) &&
! empty( $reaction_process['success'] ) &&
$reaction_process['success'] === 'yes'
) {
$current_time = time();
$expire_time = isset( $reaction_process['expire_time'] ) ? $reaction_process['expire_time'] : 0;
if (
! empty( $expire_time ) &&
$current_time < $expire_time
) {
$cache = 'completed';
} else {
bp_delete_option( 'bb_pro_reaction_migration_completed' );
}
} else {
global $bb_reaction_background_process;
if (
is_object( $bb_reaction_background_process ) &&
$bb_reaction_background_process->is_inprocess(
array(
'not_secondary_data_id' => 'delete'
)
) &&
true === (bool) bp_get_option( 'is_reaction_migration' )
) {
$cache = 'inprogress';
}
}
}
return $cache;
}
/**
* Function to add migration action.
*
* @sicne 2.4.50
*
* @param array $args Data of migration.
*
* @return void
*/
function bb_pro_reaction_add_migration_action( $args = array() ) {
$r = bp_parse_args(
$args,
array(
'action' => '',
'type' => 'switch',
'total_reactions' => 0,
'updated_emotions' => 0,
'hide_for' => array(),
'status' => '',
)
);
if ( ! empty( $r['action'] ) ) {
bb_pro_reaction_update_migration_action( $r );
}
}
/**
* Function to add migration action.
*
* @sicne 2.4.50
*
* @param array $args Data of migration.
*
* @return void
*/
function bb_pro_reaction_update_migration_action( $args = array() ) {
if ( ! empty( $args ) ) {
// Get all migration data.
$existing_action = bb_pro_reaction_get_migration_action();
if (
! empty( $existing_action ) &&
! empty( $existing_action['action'] )
) {
// Merge hide_for key.
if ( ! empty( $args['hide_for'] ) ) {
$args['hide_for'] = array_unique( array_merge( $args['hide_for'], $existing_action['hide_for'] ) );
}
// Assign updated data.
$existing_action = bp_parse_args( $args, $existing_action );
} else {
$existing_action = $args;
}
// Update the data.
bp_update_option( 'bb_pro_reaction_migration', $existing_action );
}
}
/**
* Function to get migration action.
*
* @sicne 2.4.50
*
* @return array
*/
function bb_pro_reaction_get_migration_action() {
return bp_get_option( 'bb_pro_reaction_migration', array() );
}
/**
* Function to delete a migration option.
*
* @sicne 2.4.50
*
* @return void
*/
function bb_pro_reaction_delete_migration() {
bp_delete_option( 'bb_pro_reaction_migration' );
}