map.php
243 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Map block. |
| 4 | * |
| 5 | * @since 6.8.0 |
| 6 | * |
| 7 | * @package automattic/jetpack |
| 8 | */ |
| 9 | |
| 10 | namespace Automattic\Jetpack\Extensions\Map; |
| 11 | |
| 12 | use Automattic\Jetpack\Blocks; |
| 13 | use Automattic\Jetpack\Status\Host; |
| 14 | use Automattic\Jetpack\Tracking; |
| 15 | use Jetpack; |
| 16 | use Jetpack_Gutenberg; |
| 17 | use Jetpack_Mapbox_Helper; |
| 18 | |
| 19 | const FEATURE_NAME = 'map'; |
| 20 | const BLOCK_NAME = 'jetpack/' . FEATURE_NAME; |
| 21 | |
| 22 | if ( ! class_exists( 'Jetpack_Mapbox_Helper' ) ) { |
| 23 | require_once JETPACK__PLUGIN_DIR . '_inc/lib/class-jetpack-mapbox-helper.php'; |
| 24 | } |
| 25 | |
| 26 | /** |
| 27 | * Registers the block for use in Gutenberg |
| 28 | * This is done via an action so that we can disable |
| 29 | * registration if we need to. |
| 30 | */ |
| 31 | function register_block() { |
| 32 | Blocks::jetpack_register_block( |
| 33 | BLOCK_NAME, |
| 34 | array( |
| 35 | 'render_callback' => __NAMESPACE__ . '\load_assets', |
| 36 | ) |
| 37 | ); |
| 38 | } |
| 39 | add_action( 'init', __NAMESPACE__ . '\register_block' ); |
| 40 | |
| 41 | /** |
| 42 | * Record a Tracks event every time the Map block is loaded on WordPress.com and Atomic. |
| 43 | * |
| 44 | * @param string $access_token_source The Mapbox API access token source. |
| 45 | */ |
| 46 | function wpcom_load_event( $access_token_source ) { |
| 47 | if ( 'wpcom' !== $access_token_source ) { |
| 48 | return; |
| 49 | } |
| 50 | |
| 51 | $event_name = 'map_block_mapbox_wpcom_key_load'; |
| 52 | if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) { |
| 53 | require_lib( 'tracks/client' ); |
| 54 | tracks_record_event( wp_get_current_user(), $event_name ); |
| 55 | } elseif ( ( new Host() )->is_woa_site() && Jetpack::is_connection_ready() ) { |
| 56 | $tracking = new Tracking(); |
| 57 | $tracking->record_user_event( $event_name ); |
| 58 | } |
| 59 | } |
| 60 | |
| 61 | /** |
| 62 | * Function to determine which map provider to choose |
| 63 | * |
| 64 | * @param array $html The block's HTML - needed for the class name. |
| 65 | * |
| 66 | * @return string The name of the map provider. |
| 67 | */ |
| 68 | function get_map_provider( $html ) { |
| 69 | $mapbox_styles = array( 'is-style-terrain' ); |
| 70 | // return mapbox if html contains one of the mapbox styles |
| 71 | foreach ( $mapbox_styles as $style ) { |
| 72 | if ( strpos( $html, $style ) !== false ) { |
| 73 | return 'mapbox'; |
| 74 | } |
| 75 | } |
| 76 | |
| 77 | // you can override the map provider with a cookie |
| 78 | if ( isset( $_COOKIE['map_provider'] ) ) { |
| 79 | return sanitize_text_field( wp_unslash( $_COOKIE['map_provider'] ) ); |
| 80 | } |
| 81 | |
| 82 | // if we don't apply the filters & default to mapbox |
| 83 | return apply_filters( 'wpcom_map_block_map_provider', 'mapbox' ); |
| 84 | } |
| 85 | |
| 86 | /** |
| 87 | * Map block registration/dependency declaration. |
| 88 | * |
| 89 | * @param array $attr Array containing the map block attributes. |
| 90 | * @param string $content String containing the map block content. |
| 91 | * |
| 92 | * @return string |
| 93 | */ |
| 94 | function load_assets( $attr, $content ) { |
| 95 | $access_token = Jetpack_Mapbox_Helper::get_access_token(); |
| 96 | wpcom_load_event( $access_token['source'] ); |
| 97 | |
| 98 | if ( Blocks::is_amp_request() ) { |
| 99 | static $map_block_counter = array(); |
| 100 | |
| 101 | $id = get_the_ID(); |
| 102 | if ( ! isset( $map_block_counter[ $id ] ) ) { |
| 103 | $map_block_counter[ $id ] = 0; |
| 104 | } |
| 105 | ++$map_block_counter[ $id ]; |
| 106 | |
| 107 | $iframe_url = add_query_arg( |
| 108 | array( |
| 109 | 'map-block-counter' => absint( $map_block_counter[ $id ] ), |
| 110 | 'map-block-post-id' => $id, |
| 111 | ), |
| 112 | get_permalink() |
| 113 | ); |
| 114 | |
| 115 | $placeholder = preg_replace( '/(?<=<div\s)/', 'placeholder ', $content ); |
| 116 | |
| 117 | return sprintf( |
| 118 | '<amp-iframe src="%s" width="%d" height="%d" layout="responsive" allowfullscreen sandbox="allow-scripts">%s</amp-iframe>', |
| 119 | esc_url( $iframe_url ), |
| 120 | 4, |
| 121 | 3, |
| 122 | $placeholder |
| 123 | ); |
| 124 | } |
| 125 | |
| 126 | Jetpack_Gutenberg::load_assets_as_required( FEATURE_NAME ); |
| 127 | |
| 128 | $map_provider = get_map_provider( $content ); |
| 129 | if ( $map_provider === 'mapkit' ) { |
| 130 | return preg_replace( '/<div /', '<div data-map-provider="mapkit" data-blog-id="' . \Jetpack_Options::get_option( 'id' ) . '" ', $content, 1 ); |
| 131 | } |
| 132 | |
| 133 | return preg_replace( '/<div /', '<div data-map-provider="mapbox" data-api-key="' . esc_attr( $access_token['key'] ) . '" ', $content, 1 ); |
| 134 | } |
| 135 | |
| 136 | /** |
| 137 | * Render a page containing only a single Map block. |
| 138 | */ |
| 139 | function render_single_block_page() { |
| 140 | // phpcs:ignore WordPress.Security.NonceVerification |
| 141 | $map_block_counter = isset( $_GET['map-block-counter'] ) ? absint( $_GET['map-block-counter'] ) : null; |
| 142 | // phpcs:ignore WordPress.Security.NonceVerification |
| 143 | $map_block_post_id = isset( $_GET['map-block-post-id'] ) ? absint( $_GET['map-block-post-id'] ) : null; |
| 144 | |
| 145 | if ( ! $map_block_counter || ! $map_block_post_id ) { |
| 146 | return; |
| 147 | } |
| 148 | |
| 149 | /* Create an array of all root-level DIVs that are Map Blocks */ |
| 150 | $post = get_post( $map_block_post_id ); |
| 151 | |
| 152 | if ( ! class_exists( 'DOMDocument' ) ) { |
| 153 | return; |
| 154 | } |
| 155 | |
| 156 | $post_html = new \DOMDocument(); |
| 157 | /** This filter is already documented in core/wp-includes/post-template.php */ |
| 158 | $content = apply_filters( 'the_content', $post->post_content ); |
| 159 | |
| 160 | /* Suppress warnings */ |
| 161 | libxml_use_internal_errors( true ); |
| 162 | @$post_html->loadHTML( $content ); // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged |
| 163 | libxml_use_internal_errors( false ); |
| 164 | |
| 165 | $xpath = new \DOMXPath( $post_html ); |
| 166 | $container = $xpath->query( '//div[ contains( @class, "wp-block-jetpack-map" ) ]' )->item( $map_block_counter - 1 ); |
| 167 | |
| 168 | /* Check that we have a block matching the counter position */ |
| 169 | if ( ! $container ) { |
| 170 | return; |
| 171 | } |
| 172 | |
| 173 | /* Compile scripts and styles */ |
| 174 | ob_start(); |
| 175 | |
| 176 | add_filter( 'jetpack_is_amp_request', '__return_false' ); |
| 177 | |
| 178 | Jetpack_Gutenberg::load_assets_as_required( FEATURE_NAME ); |
| 179 | wp_scripts()->do_items(); |
| 180 | wp_styles()->do_items(); |
| 181 | |
| 182 | add_filter( 'jetpack_is_amp_request', '__return_true' ); |
| 183 | |
| 184 | $head_content = ob_get_clean(); |
| 185 | |
| 186 | /* Put together a new complete document containing only the requested block markup and the scripts/styles needed to render it */ |
| 187 | $block_markup = $post_html->saveHTML( $container ); |
| 188 | $access_token = Jetpack_Mapbox_Helper::get_access_token(); |
| 189 | $page_html = sprintf( |
| 190 | '<!DOCTYPE html><head><style>html, body { margin: 0; padding: 0; }</style>%s</head><body>%s</body>', |
| 191 | $head_content, |
| 192 | preg_replace( '/(?<=<div\s)/', 'data-api-key="' . esc_attr( $access_token['key'] ) . '" ', $block_markup, 1 ) |
| 193 | ); |
| 194 | echo $page_html; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped |
| 195 | exit; |
| 196 | } |
| 197 | add_action( 'wp', __NAMESPACE__ . '\render_single_block_page' ); |
| 198 | |
| 199 | /** |
| 200 | * Helper function to generate the markup of the block in PHP. |
| 201 | * |
| 202 | * @param Array $points - Array containing geo location points. |
| 203 | * |
| 204 | * @return string Markup for the jetpack/map block. |
| 205 | */ |
| 206 | function map_block_from_geo_points( $points ) { |
| 207 | $map_block_data = array( |
| 208 | 'points' => $points, |
| 209 | 'zoom' => 8, |
| 210 | 'mapCenter' => array( |
| 211 | 'lng' => $points[0]['coordinates']['longitude'], |
| 212 | 'lat' => $points[0]['coordinates']['latitude'], |
| 213 | ), |
| 214 | ); |
| 215 | |
| 216 | $list_items = array_map( |
| 217 | function ( $point ) { |
| 218 | $link = add_query_arg( |
| 219 | array( |
| 220 | 'api' => 1, |
| 221 | 'query' => $point['coordinates']['latitude'] . ',' . $point['coordinates']['longitude'], |
| 222 | ), |
| 223 | 'https://www.google.com/maps/search/' |
| 224 | ); |
| 225 | return sprintf( '<li><a href="%s">%s</a></li>', esc_url( $link ), $point['title'] ); |
| 226 | }, |
| 227 | $points |
| 228 | ); |
| 229 | |
| 230 | $map_block = '<!-- wp:jetpack/map ' . wp_json_encode( $map_block_data ) . ' -->' . PHP_EOL; |
| 231 | $map_block .= sprintf( |
| 232 | '<div class="wp-block-jetpack-map" data-map-style="default" data-map-details="true" data-points="%1$s" data-zoom="%2$d" data-map-center="%3$s" data-marker-color="red" data-show-fullscreen-button="true">', |
| 233 | esc_html( wp_json_encode( $map_block_data['points'] ) ), |
| 234 | (int) $map_block_data['zoom'], |
| 235 | esc_html( wp_json_encode( $map_block_data['mapCenter'] ) ) |
| 236 | ); |
| 237 | $map_block .= '<ul>' . implode( "\n", $list_items ) . '</ul>'; |
| 238 | $map_block .= '</div>' . PHP_EOL; |
| 239 | $map_block .= '<!-- /wp:jetpack/map -->'; |
| 240 | |
| 241 | return $map_block; |
| 242 | } |
| 243 |