cookie-consent.php
158 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Cookie-consent Block. |
| 4 | * |
| 5 | * @since 12.0 |
| 6 | * |
| 7 | * @package automattic/jetpack |
| 8 | */ |
| 9 | |
| 10 | namespace Automattic\Jetpack\Extensions\CookieConsent; |
| 11 | |
| 12 | use Automattic\Jetpack\Blocks; |
| 13 | use Jetpack_Gutenberg; |
| 14 | |
| 15 | const COOKIE_NAME = 'eucookielaw'; |
| 16 | |
| 17 | /** |
| 18 | * Should the block be registered? |
| 19 | * In wp-admin, we only want to show the block in the site editor. |
| 20 | * |
| 21 | * @since 12.0 |
| 22 | * |
| 23 | * @return bool |
| 24 | */ |
| 25 | function should_register_block() { |
| 26 | global $pagenow; |
| 27 | |
| 28 | // Always register the widget if we're on the front end |
| 29 | if ( ! is_admin() ) { |
| 30 | return true; |
| 31 | } |
| 32 | |
| 33 | if ( is_admin() && $pagenow === 'site-editor.php' ) { |
| 34 | return true; |
| 35 | } |
| 36 | } |
| 37 | |
| 38 | /** |
| 39 | * Registers the block for use in Gutenberg |
| 40 | * This is done via an action so that we can disable |
| 41 | * registration if we need to. |
| 42 | */ |
| 43 | function register_block() { |
| 44 | if ( ! should_register_block() ) { |
| 45 | return; |
| 46 | } |
| 47 | |
| 48 | Blocks::jetpack_register_block( |
| 49 | __DIR__, |
| 50 | array( 'render_callback' => __NAMESPACE__ . '\load_assets' ), |
| 51 | array( |
| 52 | 'attributes' => array( |
| 53 | 'render_from_template' => array( |
| 54 | 'default' => false, |
| 55 | 'type' => 'boolean', |
| 56 | ), |
| 57 | ), |
| 58 | ) |
| 59 | ); |
| 60 | } |
| 61 | add_action( 'init', __NAMESPACE__ . '\register_block' ); |
| 62 | |
| 63 | /** |
| 64 | * Cookie-consent block registration/dependency declaration. |
| 65 | * |
| 66 | * @param array $attr Array containing the Cookie-consent block attributes. |
| 67 | * @param string $content String containing the Cookie-consent block content. |
| 68 | * |
| 69 | * @return string |
| 70 | */ |
| 71 | function load_assets( $attr, $content ) { |
| 72 | // We want to bust the cache even if the cookie isn't set. |
| 73 | // This is needed for when the cookie expires, |
| 74 | // and we should send fresh HTML with the cookie block in it. |
| 75 | notify_batcache_that_content_changed(); |
| 76 | |
| 77 | // If the user has already accepted the cookie consent, don't show the block. |
| 78 | if ( isset( $_COOKIE[ COOKIE_NAME ] ) ) { |
| 79 | return ''; |
| 80 | } |
| 81 | |
| 82 | $option = get_option( 'cookie_consent_template' ); |
| 83 | if ( ! empty( $option ) && empty( $attr['render_from_template'] ) ) { |
| 84 | return ''; |
| 85 | } |
| 86 | |
| 87 | /* |
| 88 | * Enqueue necessary scripts and styles. |
| 89 | */ |
| 90 | Jetpack_Gutenberg::load_assets_as_required( __DIR__ ); |
| 91 | |
| 92 | return sprintf( |
| 93 | '<div class="%1$s">%2$s</div>', |
| 94 | esc_attr( Blocks::classes( Blocks::get_block_feature( __DIR__ ), $attr ) ), |
| 95 | $content |
| 96 | ); |
| 97 | } |
| 98 | |
| 99 | /** |
| 100 | * Batcache busting: since the cookie consent is part of the cached response HTML, it can still render even when the cookie is set (when it shouldn't). |
| 101 | * Because, by default, the cache doesn't vary around the cookie's value. This makes the cookie value part of the cache key. |
| 102 | * |
| 103 | * See: https://github.com/Automattic/batcache/blob/d4f617b335e9772a61b6d03ad3498b55c8137592/advanced-cache.php#L29 |
| 104 | */ |
| 105 | function notify_batcache_that_content_changed() { |
| 106 | if ( function_exists( 'vary_cache_on_function' ) ) { |
| 107 | vary_cache_on_function( 'return isset( $_COOKIE[ "' . COOKIE_NAME . '" ] );' ); |
| 108 | } |
| 109 | } |
| 110 | |
| 111 | /** |
| 112 | * Render the cookie consent template. |
| 113 | * |
| 114 | * @since 12.4 |
| 115 | */ |
| 116 | function render_cookie_consent_template() { |
| 117 | |
| 118 | if ( is_admin() ) { |
| 119 | return; |
| 120 | } |
| 121 | |
| 122 | // Check whether block theme functions exist. |
| 123 | if ( ! function_exists( 'parse_blocks' ) ) { |
| 124 | return; |
| 125 | } |
| 126 | |
| 127 | $template = get_option( 'cookie_consent_template' ); |
| 128 | |
| 129 | if ( empty( $template ) ) { |
| 130 | return; |
| 131 | } |
| 132 | |
| 133 | $parsed = parse_blocks( $template ); |
| 134 | if ( ! empty( $parsed[0] ) ) { |
| 135 | $parsed[0]['attrs']['render_from_template'] = true; |
| 136 | echo render_block( $parsed[0] ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped |
| 137 | } |
| 138 | } |
| 139 | add_action( 'wp_footer', __NAMESPACE__ . '\render_cookie_consent_template' ); |
| 140 | |
| 141 | /** |
| 142 | * Register cookie_consent_template setting |
| 143 | * |
| 144 | * @since 12.4 |
| 145 | */ |
| 146 | function cookie_consent_register_settings() { |
| 147 | register_setting( |
| 148 | 'general', |
| 149 | 'cookie_consent_template', |
| 150 | array( |
| 151 | 'type' => 'string', |
| 152 | 'show_in_rest' => true, |
| 153 | ) |
| 154 | ); |
| 155 | } |
| 156 | |
| 157 | add_action( 'rest_api_init', __NAMESPACE__ . '\cookie_consent_register_settings' ); |
| 158 |