Tiny File Manager | class-admin-notice-custom-css.php

Back Back Up Advanced Editor

<?php
/*
 * FooGallery Admin Custom CSS Notice class
 */

if ( ! class_exists( 'FooGallery_Admin_Notice_CustomCSS' ) ) {

class FooGallery_Admin_Notice_CustomCSS {

private $option_name = FOOGALLERY_OPTION_CUSTOM_CSS;
        private $notice_id = 'customcss';
        private $notice_class = 'notice-info';
        private $css_classes_to_check = array( 'fg-caption' );

public function __construct() {
            // We only need to check this after v2.5.0
            if ( version_compare( FOOGALLERY_VERSION, '2.5.0', '<' ) ) {
                return;
            }

// display the notice
            add_action( 'admin_notices', array( $this, 'display_notice' ) );
            // ajax handler to dismiss the notice
			add_action( 'wp_ajax_foogallery_admin_notice_dismiss-' . $this->notice_id, array( $this, 'dismiss_notice' ) );
            // clear the saved data if a gallery is saved, or settings are updated
            add_action( 'foogallery_after_save_gallery', array( $this, 'determine_and_save_option' ) );
            add_action( 'update_option_foogallery', array( $this, 'after_settings_updated' ), 10, 3 );
            // override the settings
            add_filter( 'foogallery_admin_settings_override', array( $this, 'override_settings' ) );
            //render the custom css settings
            add_action( 'foogallery_admin_settings_custom_type_render_setting', array( $this, 'render_settings' ) );

}

/**
         * Override the settings
         */
        function override_settings( $settings ) {
            $option = $this->get_option();

if ( count( $option['galleries'] ) > 0 || $option['setting'] ) {

$index = foogallery_admin_fields_find_index_of_field( $settings['settings'], 'custom_js' );

$link_html = '<a target="_blank" href="' . esc_url( 'https://fooplugins.com/documentation/foogallery/troubleshooting-foogallery/foogallery-v3-0-custom-css-migration-guide/' ) . '">' . __( 'Custom CSS v3 Migration Guide', 'foogallery' ) . '</a>';

$new_settings[] = array(
                    'id'      => 'custom_css_update',
                    'title'   => __( 'Custom CSS Review!', 'foogallery' ),
                    'desc'    => __( 'We found custom CSS that needs to be reviewed. Since FooGallery update v3, custom CSS related to captions (specifically when using `fg-caption`), nees to be reivewed and in some cases updated.', 'foogallery' ) . '<br />' . 
                        __( 'Changes are not always needed, so if you review your Custom CSS and all seems correct, you can safely dismiss the admin notice, and ignore this message.', 'foogallery' ) . '<br />' . 
                        sprintf( __( 'For more info, please read our %s.', 'foogallery' ), $link_html ),
                    'type'    => 'custom_css_update',
                    'tab'     => 'custom_assets',
                );

array_splice( $settings['settings'], $index, 0, $new_settings );
            }

return $settings;
        }

/**
		 * Render any custom setting types to the settings page
		 */
		function render_settings( $args ) {
			if ( 'custom_css_update' === $args['type'] ) { 
                $option = $this->get_option();

if ( is_array( $option ) && count( $option ) > 0 ) {
                    $galleries = $option['galleries'];
                    if ( count( $galleries ) > 0 ) {
                        ?>
                        <p><?php _e( 'Please review the custom CSS on the following galleries:', 'foogallery' ); ?></p>
                        <ul class="ul-disc">
                            <?php foreach ( $galleries as $gallery_id => $gallery_name ) { ?>
                                <li><a href="<?php echo get_edit_post_link( $gallery_id ); ?>"><?php echo $gallery_name; ?></a></li>
                            <?php } ?>
                        </ul>
                        <?php
                    }
                    if ( $option['setting'] ) {
                        ?>
                        <p><?php _e( 'Please review the custom CSS saved in the Custom Stylesheet setting below.', 'foogallery' ); ?></p>
                        <?php
                    }
                }
            }
		}

/**
         * Clear the saved data after settings are updated.
         */
        function after_settings_updated( $old_value, $value, $option ) {
            if ( !is_admin() ) {
				return;
			}

if ( !current_user_can( 'manage_options' ) ) {
				return;
			}

$this->determine_and_save_option();
        }

/**
         * Display the admin notice.
         */
		function display_notice() {
			if ( $this->should_show_notice() ) {
				?>
                <script type="text/javascript">
					(function( $ ) {
						$( document ).ready( function() {
							$( '.foogallery-admin-notice-<?php echo $this->notice_id; ?>.is-dismissible' )
								.on( 'click', '.notice-dismiss', function( e ) {
									e.preventDefault();
									$.post( ajaxurl, {
										action: 'foogallery_admin_notice_dismiss-<?php echo $this->notice_id; ?>',
										url: '<?php echo admin_url( 'admin-ajax.php' ); ?>',
										_wpnonce: '<?php echo wp_create_nonce( 'foogallery_admin_notice_dismiss-' . $this->notice_id ); ?>'
									} );
								} );
						} );
					})( jQuery );
				</script>
				<div class="notice <?php echo $this->notice_class; ?> is-dismissible foogallery-admin-notice-<?php echo $this->notice_id; ?>">
					<?php $this->display_notice_inner_html(); ?>
				</div>
				<?php
			}
		}

/**
         * Display the inner HTML of the admin notice.
         */
        function display_notice_inner_html() {
            $option = $this->get_option();
            $url = foogallery_admin_settings_url() . '#custom_assets';
            $link = '<a href="'. $url . '">' . __( 'FooGallery Settings', 'foogallery' ) . '</a>';
            if ( is_array( $option ) && count( $option ) > 0 ) { ?>
                <h3><?php _e( 'FooGallery - Custom CSS Review Required', 'foogallery' ); ?></h3>
                <?php
                    $galleries = $option['galleries'];
                    if ( count( $galleries ) > 0 ) {
                        ?>
                        <p><?php printf( __( 'We found custom CSS in %s galleries that needs to be reviewed.', 'foogallery' ), count( $galleries ) ); ?></p>
                        <?php
                    }
                    if ( $option['setting'] ) {
                        ?>
                        <p><?php printf( __( 'You have custom CSS saved in settings that needs to be reviewed.', 'foogallery' ) ); ?></p>
                        <?php
                    }
                ?>
                <p><?php printf( __( 'We have made some changes in v3 that could potentially affect your custom CSS. Visit %s to see what needs to be reviewed.', 'foogallery' ), $link ); ?></p>
            <?php }
        }

/**
         * Determine if the notice should be shown.
         */
        function should_show_notice() {
			$option = $this->get_option( true );

if ( !is_array( $option ) ) {
                return false;
            }

if ( count( $option['galleries'] ) === 0 && !$option['setting'] ) {
                // we have previously checked and the results were clear.
				return false;
			} else if ( $option['hide'] ) {
                // the user has hidden the notice. Never show!
				return false;
			}

// If we get here, then the notice should be shown.
			return true;
		}

/**
         * Get the option.
         */
        function get_option( $determine = false ) {
            $option = get_option( $this->option_name );

// If false, then the option doesn't exist.
            if ( $option === false ) {
                if ( $determine ) {
                    $this->determine_and_save_option();
                    $option = get_option( $this->option_name );
                }
            }

if ( !is_array( $option ) ) {
                // Malformed.
                $option = array(
                    'galleries' => array(),
                    'setting' => false,
                    'hide' => false
                );
            }

return $option;
        }

/**
         * Get the hidden state of the option.
         */
        function get_option_hidden() {
            $option = get_option( $this->option_name );

return isset( $option['hide'] ) ? $option['hide'] : false;
        }

/**
         * Ajax handler to dismiss the notice.
         */
        function dismiss_notice() {
            if ( check_admin_referer( 'foogallery_admin_notice_dismiss-' . $this->notice_id ) ) {
                // Just update the hide flag.
                $option = $this->get_option();
                $option['hide'] = true;
                update_option( $this->option_name, $option, false );
            }
        }

/**
         * Determine and save the option.
         */ 
        function determine_and_save_option() {
            $option = $option = array(
                'galleries' => array(),
                'setting' => false,
                'hide' => $this->get_option_hidden()
            );

$galleries = foogallery_get_all_galleries();

$galleries_with_css = array();
            $custom_css_setting_contains = false;

if ( ! empty( $galleries ) ) {
                foreach ( $galleries as $gallery ) {
                    $custom_css = get_post_meta( $gallery->ID, FOOGALLERY_META_CUSTOM_CSS, true );

if ( $this->does_contain_css_classes( $custom_css ) ) {
                        $galleries_with_css[$gallery->ID] = $gallery->name;
                    }
                }
            }

$custom_css_setting = foogallery_get_setting( 'custom_css' );

if ( !empty( $custom_css_setting ) ) {
                if ( $this->does_contain_css_classes( $custom_css_setting ) ) {
                    $custom_css_setting_contains = true;
                }
            }

$option['galleries'] = $galleries_with_css;
            $option['setting'] = $custom_css_setting_contains;
            update_option( $this->option_name, $option, false );
        }

/**
         * Check if the CSS contains any of the classes we are looking for.
         */
        function does_contain_css_classes( $css ) {
            foreach ( $this->css_classes_to_check as $class ) {
                if ( strpos( $css, $class ) !== false ) {
                    return true;
                }
            }
            return false;
        }
    }
}