Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
0.00%
0 / 111
0.00%
0 / 5
 CRAP
0.00%
0 / 1
VideoPress_Shortcode
0.00%
0 / 108
0.00%
0 / 5
 1332
0.00%
0 / 1
 __construct
0.00%
0 / 5
0.00%
0 / 1
 6
 initialize
0.00%
0 / 3
0.00%
0 / 1
 6
 shortcode_callback
0.00%
0 / 68
0.00%
0 / 1
 306
 video_shortcode_override
0.00%
0 / 27
0.00%
0 / 1
 210
 add_video_embed_hander
0.00%
0 / 5
0.00%
0 / 1
 2
1<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2
3if ( ! defined( 'ABSPATH' ) ) {
4    exit( 0 );
5}
6
7/**
8 * VideoPress Shortcode Handler
9 *
10 * This file may or may not be included from the Jetpack VideoPress module.
11 */
12class VideoPress_Shortcode {
13    /**
14     * Singleton VideoPress_Shortcode instance.
15     *
16     * @var VideoPress_Shortcode
17     */
18    protected static $instance;
19
20    /**
21     * VideoPress_Shortcode constructor.
22     */
23    protected function __construct() {
24        // Only add the shortcode if it hasn't already been added by the standalone VideoPress plugin.
25        if ( ! shortcode_exists( 'videopress' ) ) {
26            add_shortcode( 'videopress', array( $this, 'shortcode_callback' ) );
27            add_shortcode( 'wpvideo', array( $this, 'shortcode_callback' ) );
28
29            add_filter( 'wp_video_shortcode_override', array( $this, 'video_shortcode_override' ), 10, 4 );
30        }
31
32        $this->add_video_embed_hander();
33    }
34
35    /**
36     * VideoPress_Shortcode initialization.
37     *
38     * @return VideoPress_Shortcode
39     */
40    public static function initialize() {
41        if ( ! isset( self::$instance ) ) {
42            self::$instance = new self();
43        }
44
45        return self::$instance;
46    }
47
48    /**
49     * Translate a 'videopress' or 'wpvideo' shortcode and arguments into a video player display.
50     *
51     * Expected input formats:
52     *
53     * [videopress OcobLTqC]
54     * [wpvideo OcobLTqC]
55     *
56     * @link https://codex.wordpress.org/Shortcode_API Shortcode API
57     * @param array $attr shortcode attributes.
58     * @return string HTML markup or blank string on fail
59     */
60    public function shortcode_callback( $attr ) {
61        global $content_width;
62
63        /**
64         * We only accept GUIDs as a first unnamed argument.
65         */
66        $guid = isset( $attr[0] ) ? $attr[0] : null;
67
68        if ( isset( $attr['postid'] ) ) {
69            $guid = get_post_meta( $attr['postid'], 'videopress_guid', true );
70        }
71
72        /**
73         * Make sure the GUID passed in matches how actual GUIDs are formatted.
74         */
75        if ( ! videopress_is_valid_guid( $guid ) ) {
76            return '';
77        }
78
79        /**
80         * Set the defaults
81         */
82        $defaults = array(
83            'w'               => 0,     // Width of the video player, in pixels
84            'at'              => 0,     // How many seconds in to initially seek to
85            'hd'              => true,  // Whether to display a high definition version
86            'loop'            => false, // Whether to loop the video repeatedly
87            'freedom'         => false, // Whether to use only free/libre codecs
88            'autoplay'        => false, // Whether to autoplay the video on load
89            'permalink'       => true,  // Whether to display the permalink to the video
90            'flashonly'       => false, // Whether to support the Flash player exclusively
91            'defaultlangcode' => false, // Default language code
92            'cover'           => true,  // Whether to scale the video to its container.
93            'muted'           => false, // Whether the video should start without sound.
94            'controls'        => true,  // Whether the video should display controls.
95            'playsinline'     => false, // Whether the video should be allowed to play inline (for browsers that support this).
96            'useaveragecolor' => false, // Whether the video should use the seekbar automatic average color.
97            'preloadcontent'  => 'metadata', // Setting for how the browser should preload the video (none, metadata, auto).
98        );
99
100        // Make sure "false" will be actually false.
101        foreach ( $attr as $key => $value ) {
102            if ( is_string( $value ) && 'false' === strtolower( $value ) ) {
103                $attr[ $key ] = false;
104            }
105        }
106
107        if ( isset( $attr['preload'] ) ) {
108            $attr['preloadcontent'] = $attr['preload'];
109        }
110
111        $attr = shortcode_atts( $defaults, $attr, 'videopress' );
112
113        /**
114         * Cast the attributes, post-input.
115         */
116        $attr['width']   = absint( $attr['w'] );
117        $attr['hd']      = (bool) $attr['hd'];
118        $attr['freedom'] = (bool) $attr['freedom'];
119
120        /**
121         * If the provided width is less than the minimum allowed
122         * width, or greater than `$content_width` ignore.
123         */
124        if ( $attr['width'] < VIDEOPRESS_MIN_WIDTH ) {
125            $attr['width'] = 0;
126        } elseif ( isset( $content_width ) && $content_width > VIDEOPRESS_MIN_WIDTH && $attr['width'] > $content_width ) {
127            $attr['width'] = 0;
128        }
129
130        /**
131         * If there was an invalid or unspecified width, set the width equal to the theme's `$content_width`.
132         */
133        if ( 0 === $attr['width'] && isset( $content_width ) && $content_width >= VIDEOPRESS_MIN_WIDTH ) {
134            $attr['width'] = (int) $content_width;
135        }
136
137        /**
138         * If the width isn't an even number, reduce it by one (making it even).
139         */
140        if ( 1 === ( $attr['width'] % 2 ) ) {
141            --$attr['width'];
142        }
143
144        /**
145         * Filter the default VideoPress shortcode options.
146         *
147         * @module videopress
148         *
149         * @since 2.5.0
150         *
151         * @param array $args Array of VideoPress shortcode options.
152         */
153        $options = apply_filters(
154            'videopress_shortcode_options',
155            array(
156                'at'              => (int) $attr['at'],
157                'hd'              => $attr['hd'],
158                'cover'           => (bool) $attr['cover'],
159                'loop'            => $attr['loop'],
160                'freedom'         => $attr['freedom'],
161                'autoplay'        => $attr['autoplay'],
162                'permalink'       => $attr['permalink'],
163                'force_flash'     => (bool) $attr['flashonly'],
164                'defaultlangcode' => $attr['defaultlangcode'],
165                'forcestatic'     => false, // This used to be a displayed option, but now is only.
166                'muted'           => $attr['muted'],
167                'controls'        => $attr['controls'],
168                'playsinline'     => $attr['playsinline'],
169                'useAverageColor' => (bool) $attr['useaveragecolor'], // The casing is intentional, shortcode params are lowercase, but player expects useAverageColor
170                'preloadContent'  => $attr['preloadcontent'], // The casing is intentional, shortcode params are lowercase, but player expects preloadContent
171            // accessible via the `videopress_shortcode_options` filter.
172            )
173        );
174
175        // Register VideoPress scripts
176        wp_register_script( 'videopress', 'https://v0.wordpress.com/js/videopress.js', array( 'jquery', 'swfobject' ), '1.09', false );
177
178        require_once __DIR__ . '/class.videopress-video.php';
179        require_once __DIR__ . '/class.videopress-player.php';
180
181        $player = new VideoPress_Player( $guid, $attr['width'], $options );
182
183        if ( is_feed() ) {
184            return $player->as_xml();
185        } else {
186            return $player->as_html();
187        }
188    }
189
190    /**
191     * Override the standard video short tag to also process videopress files as well.
192     *
193     * This will, parse the src given, and if it is a videopress file, it will parse as the
194     * VideoPress shortcode instead.
195     *
196     * @param string $html     Empty variable to be replaced with shortcode markup.
197     * @param array  $attr     Attributes of the video shortcode.
198     * @param string $content  Video shortcode content.
199     * @param int    $instance Unique numeric ID of this video shortcode instance.
200     *
201     * @return string
202     */
203    public function video_shortcode_override( $html, $attr, $content, $instance ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
204        $videopress_guid = null;
205
206        if ( isset( $attr['videopress_guid'] ) ) {
207            $videopress_guid = $attr['videopress_guid'];
208        } else {
209            // Handle the different possible url attributes
210            $url_keys = array( 'src', 'mp4' );
211
212            foreach ( $url_keys as $key ) {
213                if ( isset( $attr[ $key ] ) ) {
214                    $url = $attr[ $key ];
215                    // phpcs:ignore WordPress.WP.CapitalPDangit.MisspelledInText
216                    if ( preg_match( '@videos.(videopress\.com|files\.wordpress\.com)/([a-z0-9]{8})/@i', $url, $matches ) ) {
217                        $videopress_guid = $matches[2];
218                    }
219
220                    // Also test for videopress oembed url, which is used by the Video Media Widget.
221                    if ( ! $videopress_guid && preg_match( '@https://videopress.com/v/([a-z0-9]{8})@i', $url, $matches ) ) {
222                        $videopress_guid = $matches[1];
223                    }
224
225                    // Also test for old v.wordpress.com oembed URL.
226                    if ( ! $videopress_guid && preg_match( '|^https?://v\.wordpress\.com/([a-zA-Z\d]{8})(.+)?$|i', $url, $matches ) ) { // phpcs:ignore WordPress.WP.CapitalPDangit.MisspelledInText
227                        $videopress_guid = $matches[1];
228                    }
229
230                    break;
231                }
232            }
233        }
234
235        if ( $videopress_guid ) {
236            $videopress_attr = array( $videopress_guid );
237            if ( isset( $attr['width'] ) ) {
238                $videopress_attr['w'] = (int) $attr['width'];
239            }
240            if ( isset( $attr['muted'] ) ) {
241                $videopress_attr['muted'] = $attr['muted'];
242            }
243            if ( isset( $attr['autoplay'] ) ) {
244                $videopress_attr['autoplay'] = $attr['autoplay'];
245            }
246            if ( isset( $attr['loop'] ) ) {
247                $videopress_attr['loop'] = $attr['loop'];
248            }
249            // The core video block doesn't support the cover attribute, setting it to false for consistency.
250            $videopress_attr['cover'] = false;
251
252            // Then display the VideoPress version of the stored GUID!
253            return $this->shortcode_callback( $videopress_attr );
254        }
255
256        return '';
257    }
258
259    /**
260     * Register a VideoPress handler for direct links to .mov files (and potential other non-handled types later).
261     */
262    public function add_video_embed_hander() {
263        // These are the video extensions that VideoPress can transcode and considers video as well (even if core does not).
264        $extensions          = array( 'mov' );
265        $override_extensions = implode( '|', $extensions );
266
267        $regex = "#^https?://videos.(videopress.com|files.wordpress.com)/.+?.($override_extensions)$#i";
268
269        /** This filter is already documented in core/wp-includes/embed.php */
270        $filter = apply_filters( 'wp_video_embed_handler', 'wp_embed_handler_video' );
271        wp_embed_register_handler( 'video', $regex, $filter, 10 );
272    }
273}
274
275VideoPress_Shortcode::initialize();