VideoPress_Gutenberg::check_videopress_availability() - Code Metrics - Inspection of "Merge branch 'master' into add/password-checker-sy..." - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — add/password-checker-sync-comp... ( 02fb03...1887ce )

unknown

created 2021-03-31 04:41 UTC

check_videopress_availability() C

↳ Parent: VideoPress_Gutenberg

Complexity

Conditions	15
Paths	13

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	15
nc	13
nop	0
dl	0
loc	54
rs	5.9166
c	0
b	0
f	0

How to fix Long Method Complexity

<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
/**
 * Block Editor functionality for VideoPress users.
 *
 * @package automattic/jetpack
 */

use Automattic\Jetpack\Assets;
use Automattic\Jetpack\Blocks;

/**
 * Register a VideoPress extension to replace the default Core Video block.
 */
class VideoPress_Gutenberg {

	/**
	 * Singleton
	 */
	public static function init() {
		static $instance = false;

		if ( ! $instance ) {
			$instance = new VideoPress_Gutenberg();
		}

		return $instance;
	}

	/**
	 * VideoPress_Gutenberg constructor.
	 *
	 * Initialize the VideoPress Gutenberg extension
	 */
	private function __construct() {
		add_action( 'init', array( $this, 'register_video_block_with_videopress' ) );
		add_action( 'jetpack_register_gutenberg_extensions', array( $this, 'set_extension_availability' ) );
		add_action( 'enqueue_block_editor_assets', array( $this, 'override_video_upload' ) );
	}

	/**
	 * Get site's ID.
	 *
	 * @return int $blog_id Site ID.
	 */
	private static function get_blog_id() {
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
			return get_current_blog_id();
		} elseif ( method_exists( 'Jetpack', 'is_active' ) && Jetpack::is_active() ) {

			/**
			 * We're intentionally not using `get_current_blog_id` because it was returning unexpected values.
			 *
			 * @see https://github.com/Automattic/jetpack/pull/11193#issuecomment-457883886
			 * @see https://github.com/Automattic/jetpack/pull/11193/commits/215cf789f3d8bd03ff9eb1bbdb693acb8831d273
			 */
			return Jetpack_Options::get_option( 'id' );
		}

