| @@ -68,11 +68,32 @@ | ||
| 68 | 68 | add_filter( 'term_description', 'do_shortcode' ); |
| 69 | 69 | } |
| 70 | 70 | |
| 71 | 71 | add_action( 'rest_api_init', array( $this, 'endpoint_register' ) ); |
| 72 | + | |
| 73 | + $this->_addFilter( 'script_loader_tag', 'script_loader_tag', null, 10, 3 ); | |
| 72 | 74 | } |
| 73 | 75 | |
| 74 | 76 | /** |
| 77 | + * Adds the async attribute to certain scripts. | |
| 78 | + */ | |
| 79 | + function script_loader_tag( $tag, $handle, $src ) { | |
| 80 | + if ( is_admin() ) { | |
| 81 | + return $tag; | |
| 82 | + } | |
| 83 | + | |
| 84 | + $scripts = array( 'google-jsapi', 'visualizer-render-google-lib', 'visualizer-render-google' ); | |
| 85 | + | |
| 86 | + foreach ( $scripts as $async ) { | |
| 87 | + if ( $async === $handle ) { | |
| 88 | + $tag = str_replace( ' src', ' defer="defer" src', $tag ); | |
| 89 | + break; | |
| 90 | + } | |
| 91 | + } | |
| 92 | + return $tag; | |
| 93 | + } | |
| 94 | + | |
| 95 | + /** | |
| 75 | 96 | * Returns the language/locale. |
| 76 | 97 | */ |
| 77 | 98 | function getLanguage( $dummy, $only_language ) { |
| 78 | 99 | return $this->get_language(); |
| @@ -86,9 +107,33 @@ | ||
| 86 | 107 | register_rest_route( |
| 87 | 108 | 'visualizer/v' . VISUALIZER_REST_VERSION, |
| 88 | 109 | '/action/(?P<chart>\d+)/(?P<type>.+)/', |
| 89 | 110 | array( |
| 90 | - 'methods' => array( 'GET', 'POST' ), | |
| 111 | + // POST is required for save/cancel, GET for all others | |
| 112 | + 'methods' => array( 'POST', 'GET' ), | |
| 113 | + 'args' => array( | |
| 114 | + 'chart' => array( | |
| 115 | + 'required' => true, | |
| 116 | + 'sanitize_callback' => function( $param ) { | |
| 117 | + return is_numeric( $param ) ? $param : null; | |
| 118 | + }, | |
| 119 | + ), | |
| 120 | + 'type' => array( | |
| 121 | + 'required' => true, | |
| 122 | + 'type' => 'string', | |
| 123 | + 'enum' => array_merge( array( 'save', 'cancel' ), array_keys( $this->get_actions() ) ), | |
| 124 | + ), | |
| 125 | + ), | |
| 126 | + 'permission_callback' => function ( WP_REST_Request $request ) { | |
| 127 | + $chart_id = filter_var( sanitize_text_field( $request->get_param( 'chart' ), FILTER_VALIDATE_INT ) ); | |
| 128 | + if ( ! empty( $chart_id ) && in_array( $request->get_param( 'type' ), array( 'save', 'cancel' ), true ) ) { | |
| 129 | + // let save and cancel go without any check as past version of pro | |
| 130 | + // did not send the X-WP-Nonce | |
| 131 | + // we can change this at a later date. | |
| 132 | + return true; | |
| 133 | + } | |
| 134 | + return ! empty( $chart_id ) && apply_filters( 'visualizer_pro_show_chart', true, $chart_id ); | |
| 135 | + }, | |
| 91 | 136 | 'callback' => array( $this, 'perform_action' ), |
| 92 | 137 | ) |
| 93 | 138 | ); |
| 94 | 139 | } |
| @@ -98,17 +143,42 @@ | ||
| 98 | 143 | * |
| 99 | 144 | * @access private |
| 100 | 145 | */ |
| 101 | 146 | private function get_actions() { |
| 102 | - return apply_filters( | |
| 147 | + $actions = apply_filters( | |
| 103 | 148 | 'visualizer_action_buttons', |
| 104 | 149 | array( |
| 105 | - 'print' => __( 'Print', 'visualizer' ), | |
| 106 | - 'csv' => __( 'CSV', 'visualizer' ), | |
| 107 | - 'xls' => __( 'Excel', 'visualizer' ), | |
| 108 | - 'copy' => __( 'Copy', 'visualizer' ), | |
| 150 | + 'print' => array( | |
| 151 | + 'label' => esc_html__( 'Print', 'visualizer' ), | |
| 152 | + 'title' => esc_html__( 'Print Chart', 'visualizer' ), | |
| 153 | + ), | |
| 154 | + 'csv' => array( | |
| 155 | + 'label' => esc_html__( 'CSV', 'visualizer' ), | |
| 156 | + 'title' => esc_html__( 'Download as a CSV', 'visualizer' ), | |
| 157 | + ), | |
| 158 | + 'xls' => array( | |
| 159 | + 'label' => esc_html__( 'Excel', 'visualizer' ), | |
| 160 | + 'title' => esc_html__( 'Download as a spreadsheet', 'visualizer' ), | |
| 161 | + ), | |
| 162 | + 'copy' => array( | |
| 163 | + 'label' => esc_html__( 'Copy', 'visualizer' ), | |
| 164 | + 'title' => esc_html__( 'Copy data', 'visualizer' ), | |
| 165 | + ), | |
| 166 | + 'image' => array( | |
| 167 | + 'label' => esc_html__( 'Download', 'visualizer' ), | |
| 168 | + 'title' => esc_html__( 'Download as an image', 'visualizer' ), | |
| 169 | + ), | |
| 109 | 170 | ) |
| 110 | 171 | ); |
| 172 | + | |
| 173 | + // backward compatibility before label and title attributes were introduced. | |
| 174 | + if ( isset( $actions['edit'] ) && is_string( $actions['edit'] ) ) { | |
| 175 | + $actions['edit'] = array( | |
| 176 | + 'label' => esc_html__( 'Edit', 'visualizer' ), | |
| 177 | + 'title' => esc_html__( 'Edit data', 'visualizer' ), | |
| 178 | + ); | |
| 179 | + } | |
| 180 | + return $actions; | |
| 111 | 181 | } |
| 112 | 182 | |
| 113 | 183 | /** |
| 114 | 184 | * The print button |
| @@ -139,8 +209,23 @@ | ||
| 139 | 209 | break; |
| 140 | 210 | case 'xls': |
| 141 | 211 | $data = $this->_getDataAs( $chart_id, 'xls' ); |
| 142 | 212 | break; |
| 213 | + case 'image': | |
| 214 | + $settings = get_post_meta( $chart_id, Visualizer_Plugin::CF_SETTINGS, true ); | |
| 215 | + $title = 'visualizer#' . $chart_id; | |
| 216 | + if ( ! empty( $settings['title'] ) ) { | |
| 217 | + $title = $settings['title']; | |
| 218 | + } | |
| 219 | + // for ChartJS, title is an array. | |
| 220 | + if ( is_array( $title ) && isset( $title['text'] ) ) { | |
| 221 | + $title = $title['text']; | |
| 222 | + } | |
| 223 | + if ( empty( $title ) ) { | |
| 224 | + $title = 'visualizer#' . $chart_id; | |
| 225 | + } | |
| 226 | + $data = array( 'name' => $title ); | |
| 227 | + break; | |
| 143 | 228 | default: |
| 144 | 229 | $data = apply_filters( 'visualizer_action_data', $data, $chart_id, $type, $params, $this ); |
| 145 | 230 | break; |
| 146 | 231 | } |
| @@ -157,9 +242,8 @@ | ||
| 157 | 242 | * @access public |
| 158 | 243 | */ |
| 159 | 244 | public function enqueueScripts() { |
| 160 | 245 | wp_register_script( 'visualizer-customization', $this->get_user_customization_js(), array(), null, true ); |
| 161 | - wp_register_script( 'visualizer-clipboardjs', VISUALIZER_ABSURL . 'js/lib/clipboardjs/clipboard.min.js', array( 'jquery' ), Visualizer_Plugin::VERSION, true ); | |
| 162 | 246 | wp_register_style( 'visualizer-front', VISUALIZER_ABSURL . 'css/front.css', array(), Visualizer_Plugin::VERSION ); |
| 163 | 247 | do_action( 'visualizer_pro_frontend_load_resources' ); |
| 164 | 248 | } |
| 165 | 249 | |
| @@ -179,27 +263,32 @@ | ||
| 179 | 263 | public function renderChart( $atts ) { |
| 180 | 264 | global $wp_version; |
| 181 | 265 | $atts = shortcode_atts( |
| 182 | 266 | array( |
| 183 | - 'id' => false, // chart id | |
| 184 | - 'class' => false, // chart class | |
| 185 | - 'series' => false, // series filter hook | |
| 186 | - 'data' => false, // data filter hook | |
| 187 | - 'settings' => false, // data filter hook | |
| 267 | + // chart id | |
| 268 | + 'id' => false, | |
| 269 | + // chart class | |
| 270 | + 'class' => false, | |
| 271 | + // for lazy load | |
| 272 | + // set 'yes' to use the default intersection limit (300px) | |
| 273 | + // OR set a number (e.g. 700) to use 700px as the intersection limit | |
| 274 | + 'lazy' => apply_filters( 'visualizer_lazy_by_default', false, $atts['id'] ), | |
| 188 | 275 | ), |
| 189 | 276 | $atts |
| 190 | 277 | ); |
| 191 | 278 | |
| 192 | 279 | // if empty id or chart does not exists, then return empty string |
| 193 | - if ( ! $atts['id'] || ! ( $chart = get_post( $atts['id'] ) ) || $chart->post_type != Visualizer_Plugin::CPT_VISUALIZER ) { | |
| 280 | + if ( ! $atts['id'] || ! ( $chart = get_post( $atts['id'] ) ) || $chart->post_type !== Visualizer_Plugin::CPT_VISUALIZER ) { | |
| 194 | 281 | return ''; |
| 195 | 282 | } |
| 196 | 283 | |
| 284 | + // do not show the chart? | |
| 197 | 285 | if ( ! apply_filters( 'visualizer_pro_show_chart', true, $atts['id'] ) ) { |
| 198 | 286 | return ''; |
| 199 | 287 | } |
| 200 | 288 | |
| 201 | 289 | // in case revisions exist. |
| 290 | + // phpcs:ignore WordPress.CodeAnalysis.AssignmentInCondition.Found | |
| 202 | 291 | if ( true === ( $revisions = $this->undoRevisions( $chart->ID, true ) ) ) { |
| 203 | 292 | $chart = get_post( $chart->ID ); |
| 204 | 293 | } |
| 205 | 294 | |
| @@ -205,11 +294,21 @@ | ||
| 205 | 294 | |
| 206 | 295 | $id = 'visualizer-' . $atts['id']; |
| 207 | 296 | $defaultClass = 'visualizer-front'; |
| 208 | 297 | $class = apply_filters( Visualizer_Plugin::FILTER_CHART_WRAPPER_CLASS, $atts['class'], $atts['id'] ); |
| 209 | - $class = $defaultClass . ' ' . $class . ' ' . 'visualizer-front-' . $atts['id']; | |
| 210 | - $class = ! empty( $class ) ? ' class="' . trim( $class ) . '"' : ''; | |
| 211 | 298 | |
| 299 | + $lazyClass = $atts['lazy'] === 'yes' || ctype_digit( $atts['lazy'] ) ? 'visualizer-lazy' : ''; | |
| 300 | + | |
| 301 | + $class = sprintf( '%s %s %s %s', $defaultClass, $class, 'visualizer-front-' . $atts['id'], $lazyClass ); | |
| 302 | + $attributes = array(); | |
| 303 | + if ( ! empty( $class ) ) { | |
| 304 | + $attributes['class'] = trim( $class ); | |
| 305 | + } | |
| 306 | + | |
| 307 | + if ( ctype_digit( $atts['lazy'] ) ) { | |
| 308 | + $attributes['data-lazy-limit'] = $atts['lazy']; | |
| 309 | + } | |
| 310 | + | |
| 212 | 311 | $type = get_post_meta( $chart->ID, Visualizer_Plugin::CF_CHART_TYPE, true ); |
| 213 | 312 | |
| 214 | 313 | $chart = apply_filters( 'visualizer_schedule_refresh_chart', $chart, $chart->ID, false ); |
| 215 | 314 | |
| @@ -220,22 +319,14 @@ | ||
| 220 | 319 | } |
| 221 | 320 | |
| 222 | 321 | // handle series filter hooks |
| 223 | 322 | $series = apply_filters( Visualizer_Plugin::FILTER_GET_CHART_SERIES, get_post_meta( $chart->ID, Visualizer_Plugin::CF_SERIES, true ), $chart->ID, $type ); |
| 224 | - if ( ! empty( $atts['series'] ) ) { | |
| 225 | - $series = apply_filters( $atts['series'], $series, $chart->ID, $type ); | |
| 226 | - } | |
| 323 | + | |
| 227 | 324 | // handle settings filter hooks |
| 228 | 325 | $settings = apply_filters( Visualizer_Plugin::FILTER_GET_CHART_SETTINGS, $settings, $chart->ID, $type ); |
| 229 | - if ( ! empty( $atts['settings'] ) ) { | |
| 230 | - $settings = apply_filters( $atts['settings'], $settings, $chart->ID, $type ); | |
| 231 | - } | |
| 232 | 326 | |
| 233 | 327 | // handle data filter hooks |
| 234 | - $data = apply_filters( Visualizer_Plugin::FILTER_GET_CHART_DATA, unserialize( html_entity_decode( $chart->post_content ) ), $chart->ID, $type ); | |
| 235 | - if ( ! empty( $atts['data'] ) ) { | |
| 236 | - $data = apply_filters( $atts['data'], $data, $chart->ID, $type ); | |
| 237 | - } | |
| 328 | + $data = self::get_chart_data( $chart, $type ); | |
| 238 | 329 | |
| 239 | 330 | $css = ''; |
| 240 | 331 | $arguments = $this->get_inline_custom_css( $id, $settings ); |
| 241 | 332 | if ( ! empty( $arguments ) ) { |
| @@ -244,8 +335,15 @@ | ||
| 244 | 335 | } |
| 245 | 336 | |
| 246 | 337 | $library = $this->load_chart_type( $chart->ID ); |
| 247 | 338 | |
| 339 | + $id = $id . '-' . rand(); | |
| 340 | + | |
| 341 | + $amp = Visualizer_Plugin::instance()->getModule( Visualizer_Module_AMP::NAME ); | |
| 342 | + if ( $amp && $amp->is_amp() ) { | |
| 343 | + return '<div id="' . $id . '"' . $this->getHtmlAttributes( $attributes ) . '>' . $amp->get_chart( $chart, $data, $series, $settings ) . '</div>'; | |
| 344 | + } | |
| 345 | + | |
| 248 | 346 | // add chart to the array |
| 249 | 347 | $this->_charts[ $id ] = array( |
| 250 | 348 | 'type' => $type, |
| 251 | 349 | 'series' => $series, |
| @@ -253,33 +351,8 @@ | ||
| 253 | 351 | 'data' => $data, |
| 254 | 352 | 'library' => $library, |
| 255 | 353 | ); |
| 256 | 354 | |
| 257 | - wp_register_script( | |
| 258 | - "visualizer-render-$library", | |
| 259 | - VISUALIZER_ABSURL . 'js/render-facade.js', | |
| 260 | - apply_filters( 'visualizer_assets_render', array( 'jquery', 'visualizer-customization' ), true ), | |
| 261 | - Visualizer_Plugin::VERSION, | |
| 262 | - true | |
| 263 | - ); | |
| 264 | - | |
| 265 | - wp_enqueue_script( "visualizer-render-$library" ); | |
| 266 | - wp_localize_script( | |
| 267 | - "visualizer-render-$library", | |
| 268 | - 'visualizer', | |
| 269 | - array( | |
| 270 | - 'charts' => $this->_charts, | |
| 271 | - 'language' => $this->get_language(), | |
| 272 | - 'map_api_key' => get_option( 'visualizer-map-api-key' ), | |
| 273 | - 'rest_url' => version_compare( $wp_version, '4.7.0', '>=' ) ? rest_url( 'visualizer/v' . VISUALIZER_REST_VERSION . '/action/#id#/#type#/' ) : '', | |
| 274 | - 'i10n' => array( | |
| 275 | - 'copied' => __( 'Copied!', 'visualizer' ), | |
| 276 | - ), | |
| 277 | - 'page_type' => 'frontend', | |
| 278 | - ) | |
| 279 | - ); | |
| 280 | - wp_enqueue_style( 'visualizer-front' ); | |
| 281 | - | |
| 282 | 355 | $actions_div = ''; |
| 283 | 356 | $actions_visible = apply_filters( 'visualizer_pro_add_actions', isset( $settings['actions'] ) ? $settings['actions'] : array(), $atts['id'] ); |
| 284 | 357 | if ( ! empty( $actions_visible ) ) { |
| 285 | 358 | $actions = $this->get_actions(); |
| @@ -291,15 +364,16 @@ | ||
| 291 | 364 | $array = explode( ';', $action_type ); |
| 292 | 365 | $key = $array[0]; |
| 293 | 366 | $mime = end( $array ); |
| 294 | 367 | } |
| 295 | - $label = $actions[ $key ]; | |
| 296 | - $actions_div .= '<a href="#" class="visualizer-action visualizer-action-' . $key . '" data-visualizer-type="' . $key . '" data-visualizer-chart-id="' . $atts['id'] . '" data-visualizer-mime="' . $mime . '" title="' . $label . '" '; | |
| 368 | + $label = $actions[ $key ]['label']; | |
| 369 | + $title = $actions[ $key ]['title']; | |
| 370 | + $actions_div .= sprintf( '<a href="#" class="visualizer-action visualizer-action-%s" data-visualizer-type="%s" data-visualizer-chart-id="%s" data-visualizer-container-id="%s" data-visualizer-mime="%s" title="%s"', $key, $key, $atts['id'], $id, $mime, $title ); | |
| 297 | 371 | |
| 298 | 372 | if ( 'copy' === $key ) { |
| 299 | 373 | $copy = $this->_getDataAs( $atts['id'], 'csv' ); |
| 300 | 374 | $actions_div .= ' data-clipboard-text="' . esc_attr( $copy['csv'] ) . '"'; |
| 301 | - wp_enqueue_script( 'visualizer-clipboardjs' ); | |
| 375 | + wp_enqueue_script( 'clipboard' ); | |
| 302 | 376 | } |
| 303 | 377 | |
| 304 | 378 | $actions_div .= apply_filters( 'visualizer_action_attributes', '', $key, $atts['id'] ); |
| 305 | 379 | $actions_div .= '>' . $label . '</a> '; |
| @@ -309,8 +383,122 @@ | ||
| 309 | 383 | } |
| 310 | 384 | |
| 311 | 385 | $actions_div .= $css; |
| 312 | 386 | |
| 387 | + foreach ( $this->_charts as $id => $array ) { | |
| 388 | + $library = $array['library']; | |
| 389 | + wp_register_script( | |
| 390 | + "visualizer-render-$library", | |
| 391 | + VISUALIZER_ABSURL . 'js/render-facade.js', | |
| 392 | + apply_filters( 'visualizer_assets_render', array( 'jquery', 'visualizer-customization' ), true ), | |
| 393 | + Visualizer_Plugin::VERSION, | |
| 394 | + true | |
| 395 | + ); | |
| 396 | + | |
| 397 | + wp_enqueue_script( "visualizer-render-$library" ); | |
| 398 | + wp_localize_script( | |
| 399 | + "visualizer-render-$library", | |
| 400 | + 'visualizer', | |
| 401 | + array( | |
| 402 | + 'charts' => $this->_charts, | |
| 403 | + 'language' => $this->get_language(), | |
| 404 | + 'map_api_key' => get_option( 'visualizer-map-api-key' ), | |
| 405 | + 'rest_url' => version_compare( $wp_version, '4.7.0', '>=' ) ? rest_url( 'visualizer/v' . VISUALIZER_REST_VERSION . '/action/#id#/#type#/' ) : '', | |
| 406 | + 'wp_nonce' => wp_create_nonce( 'wp_rest' ), | |
| 407 | + 'i10n' => array( | |
| 408 | + 'copied' => __( 'The data has been copied to your clipboard. Hit Ctrl-V/Cmd-V in your spreadsheet editor to paste the data.', 'visualizer' ), | |
| 409 | + ), | |
| 410 | + 'page_type' => 'frontend', | |
| 411 | + 'is_front' => true, | |
| 412 | + ) | |
| 413 | + ); | |
| 414 | + wp_enqueue_style( 'visualizer-front' ); | |
| 415 | + } | |
| 416 | + | |
| 313 | 417 | // return placeholder div |
| 314 | - return $actions_div . '<div id="' . $id . '"' . $class . '></div>'; | |
| 418 | + return $actions_div . '<div id="' . $id . '"' . $this->getHtmlAttributes( $attributes ) . '></div>' . $this->addSchema( $chart->ID ); | |
| 419 | + } | |
| 420 | + | |
| 421 | + /** | |
| 422 | + * Converts the array of attributes to a string of HTML attributes. | |
| 423 | + * | |
| 424 | + * @since ? | |
| 425 | + * | |
| 426 | + * @access private | |
| 427 | + */ | |
| 428 | + private function getHtmlAttributes( $attributes ) { | |
| 429 | + $string = ''; | |
| 430 | + if ( ! $attributes ) { | |
| 431 | + return $string; | |
| 432 | + } | |
| 433 | + | |
| 434 | + foreach ( $attributes as $name => $value ) { | |
| 435 | + $string .= sprintf( '%s="%s"', esc_attr( $name ), esc_attr( $value ) ); | |
| 436 | + } | |
| 437 | + return $string; | |
| 438 | + } | |
| 439 | + | |
| 440 | + /** | |
| 441 | + * Adds the schema corresponding to the dataset. | |
| 442 | + * | |
| 443 | + * @since 3.3.2 | |
| 444 | + * | |
| 445 | + * @access private | |
| 446 | + */ | |
| 447 | + private function addSchema( $id ) { | |
| 448 | + // should we show informative errors as HTML comments? | |
| 449 | + $show_errors = apply_filters( 'visualizer_schema_show_errors', true, $id ); | |
| 450 | + | |
| 451 | + $settings = get_post_meta( $id, Visualizer_Plugin::CF_SETTINGS, true ); | |
| 452 | + $title = ''; | |
| 453 | + if ( isset( $settings['title'] ) && ! empty( $settings['title'] ) ) { | |
| 454 | + $title = $settings['title']; | |
| 455 | + if ( is_array( $title ) ) { | |
| 456 | + $title = $settings['title']['text']; | |
| 457 | + } | |
| 458 | + } | |
| 459 | + $title = apply_filters( 'visualizer_schema_name', $title, $id ); | |
| 460 | + if ( empty( $title ) ) { | |
| 461 | + if ( $show_errors ) { | |
| 462 | + return "<!-- Not showing structured data for chart $id because title is empty -->"; | |
| 463 | + } | |
| 464 | + return ''; | |
| 465 | + } | |
| 466 | + | |
| 467 | + $desc = ''; | |
| 468 | + if ( isset( $settings['description'] ) && ! empty( $settings['description'] ) ) { | |
| 469 | + $desc = $settings['description']; | |
| 470 | + } | |
| 471 | + $desc = apply_filters( 'visualizer_schema_description', $desc, $id ); | |
| 472 | + if ( empty( $desc ) ) { | |
| 473 | + if ( $show_errors ) { | |
| 474 | + return "<!-- Not showing structured data for chart $id because description is empty -->"; | |
| 475 | + } | |
| 476 | + return ''; | |
| 477 | + } | |
| 478 | + | |
| 479 | + // descriptions below 50 chars are not allowed. | |
| 480 | + if ( strlen( $desc ) < 50 ) { | |
| 481 | + if ( $show_errors ) { | |
| 482 | + return "<!-- Not showing structured data for chart $id because description is shorter than 50 characters -->"; | |
| 483 | + } | |
| 484 | + return ''; | |
| 485 | + } | |
| 486 | + | |
| 487 | + $schema = apply_filters( | |
| 488 | + 'visualizer_schema', | |
| 489 | + '{ | |
| 490 | + "@context":"https://schema.org/", | |
| 491 | + "@type":"Dataset", | |
| 492 | + "name":"' . esc_html( $title ) . '", | |
| 493 | + "description":"' . esc_html( $desc ) . '" | |
| 494 | + }', | |
| 495 | + $id | |
| 496 | + ); | |
| 497 | + | |
| 498 | + if ( empty( $schema ) ) { | |
| 499 | + return ''; | |
| 500 | + } | |
| 501 | + | |
| 502 | + return '<script type="application/ld+json">' . $schema . '</script>'; | |
| 315 | 503 | } |
| 316 | 504 | } |
