presentations.php
| 1 | <?php //phpcs:ignore WordPress.Files.FileName.InvalidClassFileName |
| 2 | /** |
| 3 | * Presentations |
| 4 | * Presentations plugin based on the work done by <a href="http://darylkoop.com/">Daryl Koopersmith</a>. Powered by jmpress.js |
| 5 | * |
| 6 | * HOW TO: How the plugin settings are organized and which features are supported. |
| 7 | * |
| 8 | * The entire presentation should be wrapped with a [presentation] shortcode, and every |
| 9 | * individual slide should be wrapped with a [slide] shortcode. Any settings supported |
| 10 | * by [slide] can be set into [presentation], which will apply that setting for the entire |
| 11 | * presentation unless overridden by individual slides. |
| 12 | * |
| 13 | * - [presentation] only settings: |
| 14 | * - duration: transition durations, default is one second. |
| 15 | * - height: content height, default is 400px |
| 16 | * - width: content width, default is 550px |
| 17 | * - autoplay: delay between transitions in seconds, default 3s |
| 18 | * when set the presentation will automatically transition between slides |
| 19 | * as long as the presentation remains in focus |
| 20 | * |
| 21 | * - [slide] settings: |
| 22 | * - transition: specifies where the next slide will be placed relative |
| 23 | * to the last one before it. Supported values are "up", "down" |
| 24 | * "left", "right", or "none". Default value is "down". |
| 25 | * |
| 26 | * - scale: scales the content relative to other slides, default value is one |
| 27 | * |
| 28 | * - rotate: rotates the content by the specified degrees, default is zero |
| 29 | * |
| 30 | * - fade: slides will fade in and out during transition. Values of "on" or |
| 31 | * "true" will enable fading, while values of "no" or "false" will |
| 32 | * disable it. Default value is "on" |
| 33 | * |
| 34 | * - bgcolor: specifies a background color for the slides. Any CSS valid value |
| 35 | * is permitted. Default color is transparent. |
| 36 | * |
| 37 | * - bgimg: specifies an image url which will fill the background. Image is |
| 38 | * set to fill the background 100% width and height |
| 39 | * |
| 40 | * - fadebullets: any html <li> tags will start out with an opacity of 0 and any |
| 41 | * subsequent slide transitions will show the bullets one by one |
| 42 | * |
| 43 | * Known issues: |
| 44 | * |
| 45 | * - IE 7/8 are not supported by jmpress and presentations will not work |
| 46 | * - IE 9 will not animate transitions at all, though it's possible to at least |
| 47 | * switch between slides. |
| 48 | * - Infinite Scroll themes will not load presentations properly unless the post |
| 49 | * happens to be on the first loaded page. The permalink page will function |
| 50 | * properly, however. |
| 51 | * - Exiting fullscreen mode will not properly reset the scroll locations in Safari |
| 52 | * |
| 53 | * @package automattic/jetpack |
| 54 | */ |
| 55 | |
| 56 | use Automattic\Jetpack\Assets; |
| 57 | |
| 58 | if ( ! class_exists( 'Presentations' ) ) : |
| 59 | /** |
| 60 | * Create a shortcode to display Presentations and slides. |
| 61 | */ |
| 62 | class Presentations { |
| 63 | |
| 64 | /** |
| 65 | * Presentation settings. |
| 66 | * |
| 67 | * @var array |
| 68 | */ |
| 69 | private $presentation_settings; |
| 70 | /** |
| 71 | * Do we have a Presentation shortcode to be displayed. |
| 72 | * |
| 73 | * @var bool |
| 74 | */ |
| 75 | private $presentation_initialized; |
| 76 | /** |
| 77 | * Were scripts and styles enqueued already. |
| 78 | * |
| 79 | * @var bool |
| 80 | */ |
| 81 | private $scripts_and_style_included; |
| 82 | |
| 83 | /** |
| 84 | * Constructor |
| 85 | */ |
| 86 | public function __construct() { |
| 87 | $this->presentation_initialized = false; |
| 88 | $this->scripts_and_style_included = false; |
| 89 | |
| 90 | // Registers shortcodes. |
| 91 | add_action( 'wp_head', array( $this, 'add_scripts' ), 1 ); |
| 92 | |
| 93 | add_shortcode( 'presentation', array( $this, 'presentation_shortcode' ) ); |
| 94 | add_shortcode( 'slide', array( $this, 'slide_shortcode' ) ); |
| 95 | } |
| 96 | |
| 97 | /** |
| 98 | * Enqueue all scripts and styles. |
| 99 | */ |
| 100 | public function add_scripts() { |
| 101 | $this->scripts_and_style_included = false; |
| 102 | |
| 103 | if ( empty( $GLOBALS['posts'] ) || ! is_array( $GLOBALS['posts'] ) ) { |
| 104 | return; |
| 105 | } |
| 106 | |
| 107 | foreach ( $GLOBALS['posts'] as $p ) { |
| 108 | if ( isset( $p->post_content ) && has_shortcode( $p->post_content, 'presentation' ) ) { |
| 109 | $this->scripts_and_style_included = true; |
| 110 | break; |
| 111 | } |
| 112 | } |
| 113 | |
| 114 | if ( ! $this->scripts_and_style_included ) { |
| 115 | return; |
| 116 | } |
| 117 | |
| 118 | $plugin = plugin_dir_url( __FILE__ ); |
| 119 | // Add CSS. |
| 120 | wp_enqueue_style( 'presentations', $plugin . 'css/style.css', array(), JETPACK__VERSION ); |
| 121 | // Add JavaScript. |
| 122 | wp_enqueue_script( 'jquery' ); |
| 123 | wp_enqueue_script( |
| 124 | 'jmpress', |
| 125 | Assets::get_file_url_for_environment( '_inc/build/shortcodes/js/jmpress.min.js', 'modules/shortcodes/js/jmpress.js' ), |
| 126 | array( 'jquery' ), |
| 127 | JETPACK__VERSION, |
| 128 | true |
| 129 | ); |
| 130 | wp_enqueue_script( |
| 131 | 'presentations', |
| 132 | Assets::get_file_url_for_environment( '_inc/build/shortcodes/js/main.min.js', 'modules/shortcodes/js/main.js' ), |
| 133 | array( 'jquery', 'jmpress' ), |
| 134 | JETPACK__VERSION, |
| 135 | true |
| 136 | ); |
| 137 | } |
| 138 | |
| 139 | /** |
| 140 | * Main Presentation shortcode. |
| 141 | * |
| 142 | * @param array $atts Shortcode attributes. |
| 143 | * @param string $content Post content. |
| 144 | */ |
| 145 | public function presentation_shortcode( $atts, $content = '' ) { |
| 146 | // Mark that we've found a valid [presentation] shortcode. |
| 147 | $this->presentation_initialized = true; |
| 148 | |
| 149 | $atts = shortcode_atts( |
| 150 | array( |
| 151 | 'duration' => '', |
| 152 | 'height' => '', |
| 153 | 'width' => '', |
| 154 | 'bgcolor' => '', |
| 155 | 'bgimg' => '', |
| 156 | 'autoplay' => '', |
| 157 | |
| 158 | // Settings. |
| 159 | 'transition' => '', |
| 160 | 'scale' => '', |
| 161 | 'rotate' => '', |
| 162 | 'fade' => '', |
| 163 | 'fadebullets' => '', |
| 164 | ), |
| 165 | $atts, |
| 166 | 'presentation' |
| 167 | ); |
| 168 | |
| 169 | $this->presentation_settings = array( |
| 170 | 'transition' => 'down', |
| 171 | 'scale' => 1, |
| 172 | 'rotate' => 0, |
| 173 | 'fade' => 'on', |
| 174 | 'fadebullets' => 0, |
| 175 | 'last' => array( |
| 176 | 'x' => 0, |
| 177 | 'y' => 0, |
| 178 | 'scale' => 1, |
| 179 | 'rotate' => 0, |
| 180 | ), |
| 181 | ); |
| 182 | |
| 183 | // Set the presentation-wide settings. |
| 184 | if ( '' !== trim( $atts['transition'] ) ) { |
| 185 | $this->presentation_settings['transition'] = $atts['transition']; |
| 186 | } |
| 187 | |
| 188 | if ( '' !== trim( $atts['scale'] ) ) { |
| 189 | $this->presentation_settings['scale'] = (float) $atts['scale']; |
| 190 | } |
| 191 | |
| 192 | if ( '' !== trim( $atts['rotate'] ) ) { |
| 193 | $this->presentation_settings['rotate'] = (float) $atts['rotate']; |
| 194 | } |
| 195 | |
| 196 | if ( '' !== trim( $atts['fade'] ) ) { |
| 197 | $this->presentation_settings['fade'] = $atts['fade']; |
| 198 | } |
| 199 | |
| 200 | if ( '' !== trim( $atts['fadebullets'] ) ) { |
| 201 | $this->presentation_settings['fadebullets'] = $atts['fadebullets']; |
| 202 | } |
| 203 | |
| 204 | // Set any settings the slides don't care about. |
| 205 | if ( '' !== trim( $atts['duration'] ) ) { |
| 206 | $duration = (float) $atts['duration'] . 's'; |
| 207 | } else { |
| 208 | $duration = '1s'; |
| 209 | } |
| 210 | |
| 211 | // Autoplay durations are set in milliseconds. |
| 212 | if ( '' !== trim( $atts['autoplay'] ) ) { |
| 213 | $autoplay = (float) $atts['autoplay'] * 1000; |
| 214 | } else { |
| 215 | $autoplay = 0; |
| 216 | } // No autoplay |
| 217 | |
| 218 | // Set the presentation size as specified or with some nicely sized dimensions. |
| 219 | if ( '' !== trim( $atts['width'] ) ) { |
| 220 | $this->presentation_settings['width'] = (int) $atts['width']; |
| 221 | } else { |
| 222 | $this->presentation_settings['width'] = 480; |
| 223 | } |
| 224 | |
| 225 | if ( '' !== trim( $atts['height'] ) ) { |
| 226 | $this->presentation_settings['height'] = (int) $atts['height']; |
| 227 | } else { |
| 228 | $this->presentation_settings['height'] = 370; |
| 229 | } |
| 230 | |
| 231 | // Hide the content by default in case the scripts fail. |
| 232 | $style = 'display: none; width: ' . $this->presentation_settings['width'] . 'px; height: ' . $this->presentation_settings['height'] . 'px;'; |
| 233 | |
| 234 | /* |
| 235 | * Check for background color XOR background image |
| 236 | * Use a white background if nothing specified |
| 237 | */ |
| 238 | if ( preg_match( '/https?\:\/\/[^\'"\s]*/', $atts['bgimg'], $matches ) ) { |
| 239 | $style .= ' background-image: url("' . esc_url( $matches[0] ) . '");'; |
| 240 | } elseif ( '' !== trim( $atts['bgcolor'] ) ) { |
| 241 | $style .= ' background-color: ' . esc_attr( $atts['bgcolor'] ) . ';'; |
| 242 | } else { |
| 243 | $style .= ' background-color: #fff;'; |
| 244 | } |
| 245 | |
| 246 | // Not supported message style is inlined incase the style sheet doesn't get included. |
| 247 | $out = "<section class='presentation-wrapper'>"; |
| 248 | $out .= "<p class='not-supported-msg' style='display: inherit; padding: 25%; text-align: center;'>"; |
| 249 | $out .= __( 'This slideshow could not be started. Try refreshing the page or viewing it in another browser.', 'jetpack' ) . '</p>'; |
| 250 | |
| 251 | $out .= sprintf( |
| 252 | '<div class="presentation" duration="%s" data-autoplay="%s" style="%s">', |
| 253 | esc_attr( $duration ), |
| 254 | esc_attr( $autoplay ), |
| 255 | esc_attr( $style ) |
| 256 | ); |
| 257 | $out .= "<div class='nav-arrow-left'></div>"; |
| 258 | $out .= "<div class='nav-arrow-right'></div>"; |
| 259 | $out .= "<div class='nav-fullscreen-button'></div>"; |
| 260 | |
| 261 | if ( $autoplay ) { |
| 262 | $out .= '<div class="autoplay-overlay" style="display: none;"><p class="overlay-msg">'; |
| 263 | $out .= __( 'Click to autoplay the presentation!', 'jetpack' ); |
| 264 | $out .= '</p></div>'; |
| 265 | } |
| 266 | |
| 267 | $out .= do_shortcode( $content ); |
| 268 | |
| 269 | $out .= '</section>'; |
| 270 | |
| 271 | $this->presentation_initialized = false; |
| 272 | |
| 273 | return $out; |
| 274 | } |
| 275 | |
| 276 | /** |
| 277 | * Slide shortcode. |
| 278 | * |
| 279 | * @param array $atts Shortcode attributes. |
| 280 | * @param string $content Post content. |
| 281 | */ |
| 282 | public function slide_shortcode( $atts, $content = '' ) { |
| 283 | // Bail out unless wrapped by a [presentation] shortcode. |
| 284 | if ( ! $this->presentation_initialized ) { |
| 285 | return $content; |
| 286 | } |
| 287 | |
| 288 | $atts = shortcode_atts( |
| 289 | array( |
| 290 | 'transition' => '', |
| 291 | 'scale' => '', |
| 292 | 'rotate' => '', |
| 293 | 'fade' => '', |
| 294 | 'fadebullets' => '', |
| 295 | 'bgcolor' => '', |
| 296 | 'bgimg' => '', |
| 297 | ), |
| 298 | $atts, |
| 299 | 'slide' |
| 300 | ); |
| 301 | |
| 302 | // Determine positioning based on transition. |
| 303 | if ( '' === trim( $atts['transition'] ) ) { |
| 304 | $atts['transition'] = $this->presentation_settings['transition']; |
| 305 | } |
| 306 | |
| 307 | // Setting the content scale. |
| 308 | if ( '' === trim( $atts['scale'] ) ) { |
| 309 | $atts['scale'] = $this->presentation_settings['scale']; |
| 310 | } |
| 311 | |
| 312 | if ( '' === trim( $atts['scale'] ) ) { |
| 313 | $scale = 1; |
| 314 | } else { |
| 315 | $scale = (float) $atts['scale']; |
| 316 | } |
| 317 | |
| 318 | if ( $scale < 0 ) { |
| 319 | $scale *= -1; |
| 320 | } |
| 321 | |
| 322 | // Setting the content rotation. |
| 323 | if ( '' === trim( $atts['rotate'] ) ) { |
| 324 | $atts['rotate'] = $this->presentation_settings['rotate']; |
| 325 | } |
| 326 | |
| 327 | if ( '' === trim( $atts['rotate'] ) ) { |
| 328 | $rotate = 0; |
| 329 | } else { |
| 330 | $rotate = (float) $atts['rotate']; |
| 331 | } |
| 332 | |
| 333 | // Setting if the content should fade. |
| 334 | if ( '' === trim( $atts['fade'] ) ) { |
| 335 | $atts['fade'] = $this->presentation_settings['fade']; |
| 336 | } |
| 337 | |
| 338 | if ( 'on' === $atts['fade'] || 'true' === $atts['fade'] ) { |
| 339 | $fade = 'fade'; |
| 340 | } else { |
| 341 | $fade = ''; |
| 342 | } |
| 343 | |
| 344 | // Setting if bullets should fade on step changes. |
| 345 | if ( '' === trim( $atts['fadebullets'] ) ) { |
| 346 | $atts['fadebullets'] = $this->presentation_settings['fadebullets']; |
| 347 | } |
| 348 | |
| 349 | if ( 'on' === $atts['fadebullets'] || 'true' === $atts['fadebullets'] ) { |
| 350 | $fadebullets = 'fadebullets'; |
| 351 | } else { |
| 352 | $fadebullets = ''; |
| 353 | } |
| 354 | |
| 355 | $coords = $this->get_coords( |
| 356 | array( |
| 357 | 'transition' => $atts['transition'], |
| 358 | 'scale' => $scale, |
| 359 | 'rotate' => $rotate, |
| 360 | ) |
| 361 | ); |
| 362 | |
| 363 | $x = $coords['x']; |
| 364 | $y = $coords['y']; |
| 365 | |
| 366 | /* |
| 367 | * Check for background color XOR background image |
| 368 | * Use a white background if nothing specified |
| 369 | */ |
| 370 | if ( preg_match( '/https?\:\/\/[^\'"\s]*/', $atts['bgimg'], $matches ) ) { |
| 371 | $style = 'background-image: url("' . esc_url( $matches[0] ) . '");'; |
| 372 | } elseif ( '' !== trim( $atts['bgcolor'] ) ) { |
| 373 | $style = 'background-color: ' . esc_attr( $atts['bgcolor'] ) . ';'; |
| 374 | } else { |
| 375 | $style = ''; |
| 376 | } |
| 377 | |
| 378 | // Put everything together and let jmpress do the magic! |
| 379 | $out = sprintf( |
| 380 | '<div class="step %s %s" data-x="%s" data-y="%s" data-scale="%s" data-rotate="%s" style="%s">', |
| 381 | esc_attr( $fade ), |
| 382 | esc_attr( $fadebullets ), |
| 383 | esc_attr( $x ), |
| 384 | esc_attr( $y ), |
| 385 | esc_attr( $scale ), |
| 386 | esc_attr( $rotate ), |
| 387 | esc_attr( $style ) |
| 388 | ); |
| 389 | |
| 390 | $out .= '<div class="slide-content">'; |
| 391 | $out .= do_shortcode( $content ); |
| 392 | $out .= '</div></div>'; |
| 393 | |
| 394 | return $out; |
| 395 | } |
| 396 | |
| 397 | /** |
| 398 | * Determines the position of the next slide based on the position and scaling of the previous slide. |
| 399 | * |
| 400 | * @param array $args { |
| 401 | * Array of key-value pairs. |
| 402 | * |
| 403 | * @type string $transition: the transition name, "up", "down", "left", or "right". |
| 404 | * @type float $scale: the scale of the next slide (used to determine the position of the slide after that). |
| 405 | * } |
| 406 | * |
| 407 | * @return array with the 'x' and 'y' coordinates of the slide. |
| 408 | */ |
| 409 | private function get_coords( $args ) { |
| 410 | if ( 0 === $args['scale'] ) { |
| 411 | $args['scale'] = 1; |
| 412 | } |
| 413 | |
| 414 | $width = $this->presentation_settings['width']; |
| 415 | $height = $this->presentation_settings['height']; |
| 416 | $last = $this->presentation_settings['last']; |
| 417 | $scale = $last['scale']; |
| 418 | |
| 419 | $next = array( |
| 420 | 'x' => $last['x'], |
| 421 | 'y' => $last['y'], |
| 422 | 'scale' => $args['scale'], |
| 423 | 'rotate' => $args['rotate'], |
| 424 | ); |
| 425 | |
| 426 | // All angles are measured from the vertical axis, so everything is backwards! |
| 427 | $diag_angle = atan2( $width, $height ); |
| 428 | $diagonal = sqrt( pow( $width, 2 ) + pow( $height, 2 ) ); |
| 429 | |
| 430 | /* |
| 431 | * We offset the angles by the angle formed by the diagonal so that |
| 432 | * we can multiply the sines directly against the diagonal length |
| 433 | */ |
| 434 | $theta = deg2rad( $last['rotate'] ) - $diag_angle; |
| 435 | $phi = deg2rad( $next['rotate'] ) - $diag_angle; |
| 436 | |
| 437 | // We start by displacing by the slide dimensions. |
| 438 | $total_horiz_disp = $width * $scale; |
| 439 | $total_vert_disp = $height * $scale; |
| 440 | |
| 441 | /* |
| 442 | * If the previous slide was rotated, we add the incremental offset from the rotation |
| 443 | * Namely the difference between the regular dimension (no rotation) and the component |
| 444 | * of the diagonal for that angle |
| 445 | */ |
| 446 | $total_horiz_disp += ( ( ( abs( sin( $theta ) ) * $diagonal ) - $width ) / 2 ) * $scale; |
| 447 | $total_vert_disp += ( ( ( abs( cos( $theta ) ) * $diagonal ) - $height ) / 2 ) * $scale; |
| 448 | |
| 449 | /* |
| 450 | * Similarly, we check if the current slide has been rotated and add whatever additional |
| 451 | * offset has been added. This is so that two rotated corners don't clash with each other. |
| 452 | * Note: we are checking the raw angle relative to the vertical axis, NOT the diagonal angle. |
| 453 | */ |
| 454 | if ( 0 !== $next['rotate'] % 180 ) { |
| 455 | $total_horiz_disp += ( abs( ( sin( $phi ) * $diagonal ) - $width ) / 2 ) * $next['scale']; |
| 456 | $total_vert_disp += ( abs( ( cos( $phi ) * $diagonal ) - $height ) / 2 ) * $next['scale']; |
| 457 | } |
| 458 | |
| 459 | switch ( trim( $args['transition'] ) ) { |
| 460 | case 'none': |
| 461 | break; |
| 462 | |
| 463 | case 'left': |
| 464 | $next['x'] -= $total_horiz_disp; |
| 465 | break; |
| 466 | |
| 467 | case 'right': |
| 468 | $next['x'] += $total_horiz_disp; |
| 469 | break; |
| 470 | |
| 471 | case 'up': |
| 472 | $next['y'] -= $total_vert_disp; |
| 473 | break; |
| 474 | |
| 475 | case 'down': |
| 476 | default: |
| 477 | $next['y'] += $total_vert_disp; |
| 478 | break; |
| 479 | } |
| 480 | |
| 481 | $this->presentation_settings['last'] = $next; |
| 482 | |
| 483 | return $next; |
| 484 | } |
| 485 | } |
| 486 | |
| 487 | $GLOBALS['presentations'] = new Presentations(); |
| 488 | endif; |
| 489 |