		return null;
	}

	/**
	 * Used to check whether VideoPress is enabled for given site.
	 *
	 * @todo Create a global `jetpack_check_module_availability( $module )` helper so we can re-use it on other modules.
	 *       This global helper should be created in a file synced with WordPress.com so we can use it there too.
	 * @see https://github.com/Automattic/jetpack/pull/11321#discussion_r255477815
	 *
	 * @return array Associative array indicating if the module is available (key `available`) and the reason why it is
	 * unavailable (key `unavailable_reason`)
	 */
	public function check_videopress_availability() {
		if (
			defined( 'IS_WPCOM' ) && IS_WPCOM &&
			function_exists( 'require_lib' )
		) {
			require_lib( 'wpforteams' );

			if ( WPForTeams\Workspace\is_part_of_active_workspace( self::get_blog_id() ) ) {
				return array( 'available' => true );
			}
		}

		// It is available on Simple Sites having the appropriate a plan.
		if (
			defined( 'IS_WPCOM' ) && IS_WPCOM
			&& method_exists( 'Store_Product_List', 'get_site_specific_features_data' )
		) {
			$features = Store_Product_List::get_site_specific_features_data();
			if ( in_array( 'videopress', $features['active'], true ) ) {
				return array( 'available' => true );
			} else {
				return array(
					'available'          => false,
					'unavailable_reason' => 'missing_plan',
				);
			}
		}

		// It is available on Jetpack Sites having the module active.
		if (
			method_exists( 'Jetpack', 'is_connection_ready' ) && Jetpack::is_connection_ready()
			&& method_exists( 'Jetpack', 'is_module_active' )
			&& method_exists( 'Jetpack_Plan', 'supports' )
		) {
			if ( Jetpack::is_module_active( 'videopress' ) ) {
				return array( 'available' => true );
			} elseif ( ! Jetpack_Plan::supports( 'videopress' ) ) {
				return array(
					'available'          => false,
					'unavailable_reason' => 'missing_plan',
				);
			} else {
				return array(
					'available'          => false,
					'unavailable_reason' => 'missing_module',
				);
			}
		}

		return array(
			'available'          => false,
			'unavailable_reason' => 'unknown',
		);
	}

	/**
	 * Set the Jetpack Gutenberg extension availability.
	 */
	public function set_extension_availability() {
		$availability = $this->check_videopress_availability();
		if ( $availability['available'] ) {
			Jetpack_Gutenberg::set_extension_available( 'jetpack/videopress' );
		} else {
			Jetpack_Gutenberg::set_extension_unavailable( 'jetpack/videopress', $availability['unavailable_reason'] );
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
		}
	}

	/**
	 * Register the core video block as a dynamic block.
	 *
	 * It defines a server-side rendering that adds VideoPress support to the core video block.
	 */
	public function register_video_block_with_videopress() {
		Blocks::jetpack_register_block(
			'core/video',
			array(
				'render_callback' => array( $this, 'render_video_block_with_videopress' ),
			)
		);
	}

	/**
	 * Render the core video block replacing the src attribute with the VideoPress URL
	 *
	 * @param array  $attributes Array containing the video block attributes.
	 * @param string $content    String containing the video block content.
	 *
	 * @return string
	 */
	public function render_video_block_with_videopress( $attributes, $content ) {
		if ( ! isset( $attributes['id'] ) || isset( $attributes['guid'] ) ) {
			return $content;
		}

		$blog_id = self::get_blog_id();

		if ( ! isset( $blog_id ) ) {
			return $content;
		}

		$post_id         = absint( $attributes['id'] );
		$videopress_id   = video_get_info_by_blogpostid( $blog_id, $post_id )->guid;
		$videopress_data = videopress_get_video_details( $videopress_id );

		if ( empty( $videopress_data->file_url_base->https ) || empty( $videopress_data->files->hd->mp4 ) ) {
			return $content;
		}

		$videopress_url = $videopress_data->file_url_base->https . $videopress_data->files->hd->mp4;

		$pattern = '/(\s)src=([\'"])(?:(?!\2).)+?\2/';

		return preg_replace(
			$pattern,
			sprintf(
				'\1src="%1$s"',
				esc_url_raw( $videopress_url )
			),
			$content,
			1
		);
	}

	/**
	 * Replaces the video uploaded in the block editor.
	 *
	 * Enqueues a script that registers an API fetch middleware replacing the video uploads in Gutenberg so they are
	 * uploaded against the WP.com API media endpoint and thus transcoded by VideoPress.
	 */
	public function override_video_upload() {
		// Bail if Jetpack is not connected or VideoPress module is not active.
		if ( ! Jetpack::is_connection_ready() || ! Jetpack::is_module_active( 'videopress' ) ) {
			return;
		}

		wp_enqueue_script(
			'jetpack-videopress-gutenberg-override-video-upload',
			Assets::get_file_url_for_environment(
				'_inc/build/videopress/js/gutenberg-video-upload.min.js',
				'modules/videopress/js/gutenberg-video-upload.js'
			),
			array( 'wp-api-fetch', 'wp-polyfill', 'lodash' ),
			JETPACK__VERSION,
			false
		);
	}
}

VideoPress_Gutenberg::init();


