| 1 |
<?php //phpcs:ignore WordPress.Files.FileName.InvalidClassFileName |
| 2 |
|
| 3 |
use Automattic\Jetpack\Assets; |
| 4 |
|
| 5 |
/** |
| 6 |
* Brightcove shortcode. |
| 7 |
* |
| 8 |
* Brighcove had renovated their video player embedding code since they introduced their "new studio". |
| 9 |
* See https://support.brightcove.com/en/video-cloud/docs. |
| 10 |
* The new code is not 100% backward compatible, as long as a customized player is used. |
| 11 |
* By the time I wrote this, there were about 150000+ posts embedded legacy players, so it would be a bad |
| 12 |
* idea either to introduce a new brightcove shortcode, or to break those posts completely. |
| 13 |
* |
| 14 |
* That's why we introduce a less aggressive way: leaving the old embedding code untouched, and |
| 15 |
* introduce a new set of shortcode parameters which are translated to the latest Brightcove embedding code. |
| 16 |
* |
| 17 |
* e.g. |
| 18 |
* [brightcove video_id="12345" account_id="99999"] will be translated to the latest embedding code. |
| 19 |
* [brightcove exp=627045696&vid=1415670151] or [brightcove exp=1463233149&vref=1601200825] will be translated |
| 20 |
* to the legacy code. |
| 21 |
*/ |
| 22 |
class Jetpack_Brightcove_Shortcode { |
| 23 |
/** |
| 24 |
* Shortcode name. |
| 25 |
* |
| 26 |
* @var string |
| 27 |
*/ |
| 28 |
public static $shortcode = 'brightcove'; |
| 29 |
|
| 30 |
/** |
| 31 |
* Parse shortcode arguments and render its output. |
| 32 |
* |
| 33 |
* @since 4.5.0 |
| 34 |
* |
| 35 |
* @param array $atts Shortcode parameters. |
| 36 |
* |
| 37 |
* @return string |
| 38 |
*/ |
| 39 |
public static function convert( $atts ) { |
| 40 |
$normalized_atts = self::normalize_attributes( $atts ); |
| 41 |
|
| 42 |
if ( empty( $atts ) ) { |
| 43 |
return '<!-- Missing Brightcove parameters -->'; |
| 44 |
} |
| 45 |
|
| 46 |
return self::has_legacy_atts( $normalized_atts ) |
| 47 |
? self::convert_to_legacy_studio( $normalized_atts ) |
| 48 |
: self::convert_to_new_studio( $normalized_atts ); |
| 49 |
} |
| 50 |
|
| 51 |
/** |
| 52 |
* We need to take care of two kinds of shortcode format here. |
| 53 |
* The latest: [shortcode a=1 b=2] and the legacy: [shortcode a=1&b=2] |
| 54 |
* For an old shortcode: [shortcode a=1&b=2&c=3], it would be parsed into array( 'a' => 1&b=2&c=3' ), which is useless. |
| 55 |
* However, since we want to determine whether to call convert_to_legacy_studio() or convert_to_new_studio() via passed parameters, we still need to parse the two properly. |
| 56 |
* See https://jetpack.wp-a2z.org/oik_api/shortcode_new_to_old_params/ |
| 57 |
* |
| 58 |
* @since 4.5.0 |
| 59 |
* |
| 60 |
* @param array $atts Shortcode parameters. |
| 61 |
* |
| 62 |
* @return array |
| 63 |
*/ |
| 64 |
public static function normalize_attributes( $atts ) { |
| 65 |
if ( is_array( $atts ) && 1 === count( $atts ) ) { // this is the case we need to take care of. |
| 66 |
$parsed_atts = array(); |
| 67 |
$params = shortcode_new_to_old_params( $atts ); |
| 68 |
|
| 69 |
/** |
| 70 |
* Filter the Brightcove shortcode parameters. |
| 71 |
* |
| 72 |
* @module shortcodes |
| 73 |
* |
| 74 |
* @since 4.5.0 |
| 75 |
* |
| 76 |
* @param string $params String of shortcode parameters. |
| 77 |
*/ |
| 78 |
$params = apply_filters( 'brightcove_dimensions', $params ); |
| 79 |
parse_str( $params, $parsed_atts ); |
| 80 |
|
| 81 |
return $parsed_atts; |
| 82 |
} else { |
| 83 |
return $atts; |
| 84 |
} |
| 85 |
} |
| 86 |
|
| 87 |
/** |
| 88 |
* Check that it has legacy attributes. |
| 89 |
* |
| 90 |
* @since 4.5.0 |
| 91 |
* |
| 92 |
* @param array $atts Shortcode parameters. |
| 93 |
* |
| 94 |
* @return bool |
| 95 |
*/ |
| 96 |
public static function has_legacy_atts( $atts ) { |
| 97 |
return ( isset( $atts['vid'] ) || isset( $atts['vref'] ) ) |
| 98 |
&& ( isset( $atts['exp'] ) || isset( $atts['exp3'] ) ); |
| 99 |
} |
| 100 |
|
| 101 |
/** |
| 102 |
* Convert to latest player format. |
| 103 |
* |
| 104 |
* @since 4.5.0 |
| 105 |
* |
| 106 |
* @param array $atts Shortcode parameters. |
| 107 |
* |
| 108 |
* @return string |
| 109 |
*/ |
| 110 |
public static function convert_to_new_studio( $atts ) { |
| 111 |
$defaults = array( |
| 112 |
'account_id' => '', |
| 113 |
'video_id' => '', |
| 114 |
'player_id' => 'default', |
| 115 |
'width' => '100%', |
| 116 |
'height' => '100%', |
| 117 |
); |
| 118 |
|
| 119 |
$atts_applied = shortcode_atts( $defaults, $atts, self::$shortcode ); |
| 120 |
|
| 121 |
$player_url = sprintf( |
| 122 |
'//players.brightcove.net/%s/%s_default/index.html?videoId=%s', |
| 123 |
esc_attr( $atts_applied['account_id'] ), |
| 124 |
esc_attr( $atts_applied['player_id'] ), |
| 125 |
esc_attr( $atts_applied['video_id'] ) |
| 126 |
); |
| 127 |
|
| 128 |
$output_html = sprintf( |
| 129 |
'<iframe src="' . esc_url( $player_url ) . '" allowfullscreen webkitallowfullscreen mozallowfullscreen style="width: %spx; height: %spx;"></iframe>', |
| 130 |
esc_attr( $atts_applied['width'] ), |
| 131 |
esc_attr( $atts_applied['height'] ) |
| 132 |
); |
| 133 |
|
| 134 |
return $output_html; |
| 135 |
} |
| 136 |
|
| 137 |
/** |
| 138 |
* Convert to legacy player format. |
| 139 |
* |
| 140 |
* [brightcove exp=627045696&vid=1415670151] for the older player and backward compatibility |
| 141 |
* [brightcove exp=1463233149&vref=1601200825] for the new player |
| 142 |
* |
| 143 |
* @since 4.5.0 |
| 144 |
* |
| 145 |
* @param array $atts Shortcode parameters. |
| 146 |
* |
| 147 |
* @return string |
| 148 |
*/ |
| 149 |
public static function convert_to_legacy_studio( $atts ) { |
| 150 |
$attr = shortcode_atts( |
| 151 |
array( |
| 152 |
'bg' => '', |
| 153 |
'exp' => '', |
| 154 |
'exp3' => '', |
| 155 |
'h' => '', |
| 156 |
'lbu' => '', |
| 157 |
'pk' => '', |
| 158 |
'pubid' => '', |
| 159 |
's' => '', |
| 160 |
'surl' => '', |
| 161 |
'vid' => '', |
| 162 |
'vref' => '', |
| 163 |
'w' => '', |
| 164 |
), |
| 165 |
$atts |
| 166 |
); |
| 167 |
|
| 168 |
if ( isset( $attr['pk'] ) ) { |
| 169 |
$attr['pk'] = rawurlencode( preg_replace( '/[^a-zA-Z0-9!*\'();:@&=+$,\/?#\[\]\-_.~ ]/', '', $attr['pk'] ) ); |
| 170 |
} |
| 171 |
|
| 172 |
if ( isset( $attr['bg'] ) ) { |
| 173 |
$attr['bg'] = preg_replace( '![^-a-zA-Z0-9#]!', '', $attr['bg'] ); |
| 174 |
} |
| 175 |
|
| 176 |
$fv = array( |
| 177 |
'viewerSecureGatewayURL' => 'https://services.brightcove.com/services/amfgateway', |
| 178 |
'servicesURL' => 'http://services.brightcove.com/services', |
| 179 |
'cdnURL' => 'http://admin.brightcove.com', |
| 180 |
'autoStart' => 'false', |
| 181 |
); |
| 182 |
|
| 183 |
$js_tld = 'com'; |
| 184 |
$src = ''; |
| 185 |
$name = 'flashObj'; |
| 186 |
$html5 = false; |
| 187 |
|
| 188 |
if ( isset( $attr['exp3'] ) ) { |
| 189 |
if ( isset( $attr['surl'] ) && strpos( $attr['surl'], 'brightcove.co.jp' ) ) { |
| 190 |
$js_tld = 'co.jp'; |
| 191 |
} |
| 192 |
if ( ! isset( $attr['surl'] ) || ! preg_match( '#^https?://(?:[a-z\d-]+\.)*brightcove\.(?:com|co\.jp)/#', $attr['surl'] ) ) { |
| 193 |
$attr['surl'] = 'http://c.brightcove.com/services'; |
| 194 |
} |
| 195 |
|
| 196 |
$attr['exp3'] = intval( $attr['exp3'] ); |
| 197 |
$attr['pubid'] = intval( $attr['pubid'] ); |
| 198 |
$attr['vid'] = intval( $attr['vid'] ); |
| 199 |
|
| 200 |
$fv['servicesURL'] = $attr['surl']; |
| 201 |
$fv['playerID'] = $attr['exp3']; |
| 202 |
$fv['domain'] = 'embed'; |
| 203 |
$fv['videoID'] = intval( $attr['vid'] ); |
| 204 |
|
| 205 |
$src = sprintf( |
| 206 |
'%s/viewer/federated_f9/%s?isVid=1&isUI=1&publisherID=%s', |
| 207 |
$attr['surl'], |
| 208 |
$attr['exp3'], |
| 209 |
$attr['pubid'] |
| 210 |
); |
| 211 |
$html5 = true; |
| 212 |
} elseif ( isset( $attr['exp'] ) ) { |
| 213 |
$attr['exp'] = intval( $attr['exp'] ); |
| 214 |
$src = 'http://services.brightcove.com/services/viewer/federated_f8/' . $attr['exp']; |
| 215 |
if ( $attr['vid'] ) { |
| 216 |
$fv['videoId'] = $attr['vid']; |
| 217 |
} elseif ( $attr['vref'] ) { |
| 218 |
$fv['videoRef'] = $attr['vref']; |
| 219 |
} |
| 220 |
|
| 221 |
$fv['playerId'] = $attr['exp']; |
| 222 |
$fv['domain'] = 'embed'; |
| 223 |
} else { |
| 224 |
return '<small>brightcove error: missing required parameter exp or exp3</small>'; |
| 225 |
} |
| 226 |
|
| 227 |
if ( ! empty( $attr['lbu'] ) ) { |
| 228 |
$fv['linkBaseURL'] = $attr['lbu']; |
| 229 |
} |
| 230 |
|
| 231 |
$flashvars = trim( add_query_arg( array_map( 'urlencode', $fv ), '' ), '?' ); |
| 232 |
|
| 233 |
$width = null; |
| 234 |
$height = null; |
| 235 |
|
| 236 |
if ( ! empty( $attr['w'] ) && ! empty( $attr['h'] ) ) { |
| 237 |
$w = abs( (int) $attr['w'] ); |
| 238 |
$h = abs( (int) $attr['h'] ); |
| 239 |
if ( $w && $h ) { |
| 240 |
$width = $w; |
| 241 |
$height = $h; |
| 242 |
} |
| 243 |
} elseif ( empty( $attr['s'] ) || 'l' === $attr['s'] ) { |
| 244 |
$width = '480'; |
| 245 |
$height = '360'; |
| 246 |
} |
| 247 |
|
| 248 |
if ( empty( $width ) || empty( $height ) ) { |
| 249 |
$width = '280'; |
| 250 |
$height = '210'; |
| 251 |
} |
| 252 |
|
| 253 |
if ( $html5 ) { |
| 254 |
wp_enqueue_script( |
| 255 |
'brightcove-loader', |
| 256 |
Assets::get_file_url_for_environment( '_inc/build/shortcodes/js/brightcove.min.js', 'modules/shortcodes/js/brightcove.js' ), |
| 257 |
array( 'jquery' ), |
| 258 |
20121127, |
| 259 |
false |
| 260 |
); |
| 261 |
wp_localize_script( |
| 262 |
'brightcove-loader', |
| 263 |
'brightcoveData', |
| 264 |
array( |
| 265 |
'tld' => esc_js( $js_tld ), |
| 266 |
) |
| 267 |
); |
| 268 |
|
| 269 |
return ' |
| 270 |
<object id="myExperience" class="BrightcoveExperience"> |
| 271 |
<param name="bgcolor" value="' . esc_attr( $attr['bg'] ) . '" /> |
| 272 |
<param name="width" value="' . esc_attr( $width ) . '" /> |
| 273 |
<param name="height" value="' . esc_attr( $height ) . '" /> |
| 274 |
<param name="playerID" value="' . esc_attr( $attr['exp3'] ) . '" /> |
| 275 |
<param name="@videoPlayer" value="' . esc_attr( $attr['vid'] ) . '" /> |
| 276 |
<param name="playerKey" value="' . esc_attr( $attr['pk'] ) . '" /> |
| 277 |
<param name="isVid" value="1" /> |
| 278 |
<param name="isUI" value="1" /> |
| 279 |
<param name="dynamicStreaming" value="true" /> |
| 280 |
<param name="autoStart" value="false" /> |
| 281 |
<param name="secureConnections" value="true" /> |
| 282 |
<param name="secureHTMLConnections" value="true" /> |
| 283 |
</object>'; |
| 284 |
} |
| 285 |
|
| 286 |
return sprintf( |
| 287 |
'<embed src="%s" bgcolor="#FFFFFF" flashvars="%s" base="http://admin.brightcove.com" name="%s" width="%s" height="%s" allowFullScreen="true" seamlesstabbing="false" type="application/x-shockwave-flash" swLiveConnect="true" pluginspage="http://www.macromedia.com/shockwave/download/index.cgi?P1_Prod_Version=ShockwaveFlash" />', |
| 288 |
esc_url( $src ), |
| 289 |
$flashvars, |
| 290 |
esc_attr( $name ), |
| 291 |
esc_attr( $width ), |
| 292 |
esc_attr( $height ) |
| 293 |
); |
| 294 |
} |
| 295 |
} |
| 296 |
|
| 297 |
add_shortcode( Jetpack_Brightcove_Shortcode::$shortcode, array( 'Jetpack_Brightcove_Shortcode', 'convert' ) ); |
| 298 |
|
