| 1 |
<?php |
| 2 |
/** |
| 3 |
* VR Viewer Shortcode |
| 4 |
* converts [vr] shortcode to an iframe viewer hosted on vr.me.sh |
| 5 |
* |
| 6 |
* @package automattic/jetpack |
| 7 |
*/ |
| 8 |
|
| 9 |
/** |
| 10 |
* Scrub URL paramaters for VR viewer |
| 11 |
* |
| 12 |
* @param array $params { |
| 13 |
* parameter array which is passed to the jetpack_vr_viewer. |
| 14 |
* |
| 15 |
* @type string $url url of 360 media |
| 16 |
* @type string $guid guid for videopress |
| 17 |
* @type string $view cinema, 360 - controls if panaroma view, or 360 |
| 18 |
* @type string $rotation number for rotating media |
| 19 |
* @type string $preview show preview image or not |
| 20 |
* } |
| 21 |
* |
| 22 |
* @return array|false $url_params Array of URL parameters. |
| 23 |
*/ |
| 24 |
function jetpack_vr_viewer_get_viewer_url_params( $params ) { |
| 25 |
$url_params = array(); |
| 26 |
|
| 27 |
if ( isset( $params['rotation'] ) ) { |
| 28 |
$url_params['rotation'] = (int) $params['rotation']; |
| 29 |
} |
| 30 |
|
| 31 |
if ( isset( $params['view'] ) && in_array( $params['view'], array( 'cinema', '360' ), true ) ) { |
| 32 |
$url_params['view'] = $params['view']; |
| 33 |
} |
| 34 |
|
| 35 |
if ( isset( $params['preview'] ) && $params['preview'] ) { |
| 36 |
$url_params['preview'] = 1; |
| 37 |
} |
| 38 |
|
| 39 |
if ( isset( $params['url'] ) ) { |
| 40 |
return array_merge( $url_params, array( 'url' => $params['url'] ) ); |
| 41 |
} elseif ( isset( $params['guid'] ) ) { |
| 42 |
return array_merge( $url_params, array( 'guid' => $params['guid'] ) ); |
| 43 |
} |
| 44 |
|
| 45 |
return false; |
| 46 |
} |
| 47 |
|
| 48 |
/** |
| 49 |
* Get padding for IFRAME depending on view type |
| 50 |
* |
| 51 |
* @param string $view string cinema, 360 - default cinema. |
| 52 |
* |
| 53 |
* @return string $css padding |
| 54 |
*/ |
| 55 |
function jetpack_vr_viewer_iframe_padding( $view ) { |
| 56 |
if ( '360' === $view ) { |
| 57 |
return '100%'; // 1:1 square aspect for 360 |
| 58 |
} |
| 59 |
|
| 60 |
return '50%'; // 2:1 panorama aspect |
| 61 |
} |
| 62 |
|
| 63 |
/** |
| 64 |
* Create HTML for VR Viewer IFRAME and wrapper |
| 65 |
* The viewer code is hosted on vr.me.sh site which is then displayed |
| 66 |
* within posts via an IFRAME. This function returns the IFRAME html. |
| 67 |
* |
| 68 |
* @param array $url_params { |
| 69 |
* parameter array which is passed to the jetpack_vr_viewer. |
| 70 |
* |
| 71 |
* @type string $url url of 360 media |
| 72 |
* @type string $guid guid for videopress |
| 73 |
* @type string $view cinema, 360 - controls if panaroma view, or 360 |
| 74 |
* @type string $rotation number for rotating media |
| 75 |
* @type string $preview show preview image or not |
| 76 |
* } |
| 77 |
* |
| 78 |
* @return string $rtn an iframe for viewer. |
| 79 |
*/ |
| 80 |
function jetpack_vr_viewer_get_html( $url_params ) { |
| 81 |
global $content_width; |
| 82 |
|
| 83 |
$iframe = add_query_arg( $url_params, 'https://vr.me.sh/view/' ); |
| 84 |
|
| 85 |
// set some defaults. |
| 86 |
$maxwidth = ( isset( $content_width ) ) ? $content_width : 720; |
| 87 |
$view = ( isset( $url_params['view'] ) ) ? $url_params['view'] : 'cinema'; |
| 88 |
|
| 89 |
$rtn = '<div style="position: relative; max-width: ' . $maxwidth . 'px; margin-left: auto; margin-right: auto; overflow: hidden; margin-bottom: 1em;">'; |
| 90 |
$rtn .= '<div style="padding-top: ' . jetpack_vr_viewer_iframe_padding( $view ) . ';"></div>'; |
| 91 |
$rtn .= '<iframe style="position: absolute; top: 0; right: 0; bottom: 0; left: 0; height: 100%" allowfullscreen="true" frameborder="0" width="100%" height="300" src="' . esc_url( $iframe ) . '">'; |
| 92 |
$rtn .= '</iframe>'; |
| 93 |
$rtn .= '</div>'; |
| 94 |
|
| 95 |
return $rtn; |
| 96 |
} |
| 97 |
|
| 98 |
/** |
| 99 |
* Convert [vr] shortcode to viewer |
| 100 |
* |
| 101 |
* Shortcode example: |
| 102 |
* [vr url="https://en-blog.files.wordpress.com/2016/12/regents_park.jpg" view="360"] |
| 103 |
* |
| 104 |
* VR Viewer embed code: |
| 105 |
* <div style="position: relative; max-width: 720px; margin-left: auto; margin-right: auto; overflow: hidden;"> |
| 106 |
* <div style="padding-top: 100%;"></div> |
| 107 |
* <iframe style="position: absolute; top: 0; right: 0; bottom: 0; left: 0; height: 100%" allowfullscreen="true" frameborder="0" width="100%" height="400" src="https://vr.me.sh/view/?view=360&url=https://en-blog.files.wordpress.com/2016/12/regents_park.jpg"> |
| 108 |
* </iframe> |
| 109 |
* </div> |
| 110 |
* |
| 111 |
* @param array $atts Shortcode attributes. |
| 112 |
* |
| 113 |
* @return html - complete vr viewer html |
| 114 |
*/ |
| 115 |
function jetpack_vr_viewer_shortcode( $atts ) { |
| 116 |
$params = shortcode_atts( |
| 117 |
array( |
| 118 |
0 => null, |
| 119 |
'url' => null, |
| 120 |
'src' => null, |
| 121 |
'guid' => null, |
| 122 |
'rotation' => null, |
| 123 |
'view' => null, |
| 124 |
'preview' => false, |
| 125 |
), |
| 126 |
$atts |
| 127 |
); |
| 128 |
|
| 129 |
// We offer a few ways to specify the URL. |
| 130 |
if ( $params[0] ) { |
| 131 |
$params['url'] = $params[0]; |
| 132 |
} elseif ( $params['src'] ) { |
| 133 |
$params['url'] = $params['src']; |
| 134 |
} |
| 135 |
|
| 136 |
$url_params = jetpack_vr_viewer_get_viewer_url_params( $params ); |
| 137 |
if ( $url_params ) { |
| 138 |
return jetpack_vr_viewer_get_html( $url_params ); |
| 139 |
} |
| 140 |
|
| 141 |
// add check for user. |
| 142 |
if ( current_user_can( 'edit_posts' ) ) { |
| 143 |
return '[vr] shortcode requires a data source to be given'; |
| 144 |
} else { |
| 145 |
return ''; |
| 146 |
} |
| 147 |
} |
| 148 |
add_shortcode( 'vr', 'jetpack_vr_viewer_shortcode' ); |
| 149 |
|