1		<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2		/**
3		* Block Editor functionality for VideoPress users.
4		*
5		* @package automattic/jetpack
6		*/
7
8		use Automattic\Jetpack\Assets;
9		use Automattic\Jetpack\Blocks;
10
11		/**
12		* Register a VideoPress extension to replace the default Core Video block.
13		*/
14		class VideoPress_Gutenberg {
15
16		/**
17		* Singleton
18		*/
19		public static function init() {
20		static $instance = false;
21
22		if ( ! $instance ) {
23		$instance = new VideoPress_Gutenberg();
24		}
25
26		return $instance;
27		}
28
29		/**
30		* VideoPress_Gutenberg constructor.
31		*
32		* Initialize the VideoPress Gutenberg extension
33		*/
34		private function __construct() {
35		add_action( 'init', array( $this, 'register_video_block_with_videopress' ) );
36		add_action( 'jetpack_register_gutenberg_extensions', array( $this, 'set_extension_availability' ) );
37		add_action( 'enqueue_block_editor_assets', array( $this, 'override_video_upload' ) );
38		}
39
40		/**
41		* Get site's ID.
42		*
43		* @return int $blog_id Site ID.
44		*/
45	View Code Duplication	private static function get_blog_id() {
46		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
47		return get_current_blog_id();
48		} elseif ( method_exists( 'Jetpack', 'is_active' ) && Jetpack::is_active() ) {
		0 ignored issues – show Deprecated Code introduced 2021-03-30 13:30 UTC by Report Bug Copy Issue Report The method `Jetpack::is_active()` has been deprecated with message: 9.6.0 This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
49		/**
50		* We're intentionally not using `get_current_blog_id` because it was returning unexpected values.
51		*
52		* @see https://github.com/Automattic/jetpack/pull/11193#issuecomment-457883886
53		* @see https://github.com/Automattic/jetpack/pull/11193/commits/215cf789f3d8bd03ff9eb1bbdb693acb8831d273
54		*/
55		return Jetpack_Options::get_option( 'id' );
56		}
57
58		return null;
59		}
60
61		/**
62		* Used to check whether VideoPress is enabled for given site.
63		*
64		* @todo Create a global `jetpack_check_module_availability( $module )` helper so we can re-use it on other modules.
65		* This global helper should be created in a file synced with WordPress.com so we can use it there too.
66		* @see https://github.com/Automattic/jetpack/pull/11321#discussion_r255477815
67		*
68		* @return array Associative array indicating if the module is available (key `available`) and the reason why it is
69		* unavailable (key `unavailable_reason`)
70		*/
71		public function check_videopress_availability() {
72		if (
73		defined( 'IS_WPCOM' ) && IS_WPCOM &&
74		function_exists( 'require_lib' )
75		) {
76		require_lib( 'wpforteams' );
77
78		if ( WPForTeams\Workspace\is_part_of_active_workspace( self::get_blog_id() ) ) {
79		return array( 'available' => true );
80		}
81		}
82
83		// It is available on Simple Sites having the appropriate a plan.
84		if (
85		defined( 'IS_WPCOM' ) && IS_WPCOM
86		&& method_exists( 'Store_Product_List', 'get_site_specific_features_data' )
87		) {
88		$features = Store_Product_List::get_site_specific_features_data();
89		if ( in_array( 'videopress', $features['active'], true ) ) {
90		return array( 'available' => true );
91		} else {
92		return array(
93		'available' => false,
94		'unavailable_reason' => 'missing_plan',
95		);
96		}
97		}
98
99		// It is available on Jetpack Sites having the module active.
100		if (
101		method_exists( 'Jetpack', 'is_connection_ready' ) && Jetpack::is_connection_ready()
102		&& method_exists( 'Jetpack', 'is_module_active' )
103		&& method_exists( 'Jetpack_Plan', 'supports' )
104		) {
105		if ( Jetpack::is_module_active( 'videopress' ) ) {
106		return array( 'available' => true );
107		} elseif ( ! Jetpack_Plan::supports( 'videopress' ) ) {
108		return array(
109		'available' => false,
110		'unavailable_reason' => 'missing_plan',
111		);
112		} else {
113		return array(
114		'available' => false,
115		'unavailable_reason' => 'missing_module',
116		);
117		}
118		}
119
120		return array(
121		'available' => false,
122		'unavailable_reason' => 'unknown',
123		);
124		}
125
126		/**
127		* Set the Jetpack Gutenberg extension availability.
128		*/
129		public function set_extension_availability() {
130		$availability = $this->check_videopress_availability();
131		if ( $availability['available'] ) {
132		Jetpack_Gutenberg::set_extension_available( 'jetpack/videopress' );
133		} else {
134		Jetpack_Gutenberg::set_extension_unavailable( 'jetpack/videopress', $availability['unavailable_reason'] );
		0 ignored issues – show Bug introduced 2019-02-12 13:59 UTC by Report Bug Copy Issue Report It seems like `$availability['unavailable_reason']` can also be of type `boolean`; however, `Jetpack_Gutenberg::set_extension_unavailable()` does only seem to accept `string`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
135		}
136		}
137
138		/**
139		* Register the core video block as a dynamic block.
140		*
141		* It defines a server-side rendering that adds VideoPress support to the core video block.
142		*/
143		public function register_video_block_with_videopress() {
144		Blocks::jetpack_register_block(
145		'core/video',
146		array(
147		'render_callback' => array( $this, 'render_video_block_with_videopress' ),
148		)
149		);
150		}
151
152		/**
153		* Render the core video block replacing the src attribute with the VideoPress URL
154		*
155		* @param array $attributes Array containing the video block attributes.
156		* @param string $content String containing the video block content.
157		*
158		* @return string
159		*/
160		public function render_video_block_with_videopress( $attributes, $content ) {
161		if ( ! isset( $attributes['id'] ) \|\| isset( $attributes['guid'] ) ) {
162		return $content;
163		}
164
165		$blog_id = self::get_blog_id();
166
167		if ( ! isset( $blog_id ) ) {
168		return $content;
169		}
170
171		$post_id = absint( $attributes['id'] );
172		$videopress_id = video_get_info_by_blogpostid( $blog_id, $post_id )->guid;
173		$videopress_data = videopress_get_video_details( $videopress_id );
174
175		if ( empty( $videopress_data->file_url_base->https ) \|\| empty( $videopress_data->files->hd->mp4 ) ) {
176		return $content;
177		}
178
179		$videopress_url = $videopress_data->file_url_base->https . $videopress_data->files->hd->mp4;
180
181		$pattern = '/(\s)src=([\'"])(?:(?!\2).)+?\2/';
182
183		return preg_replace(
184		$pattern,
185		sprintf(
186		'\1src="%1$s"',
187		esc_url_raw( $videopress_url )
188		),
189		$content,
190		1
191		);
192		}
193
194		/**
195		* Replaces the video uploaded in the block editor.
196		*
197		* Enqueues a script that registers an API fetch middleware replacing the video uploads in Gutenberg so they are
198		* uploaded against the WP.com API media endpoint and thus transcoded by VideoPress.
199		*/
200		public function override_video_upload() {
201		// Bail if Jetpack is not connected or VideoPress module is not active.
202		if ( ! Jetpack::is_connection_ready() \|\| ! Jetpack::is_module_active( 'videopress' ) ) {
203		return;
204		}
205
206		wp_enqueue_script(
207		'jetpack-videopress-gutenberg-override-video-upload',
208		Assets::get_file_url_for_environment(
209		'_inc/build/videopress/js/gutenberg-video-upload.min.js',
210		'modules/videopress/js/gutenberg-video-upload.js'
211		),
212		array( 'wp-api-fetch', 'wp-polyfill', 'lodash' ),
213		JETPACK__VERSION,
214		false
215		);
216		}
217		}
218
219		VideoPress_Gutenberg::init();
220

Automattic / jetpack

Push — add/password-checker-sync-comp... ( 02fb03...1887ce )

check_videopress_availability() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like