Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
0.00%
0 / 115
0.00%
0 / 4
 CRAP
0.00%
0 / 1
Block_Editor_Content
0.00%
0 / 115
0.00%
0 / 4
 1332
0.00%
0 / 1
 init
0.00%
0 / 10
0.00%
0 / 1
 20
 videopress_embed_shortcode
0.00%
0 / 60
0.00%
0 / 1
 132
 videopress_video_block_by_guid
0.00%
0 / 18
0.00%
0 / 1
 56
 video_shortcode_override
0.00%
0 / 27
0.00%
0 / 1
 210
1<?php
2/**
3 * VideoPress Block Editor Content
4 *
5 * @package automattic/jetpack-videopress
6 */
7
8namespace Automattic\Jetpack\VideoPress;
9
10use WP_Post;
11
12/**
13 * VideoPress block editor class for content generation
14 */
15class Block_Editor_Content {
16    /**
17     * Initializer
18     *
19     * This method should be called only once by the Initializer class. Do not call this method again.
20     */
21    public static function init() {
22        if ( ! Status::is_standalone_plugin_active() ) {
23            return;
24        }
25
26        // Remove the videopress shortcodes added by the Jetpack plugin.
27        if ( shortcode_exists( 'videopress' ) ) {
28            remove_shortcode( 'videopress' );
29        }
30        if ( shortcode_exists( 'wpvideo' ) ) {
31            remove_shortcode( 'wpvideo' );
32        }
33
34        add_shortcode( 'videopress', array( static::class, 'videopress_embed_shortcode' ) );
35        add_shortcode( 'wpvideo', array( static::class, 'videopress_embed_shortcode' ) );
36
37        add_filter( 'wp_video_shortcode_override', array( static::class, 'video_shortcode_override' ), 10, 4 );
38
39        add_filter( 'default_content', array( static::class, 'videopress_video_block_by_guid' ), 10, 2 );
40    }
41
42    /**
43     * VideoPress embed shortcode
44     *
45     * Expected input format:
46     * [videopress tLvEwHYZ]
47     *
48     * @param array $atts Shortcode attributes.
49     *
50     * @return string html
51     */
52    public static function videopress_embed_shortcode( $atts ) {
53        /**
54         * We only accept GUIDs as a first unnamed argument.
55         */
56        $guid = $atts[0] ?? null;
57
58        /**
59         * Make sure the GUID passed in matches how actual GUIDs are formatted.
60         */
61        if ( ! videopress_is_valid_guid( $guid ) ) {
62            return '<!-- error: missing or invalid VideoPress video ID -->';
63        }
64
65        /**
66         * Set the defaults
67         */
68        $defaults = array(
69            'w'               => 640,   // Width of the video player, in pixels
70            'h'               => 0,     // Height of the video player, in pixels
71            'at'              => 0,     // How many seconds in to initially seek to
72            'loop'            => false, // Whether to loop the video repeatedly
73            'autoplay'        => false, // Whether to autoplay the video on load
74            'cover'           => true,  // Whether to scale the video to its container
75            'muted'           => false, // Whether the video should start without sound
76            'controls'        => true,  // Whether the video should display controls
77            'playsinline'     => false, // Whether the video should be allowed to play inline (for browsers that support this)
78            'useaveragecolor' => false, // Whether the video should use the seekbar automatic average color
79            'preloadcontent'  => 'metadata',
80        );
81
82        // Make sure "false" will be actually false.
83        foreach ( $atts as $key => $value ) {
84            if ( is_string( $value ) && 'false' === strtolower( $value ) ) {
85                $atts[ $key ] = 0;
86            }
87        }
88
89        if ( isset( $atts['preload'] ) && videopress_is_valid_preload( $atts['preload'] ) ) {
90            $atts['preloadcontent'] = $atts['preload'];
91        }
92
93        if ( isset( $atts['preloadcontent'] ) && ! videopress_is_valid_preload( $atts['preloadcontent'] ) ) {
94            unset( $atts['preloadcontent'] );
95        }
96
97        $atts = shortcode_atts( $defaults, $atts, 'videopress' );
98
99        $base_url     = 'https://videopress.com/embed/' . $guid;
100        $query_params = array(
101            'at'              => $atts['at'],
102            'loop'            => $atts['loop'],
103            'autoplay'        => $atts['autoplay'],
104            'muted'           => $atts['muted'],
105            'controls'        => $atts['controls'],
106            'playsinline'     => $atts['playsinline'],
107            'useAverageColor' => $atts['useaveragecolor'], // The casing is intentional, shortcode params are lowercase, but player expects useAverageColor
108            'preloadContent'  => $atts['preloadcontent'], // The casing is intentional, shortcode params are lowercase, but player expects preloadContent
109        );
110        $src          = esc_url( add_query_arg( $query_params, $base_url ) );
111
112        $width = absint( $atts['w'] );
113        if ( ! $atts['h'] ) {
114            $aspect_ratio = 16 / 9; // TODO: Get the correct aspect ratio for the video.
115            $height       = $width / $aspect_ratio;
116        } else {
117            $height = absint( $atts['h'] );
118        }
119
120        $cover = $atts['cover'] ? ' data-resize-to-parent="true"' : '';
121
122        $block_template =
123        '<figure class="wp-block-videopress-video wp-block-jetpack-videopress jetpack-videopress-player">' .
124            '<div class="jetpack-videopress-player__wrapper">' .
125                '<iframe ' .
126                    'title="' . __( 'VideoPress Video Player', 'jetpack-videopress-pkg' ) . '" ' .
127                    'aria-label="' . __( 'VideoPress Video Player', 'jetpack-videopress-pkg' ) . '" ' .
128                    'src="%s" ' .
129                    'width="%s"' .
130                    'height="%s" ' .
131                    'frameborder="0" ' .
132                    'allowfullscreen%s allow="clipboard-write">' .
133                '</iframe>' .
134            '</div>' .
135        '</figure>';
136
137        $version = Package_Version::PACKAGE_VERSION;
138        Jwt_Token_Bridge::enqueue_jwt_token_bridge();
139        wp_enqueue_script( 'videopress-iframe', 'https://videopress.com/videopress-iframe.js', array(), $version, true );
140
141        return sprintf( $block_template, $src, $width, $height, $cover );
142    }
143
144    /**
145     * Generates a VideoPress video block content with the given guid
146     *
147     * @param string  $content Post content.
148     * @param WP_Post $post Post.
149     * @return string
150     */
151    public static function videopress_video_block_by_guid( $content, $post ) {
152        if ( isset( $_GET['videopress_guid'] ) && isset( $_GET['_wpnonce'] )
153            && wp_verify_nonce( sanitize_text_field( wp_unslash( $_GET['_wpnonce'] ) ), 'videopress-content-nonce' )
154            && current_user_can( 'edit_post', $post->ID )
155            && '' === $content
156        ) {
157            $guid = sanitize_text_field( wp_unslash( $_GET['videopress_guid'] ) );
158
159            $base_url     = 'https://videopress.com/v/' . $guid;
160            $query_params = array(
161                'resizeToParent'  => 'true',
162                'cover'           => 'true',
163                'preloadContent'  => 'metadata',
164                'useAverageColor' => 'true',
165            );
166            $url          = esc_url( add_query_arg( $query_params, $base_url ) );
167
168            if ( ! empty( $guid ) ) {
169                // ref /client/lib/url/index.ts
170                $content = '<!-- wp:videopress/video {"guid":"' . $guid . '"} -->
171                <figure class="wp-block-videopress-video wp-block-jetpack-videopress jetpack-videopress-player">
172                    <div class="jetpack-videopress-player__wrapper">' . $url . '</div>
173                </figure>
174                <!-- /wp:videopress/video -->';
175            }
176        }
177
178        return $content;
179    }
180
181    /**
182     * Override the standard video short tag to also process videopress files as well.
183     *
184     * This will parse the given src and, if it is a videopress file, parse as the
185     * VideoPress shortcode instead.
186     *
187     * @param string $html     Empty variable to be replaced with shortcode markup.
188     * @param array  $attr     Attributes of the video shortcode.
189     * @param string $content  Video shortcode content.
190     * @param int    $instance Unique numeric ID of this video shortcode instance.
191     *
192     * @return string
193     */
194    public static function video_shortcode_override( $html, $attr, $content, $instance ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
195        $videopress_guid = null;
196
197        if ( isset( $attr['videopress_guid'] ) ) {
198            $videopress_guid = $attr['videopress_guid'];
199        } else {
200            // Handle the different possible url attributes
201            $url_keys = array( 'src', 'mp4' );
202
203            foreach ( $url_keys as $key ) {
204                if ( isset( $attr[ $key ] ) ) {
205                    $url = $attr[ $key ];
206                    // phpcs:ignore WordPress.WP.CapitalPDangit
207                    if ( preg_match( '@videos.(videopress\.com|files\.wordpress\.com)/([a-z0-9]{8})/@i', $url, $matches ) ) {
208                        $videopress_guid = $matches[2];
209                    }
210
211                    // Also test for videopress oembed url, which is used by the Video Media Widget.
212                    if ( ! $videopress_guid && preg_match( '@https://videopress.com/v/([a-z0-9]{8})@i', $url, $matches ) ) {
213                        $videopress_guid = $matches[1];
214                    }
215
216                    // Also test for old v.wordpress.com oembed URL.
217                    if ( ! $videopress_guid && preg_match( '|^https?://v\.wordpress\.com/([a-zA-Z\d]{8})(.+)?$|i', $url, $matches ) ) { // phpcs:ignore WordPress.WP.CapitalPDangit.MisspelledInText
218                        $videopress_guid = $matches[1];
219                    }
220
221                    break;
222                }
223            }
224        }
225
226        if ( $videopress_guid ) {
227            $videopress_atts = array( $videopress_guid );
228
229            // height is ignored on jetpack video block, so we don't pass it for consistency.
230            if ( isset( $attr['width'] ) ) {
231                $videopress_atts['w'] = (int) $attr['width'];
232            }
233            if ( isset( $attr['muted'] ) ) {
234                $videopress_atts['muted'] = $attr['muted'];
235            }
236            if ( isset( $attr['autoplay'] ) ) {
237                $videopress_atts['autoplay'] = $attr['autoplay'];
238            }
239            if ( isset( $attr['loop'] ) ) {
240                $videopress_atts['loop'] = $attr['loop'];
241            }
242            // The core video block doesn't support the cover attribute, setting it to false for consistency.
243            $videopress_atts['cover'] = false;
244
245            // Then display the VideoPress version of the stored GUID!
246            return self::videopress_embed_shortcode( $videopress_atts );
247        }
248
249        return '';
250    }
251}