489 lines
14 KiB
PHP
489 lines
14 KiB
PHP
<?php
|
|
|
|
/**
|
|
* @author OnTheGo Systems
|
|
*/
|
|
class WPML_Notices {
|
|
|
|
const NOTICES_OPTION_KEY = 'wpml_notices';
|
|
const DISMISSED_OPTION_KEY = '_wpml_dismissed_notices';
|
|
const USER_DISMISSED_KEY = '_wpml_user_dismissed_notices';
|
|
const NONCE_NAME = 'wpml-notices';
|
|
const DEFAULT_GROUP = 'default';
|
|
|
|
private $notice_render;
|
|
/**
|
|
* @var array<string,array<\WPML_Notice>>
|
|
*/
|
|
private $notices;
|
|
/**
|
|
* @var array<string,array<int>>
|
|
*/
|
|
private $notices_to_remove = array();
|
|
private $dismissed;
|
|
private $user_dismissed;
|
|
private $original_notices_md5;
|
|
|
|
/**
|
|
* WPML_Notices constructor.
|
|
*
|
|
* @param WPML_Notice_Render $notice_render
|
|
*/
|
|
public function __construct( WPML_Notice_Render $notice_render ) {
|
|
$this->notice_render = $notice_render;
|
|
$this->notices = $this->filter_invalid_notices( $this->get_all_notices() );
|
|
$this->dismissed = $this->get_all_dismissed();
|
|
$this->original_notices_md5 = md5( maybe_serialize( $this->notices ) );
|
|
}
|
|
|
|
/**
|
|
* @return int
|
|
*/
|
|
public function count() {
|
|
$all_notices = $this->get_all_notices();
|
|
$count = 0;
|
|
foreach ( $all_notices as $group => $group_notices ) {
|
|
$count += count( $group_notices );
|
|
}
|
|
|
|
return $count;
|
|
}
|
|
|
|
/**
|
|
* @return array
|
|
*/
|
|
public function get_all_notices() {
|
|
$all_notices = get_option( self::NOTICES_OPTION_KEY );
|
|
if ( ! is_array( $all_notices ) ) {
|
|
$all_notices = array();
|
|
}
|
|
return $all_notices;
|
|
}
|
|
|
|
/**
|
|
* @return array
|
|
*/
|
|
private function get_all_dismissed() {
|
|
$dismissed = get_option( self::DISMISSED_OPTION_KEY );
|
|
if ( ! is_array( $dismissed ) ) {
|
|
$dismissed = array();
|
|
}
|
|
return $dismissed;
|
|
}
|
|
|
|
private function init_all_user_dismissed() {
|
|
if ( null === $this->user_dismissed ) {
|
|
$this->user_dismissed = get_user_meta( get_current_user_id(), self::USER_DISMISSED_KEY, true );
|
|
|
|
if ( ! is_array( $this->user_dismissed ) ) {
|
|
$this->user_dismissed = array();
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param string $id
|
|
* @param string $group
|
|
*
|
|
* @return null|WPML_Notice
|
|
*/
|
|
public function get_notice( $id, $group = 'default' ) {
|
|
$notice = null;
|
|
|
|
if ( isset( $this->notices[ $group ][ $id ] ) ) {
|
|
$notice = $this->notices[ $group ][ $id ];
|
|
}
|
|
|
|
return $notice;
|
|
}
|
|
|
|
/**
|
|
* @param string $id
|
|
* @param string $text
|
|
* @param string $group
|
|
*
|
|
* @return WPML_Notice
|
|
*/
|
|
public function create_notice( $id, $text, $group = 'default' ) {
|
|
return new WPML_Notice( $id, $text, $group );
|
|
}
|
|
|
|
public function add_notice( WPML_Notice $notice, $force_update = false ) {
|
|
$existing_notice = $this->notice_exists( $notice ) ? $this->notices[ $notice->get_group() ][ $notice->get_id() ] : null;
|
|
|
|
$new_notice_is_different = null === $existing_notice || $notice->is_different( $existing_notice );
|
|
|
|
if ( $notice->must_reset_dismiss() && $this->is_notice_dismissed( $notice ) ) {
|
|
$this->undismiss_notice( $notice );
|
|
}
|
|
|
|
if ( ! $existing_notice || ( $new_notice_is_different || $force_update ) ) {
|
|
$this->notices[ $notice->get_group() ][ $notice->get_id() ] = $notice;
|
|
$this->save_notices();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param string $id
|
|
* @param string $text
|
|
* @param string $group
|
|
*
|
|
* @return WPML_Notice
|
|
*/
|
|
public function get_new_notice( $id, $text, $group = 'default' ) {
|
|
return new WPML_Notice( $id, $text, $group );
|
|
}
|
|
|
|
/**
|
|
* @param string $text
|
|
* @param string $url
|
|
* @param bool $dismiss
|
|
* @param bool $hide
|
|
* @param bool $display_as_button
|
|
*
|
|
* @return WPML_Notice_Action
|
|
*/
|
|
public function get_new_notice_action( $text, $url = '#', $dismiss = false, $hide = false, $display_as_button = false ) {
|
|
return new WPML_Notice_Action( $text, $url, $dismiss, $hide, $display_as_button );
|
|
}
|
|
|
|
/**
|
|
* @param WPML_Notice $notice
|
|
*
|
|
* @return bool
|
|
*/
|
|
private function notice_exists( WPML_Notice $notice ) {
|
|
$notice_id = $notice->get_id();
|
|
$notice_group = $notice->get_group();
|
|
|
|
return $this->group_and_id_exist( $notice_group, $notice_id );
|
|
}
|
|
|
|
private function get_notices_for_group( $group ) {
|
|
if ( array_key_exists( $group, $this->notices ) ) {
|
|
return $this->notices[ $group ];
|
|
}
|
|
|
|
return array();
|
|
}
|
|
|
|
private function save_notices() {
|
|
$this->remove_notices();
|
|
if ( ! has_action( 'shutdown', array( $this, 'save_to_option' ) ) ) {
|
|
add_action( 'shutdown', array( $this, 'save_to_option' ), 1000 );
|
|
}
|
|
}
|
|
|
|
public function save_to_option() {
|
|
if ( $this->original_notices_md5 !== md5( maybe_serialize( $this->notices ) ) ) {
|
|
update_option( self::NOTICES_OPTION_KEY, $this->notices, false );
|
|
}
|
|
}
|
|
|
|
private function save_dismissed() {
|
|
update_user_meta( get_current_user_id(), self::USER_DISMISSED_KEY, $this->user_dismissed );
|
|
update_option( self::DISMISSED_OPTION_KEY, $this->dismissed, false );
|
|
}
|
|
|
|
public function remove_notices() {
|
|
if ( $this->notices_to_remove ) {
|
|
foreach ( $this->notices_to_remove as $group => &$group_notices ) {
|
|
foreach ( $group_notices as $id ) {
|
|
if ( array_key_exists( $group, $this->notices ) && array_key_exists( $id, $this->notices[ $group ] ) ) {
|
|
unset( $this->notices[ $group ][ $id ] );
|
|
$group_notices = array_diff( $this->notices_to_remove[ $group ], array( $id ) );
|
|
}
|
|
}
|
|
if ( array_key_exists( $group, $this->notices_to_remove ) && ! $this->notices_to_remove[ $group ] ) {
|
|
unset( $this->notices_to_remove[ $group ] );
|
|
}
|
|
if ( array_key_exists( $group, $this->notices ) && ! $this->notices[ $group ] ) {
|
|
unset( $this->notices[ $group ] );
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
public function admin_enqueue_scripts() {
|
|
if ( WPML_Block_Editor_Helper::is_edit_post() ) {
|
|
wp_enqueue_script(
|
|
'block-editor-notices',
|
|
ICL_PLUGIN_URL . '/dist/js/blockEditorNotices/app.js',
|
|
array( 'wp-edit-post' ),
|
|
ICL_SITEPRESS_VERSION,
|
|
true
|
|
);
|
|
}
|
|
if ( $this->must_display_notices() ) {
|
|
wp_enqueue_style( 'otgs-notices', ICL_PLUGIN_URL . '/res/css/otgs-notices.css', array( 'sitepress-style' ) );
|
|
wp_enqueue_script(
|
|
'otgs-notices',
|
|
ICL_PLUGIN_URL . '/res/js/otgs-notices.js',
|
|
array( 'underscore' ),
|
|
ICL_SITEPRESS_VERSION,
|
|
true
|
|
);
|
|
|
|
do_action( 'wpml-notices-scripts-enqueued' );
|
|
}
|
|
}
|
|
|
|
private function must_display_notices() {
|
|
if ( $this->notices ) {
|
|
foreach ( $this->notices as $group => $notices ) {
|
|
foreach ( $notices as $notice ) {
|
|
if ( $this->notice_render->must_display_notice( $notice ) && ! $this->must_hide_if_notice_exists( $notice ) ) {
|
|
return true;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
private function must_hide_if_notice_exists( WPML_Notice $notice ) {
|
|
$hide_if_notice_exists = $notice->get_hide_if_notice_exists();
|
|
if ( $hide_if_notice_exists ) {
|
|
$other_notice = $this->get_notice( $hide_if_notice_exists['id'], $hide_if_notice_exists['group'] );
|
|
|
|
return $other_notice;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
public function admin_notices() {
|
|
if ( $this->notices && $this->must_display_notices() ) {
|
|
foreach ( $this->notices as $group => $notices ) {
|
|
foreach ( $notices as $notice ) {
|
|
if ( $notice instanceof WPML_Notice && ! $this->is_notice_dismissed( $notice ) ) {
|
|
$this->notice_render->render( $notice );
|
|
if ( $notice->is_flash() ) {
|
|
$this->remove_notice( $notice->get_group(), $notice->get_id() );
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
public function wp_ajax_hide_notice() {
|
|
list( $notice_group, $notice_id ) = $this->parse_group_and_id();
|
|
|
|
if ( ! $notice_group ) {
|
|
$notice_group = self::DEFAULT_GROUP;
|
|
}
|
|
|
|
if ( $this->has_valid_nonce() && $this->group_and_id_exist( $notice_group, $notice_id ) ) {
|
|
$this->remove_notice( $notice_group, $notice_id );
|
|
wp_send_json_success( true );
|
|
}
|
|
|
|
wp_send_json_error( __( 'Notice does not exists.', 'sitepress' ) );
|
|
}
|
|
|
|
public function wp_ajax_dismiss_notice() {
|
|
list( $notice_group, $notice_id ) = $this->parse_group_and_id();
|
|
|
|
if ( $this->has_valid_nonce() && $this->dismiss_notice_by_id( $notice_id, $notice_group ) ) {
|
|
wp_send_json_success( true );
|
|
}
|
|
|
|
wp_send_json_error( __( 'Notice does not exist.', 'sitepress' ) );
|
|
}
|
|
|
|
/**
|
|
* @param string $notice_id
|
|
* @param null|string $notice_group
|
|
*
|
|
* @return bool
|
|
*/
|
|
private function dismiss_notice_by_id( $notice_id, $notice_group = null ) {
|
|
if ( ! $notice_group ) {
|
|
$notice_group = self::DEFAULT_GROUP;
|
|
}
|
|
|
|
if ( $this->group_and_id_exist( $notice_group, $notice_id ) ) {
|
|
$notice = $this->get_notice( $notice_id, $notice_group );
|
|
|
|
if ( $notice ) {
|
|
$this->dismiss_notice( $notice );
|
|
$this->remove_notice( $notice_group, $notice_id );
|
|
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
public function wp_ajax_dismiss_group() {
|
|
list( $notice_group ) = $this->parse_group_and_id();
|
|
|
|
if ( $notice_group && $this->has_valid_nonce() && $this->dismiss_notice_group( $notice_group ) ) {
|
|
wp_send_json_success( true );
|
|
}
|
|
wp_send_json_error( __( 'Group does not exist.', 'sitepress' ) );
|
|
}
|
|
|
|
/**
|
|
* @param null|string $notice_group
|
|
*
|
|
* @return bool
|
|
*/
|
|
private function dismiss_notice_group( $notice_group ) {
|
|
if ( $notice_group ) {
|
|
$notices = $this->get_notices_for_group( $notice_group );
|
|
|
|
if ( $notices ) {
|
|
/** @var WPML_Notice $notice */
|
|
foreach ( $notices as $notice ) {
|
|
$this->dismiss_notice( $notice, false );
|
|
$this->remove_notice( $notice_group, $notice->get_id() );
|
|
}
|
|
|
|
$this->save_dismissed();
|
|
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* @return array
|
|
*/
|
|
private function parse_group_and_id() {
|
|
$group = isset( $_POST['group'] ) ? sanitize_text_field( $_POST['group'] ) : false;
|
|
$id = isset( $_POST['id'] ) ? sanitize_text_field( $_POST['id'] ) : false;
|
|
|
|
return array( $group, $id );
|
|
}
|
|
|
|
/**
|
|
* @return false|int
|
|
*/
|
|
private function has_valid_nonce() {
|
|
$nonce = isset( $_POST['nonce'] ) ? $_POST['nonce'] : null;
|
|
return wp_verify_nonce( $nonce, self::NONCE_NAME );
|
|
}
|
|
|
|
private function group_and_id_exist( $group, $id ) {
|
|
return array_key_exists( $group, $this->notices ) && array_key_exists( $id, $this->notices[ $group ] );
|
|
}
|
|
|
|
/**
|
|
* @param string $notice_group
|
|
* @param string|int $notice_id
|
|
*/
|
|
public function remove_notice( $notice_group, $notice_id ) {
|
|
$this->notices_to_remove[ $notice_group ][] = $notice_id;
|
|
$this->notices_to_remove[ $notice_group ] = array_unique( $this->notices_to_remove[ $notice_group ] );
|
|
$this->save_notices();
|
|
|
|
if ( ! is_array( $this->notices_to_remove ) ) {
|
|
$this->notices_to_remove = array();
|
|
}
|
|
|
|
if ( isset( $this->notices_to_remove[ $notice_group ] ) ) {
|
|
foreach ( $this->notices_to_remove[ $notice_group ] as $key => $notice ) {
|
|
if ( $notice === $notice_id ) {
|
|
unset( $this->notices_to_remove[ $notice_group ][ $key ] );
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param string $notice_group
|
|
*/
|
|
public function remove_notice_group( $notice_group ) {
|
|
$notices = $this->get_notices_for_group( $notice_group );
|
|
$notices_ids = array_keys( $notices );
|
|
foreach ( $notices_ids as $notices_id ) {
|
|
$this->remove_notice( $notice_group, $notices_id );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param WPML_Notice $notice
|
|
* @param bool $persist
|
|
*/
|
|
public function dismiss_notice( WPML_Notice $notice, $persist = true ) {
|
|
if ( method_exists( $notice, 'is_user_restricted' ) && $notice->is_user_restricted() ) {
|
|
$this->init_all_user_dismissed();
|
|
$this->user_dismissed[ $notice->get_group() ][ $notice->get_id() ] = md5( $notice->get_text() );
|
|
} else {
|
|
$this->dismissed[ $notice->get_group() ][ $notice->get_id() ] = md5( $notice->get_text() );
|
|
}
|
|
|
|
if ( $persist ) {
|
|
$this->save_dismissed();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param WPML_Notice $notice
|
|
* @param bool $persist
|
|
*/
|
|
public function undismiss_notice( WPML_Notice $notice, $persist = true ) {
|
|
if ( method_exists( $notice, 'is_user_restricted' ) && $notice->is_user_restricted() ) {
|
|
$this->init_all_user_dismissed();
|
|
unset( $this->user_dismissed[ $notice->get_group() ][ $notice->get_id() ] );
|
|
} else {
|
|
unset( $this->dismissed[ $notice->get_group() ][ $notice->get_id() ] );
|
|
}
|
|
|
|
if ( $persist ) {
|
|
$this->save_dismissed();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param WPML_Notice $notice
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function is_notice_dismissed( WPML_Notice $notice ) {
|
|
$group = $notice->get_group();
|
|
$id = $notice->get_id();
|
|
|
|
$is_dismissed = isset( $this->dismissed[ $group ][ $id ] ) && $this->dismissed[ $group ][ $id ];
|
|
|
|
if ( ! $is_dismissed ) {
|
|
$this->init_all_user_dismissed();
|
|
$is_dismissed = isset( $this->user_dismissed[ $group ][ $id ] ) && $this->user_dismissed[ $group ][ $id ];
|
|
}
|
|
|
|
if ( $is_dismissed && method_exists( $notice, 'can_be_dismissed_for_different_text' )
|
|
&& ! $notice->can_be_dismissed_for_different_text() ) {
|
|
$is_dismissed = md5( $notice->get_text() ) === $this->dismissed[ $group ][ $id ];
|
|
}
|
|
|
|
return $is_dismissed;
|
|
}
|
|
|
|
public function init_hooks() {
|
|
add_action( 'admin_notices', array( $this, 'admin_notices' ) );
|
|
add_action( 'admin_enqueue_scripts', array( $this, 'admin_enqueue_scripts' ), \WPML_Admin_Scripts_Setup::PRIORITY_ENQUEUE_SCRIPTS + 1 );
|
|
add_action( 'wp_ajax_otgs-hide-notice', array( $this, 'wp_ajax_hide_notice' ) );
|
|
add_action( 'wp_ajax_otgs-dismiss-notice', array( $this, 'wp_ajax_dismiss_notice' ) );
|
|
add_action( 'wp_ajax_otgs-dismiss-group', array( $this, 'wp_ajax_dismiss_group' ) );
|
|
add_action( 'otgs_add_notice', array( $this, 'add_notice' ), 10, 2 );
|
|
add_action( 'otgs_remove_notice', array( $this, 'remove_notice' ), 10, 2 );
|
|
add_action( 'otgs_remove_notice_group', array( $this, 'remove_notice_group' ), 10, 1 );
|
|
}
|
|
|
|
private function filter_invalid_notices( $notices ) {
|
|
foreach ( $notices as $group => $notices_in_group ) {
|
|
foreach ( $notices_in_group as $index => $notice ) {
|
|
if ( ! $notice instanceof WPML_Notice ) {
|
|
unset( $notices[ $group ][ $index ] );
|
|
}
|
|
}
|
|
}
|
|
return $notices;
|
|
}
|
|
}
|