Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
29.00%
29 / 100
40.00%
2 / 5
 CRAP
0.00%
0 / 1
Jetpack_Brightcove_Shortcode
29.90%
29 / 97
40.00%
2 / 5
 222.44
0.00%
0 / 1
 convert
83.33%
5 / 6
0.00%
0 / 1
 3.04
 normalize_attributes
28.57%
2 / 7
0.00%
0 / 1
 6.28
 has_legacy_atts
100.00%
2 / 2
100.00%
1 / 1
 4
 convert_to_new_studio
100.00%
20 / 20
100.00%
1 / 1
 1
 convert_to_legacy_studio
0.00%
0 / 62
0.00%
0 / 1
 182
1<?php //phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2
3use Automattic\Jetpack\Assets;
4
5if ( ! defined( 'ABSPATH' ) ) {
6    exit( 0 );
7}
8
9/**
10 * Brightcove shortcode.
11 *
12 * Brighcove had renovated their video player embedding code since they introduced their "new studio".
13 * See https://support.brightcove.com/en/video-cloud/docs.
14 * The new code is not 100% backward compatible, as long as a customized player is used.
15 * By the time I wrote this, there were about 150000+ posts embedded legacy players, so it would be a bad
16 * idea either to introduce a new brightcove shortcode, or to break those posts completely.
17 *
18 * That's why we introduce a less aggressive way: leaving the old embedding code untouched, and
19 * introduce a new set of shortcode parameters which are translated to the latest Brightcove embedding code.
20 *
21 * e.g.
22 * [brightcove video_id="12345" account_id="99999"] will be translated to the latest embedding code.
23 * [brightcove exp=627045696&vid=1415670151] or [brightcove exp=1463233149&vref=1601200825] will be translated
24 * to the legacy code.
25 */
26class Jetpack_Brightcove_Shortcode {
27    /**
28     * Shortcode name.
29     *
30     * @var string
31     */
32    public static $shortcode = 'brightcove';
33
34    /**
35     * Parse shortcode arguments and render its output.
36     *
37     * @since 4.5.0
38     *
39     * @param array $atts Shortcode parameters.
40     *
41     * @return string
42     */
43    public static function convert( $atts ) {
44        $normalized_atts = self::normalize_attributes( $atts );
45
46        if ( empty( $atts ) ) {
47            return '<!-- Missing Brightcove parameters -->';
48        }
49
50        return self::has_legacy_atts( $normalized_atts )
51            ? self::convert_to_legacy_studio( $normalized_atts )
52            : self::convert_to_new_studio( $normalized_atts );
53    }
54
55    /**
56     * We need to take care of two kinds of shortcode format here.
57     * The latest: [shortcode a=1 b=2] and the legacy: [shortcode a=1&b=2]
58     * 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.
59     * 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.
60     * See https://jetpack.wp-a2z.org/oik_api/shortcode_new_to_old_params/
61     *
62     * @since 4.5.0
63     *
64     * @param array $atts Shortcode parameters.
65     *
66     * @return array
67     */
68    public static function normalize_attributes( $atts ) {
69        if ( is_array( $atts ) && 1 === count( $atts ) ) { // this is the case we need to take care of.
70            $parsed_atts = array();
71            $params      = shortcode_new_to_old_params( $atts );
72
73            /**
74             * Filter the Brightcove shortcode parameters.
75             *
76             * @module shortcodes
77             *
78             * @since 4.5.0
79             *
80             * @param string $params String of shortcode parameters.
81             */
82            $params = apply_filters( 'brightcove_dimensions', $params );
83            parse_str( $params, $parsed_atts );
84
85            return $parsed_atts;
86        } else {
87            return $atts;
88        }
89    }
90
91    /**
92     * Check that it has legacy attributes.
93     *
94     * @since 4.5.0
95     *
96     * @param array $atts Shortcode parameters.
97     *
98     * @return bool
99     */
100    public static function has_legacy_atts( $atts ) {
101        return ( isset( $atts['vid'] ) || isset( $atts['vref'] ) )
102            && ( isset( $atts['exp'] ) || isset( $atts['exp3'] ) );
103    }
104
105    /**
106     * Convert to latest player format.
107     *
108     * @since 4.5.0
109     *
110     * @param array $atts Shortcode parameters.
111     *
112     * @return string
113     */
114    public static function convert_to_new_studio( $atts ) {
115        $defaults = array(
116            'account_id' => '',
117            'video_id'   => '',
118            'player_id'  => 'default',
119            'width'      => '100%',
120            'height'     => '100%',
121        );
122
123        $atts_applied = shortcode_atts( $defaults, $atts, self::$shortcode );
124
125        $player_url = sprintf(
126            '//players.brightcove.net/%s/%s_default/index.html?videoId=%s',
127            esc_attr( $atts_applied['account_id'] ),
128            esc_attr( $atts_applied['player_id'] ),
129            esc_attr( $atts_applied['video_id'] )
130        );
131
132        $output_html = sprintf(
133            '<iframe src="' . esc_url( $player_url ) . '" allowfullscreen webkitallowfullscreen mozallowfullscreen style="width: %spx; height: %spx;"></iframe>',
134            esc_attr( $atts_applied['width'] ),
135            esc_attr( $atts_applied['height'] )
136        );
137
138        return $output_html;
139    }
140
141    /**
142     * Convert to legacy player format.
143     *
144     * [brightcove exp=627045696&vid=1415670151] for the older player and backward compatibility
145     * [brightcove exp=1463233149&vref=1601200825] for the new player
146     *
147     * @since 4.5.0
148     *
149     * @param array $atts Shortcode parameters.
150     *
151     * @return string
152     */
153    public static function convert_to_legacy_studio( $atts ) {
154        $attr = shortcode_atts(
155            array(
156                'bg'    => '',
157                'exp'   => '',
158                'exp3'  => '',
159                'h'     => '',
160                'lbu'   => '',
161                'pk'    => '',
162                'pubid' => '',
163                's'     => '',
164                'surl'  => '',
165                'vid'   => '',
166                'vref'  => '',
167                'w'     => '',
168            ),
169            $atts
170        );
171
172        if ( isset( $attr['pk'] ) ) {
173            $attr['pk'] = rawurlencode( preg_replace( '/[^a-zA-Z0-9!*\'();:@&=+$,\/?#\[\]\-_.~ ]/', '', $attr['pk'] ) );
174        }
175
176        if ( isset( $attr['bg'] ) ) {
177            $attr['bg'] = preg_replace( '![^-a-zA-Z0-9#]!', '', $attr['bg'] );
178        }
179
180        $js_tld = 'com';
181        if ( isset( $attr['surl'] ) && strpos( $attr['surl'], 'brightcove.co.jp' ) ) {
182            $js_tld = 'co.jp';
183        }
184
185        $attr['exp3'] = (int) $attr['exp3'];
186        $attr['vid']  = (int) $attr['vid'];
187
188        $width  = null;
189        $height = null;
190
191        if ( ! empty( $attr['w'] ) && ! empty( $attr['h'] ) ) {
192            $w = abs( (int) $attr['w'] );
193            $h = abs( (int) $attr['h'] );
194            if ( $w && $h ) {
195                $width  = $w;
196                $height = $h;
197            }
198        } elseif ( empty( $attr['s'] ) || 'l' === $attr['s'] ) {
199            $width  = '480';
200            $height = '360';
201        }
202
203        if ( empty( $width ) || empty( $height ) ) {
204            $width  = '280';
205            $height = '210';
206        }
207
208        wp_enqueue_script(
209            'brightcove-loader',
210            Assets::get_file_url_for_environment( '_inc/build/shortcodes/js/brightcove.min.js', 'modules/shortcodes/js/brightcove.js' ),
211            array( 'jquery' ),
212            20121127,
213            false
214        );
215        wp_localize_script(
216            'brightcove-loader',
217            'brightcoveData',
218            array(
219                'tld' => $js_tld,
220            )
221        );
222
223        return '
224            <object id="myExperience" class="BrightcoveExperience">
225                <param name="bgcolor" value="' . esc_attr( $attr['bg'] ) . '" />
226                <param name="width" value="' . esc_attr( $width ) . '" />
227                <param name="height" value="' . esc_attr( $height ) . '" />
228                <param name="playerID" value="' . esc_attr( $attr['exp3'] ) . '" />
229                <param name="@videoPlayer" value="' . esc_attr( $attr['vid'] ) . '" />
230                <param name="playerKey" value="' . esc_attr( $attr['pk'] ) . '" />
231                <param name="isVid" value="1" />
232                <param name="isUI" value="1" />
233                <param name="dynamicStreaming" value="true" />
234                <param name="autoStart" value="false" />
235                <param name="secureConnections" value="true" />
236                <param name="secureHTMLConnections" value="true" />
237            </object>';
238    }
239}
240
241add_shortcode( Jetpack_Brightcove_Shortcode::$shortcode, array( 'Jetpack_Brightcove_Shortcode', 'convert' ) );