Jetpack_Podcast_Helper

Complexity

Total Complexity

32

Size/Duplication

Total Lines	228
Duplicated Lines	5.7 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
B	get_player_data()	0	46	8
B	get_track_data()	0	34	8
A	get_track_list()	0	8	1
A	get_plain_text()	0	15	2
A	load_feed()	13	13	3
A	setup_tracks_callback()	0	35	5
A	get_audio_enclosure()	0	9	3
A	format_track_duration()	0	5	2

<?php
/**
 * Helper to massage Podcast data to be used in the Podcast block.
 *
 * @package jetpack
 */

/**
 * Class Jetpack_Podcast_Helper
 */
class Jetpack_Podcast_Helper {
	/**
	 * Gets podcast data formatted to be used by the Podcast Player block in both server-side
	 * block rendering and in API `WPCOM_REST_API_V2_Endpoint_Podcast_Player`.
	 *
	 * The result is cached for one hour.
	 *
	 * @param string $feed     The RSS feed to load and list tracks for.
	 * @return array|WP_Error  The player data or a error object.
	 */
	public static function get_player_data( $feed ) {
		$feed = esc_url_raw( $feed );

		// Try loading data from the cache.
		$transient_key = 'jetpack_podcast_' . md5( $feed );
		$player_data   = get_transient( $transient_key );

		// Fetch data if we don't have any cached.
		if ( false === $player_data || ( defined( 'WP_DEBUG' ) && WP_DEBUG ) ) {
			// Load feed.
			$rss = self::load_feed( $feed );

			if ( is_wp_error( $rss ) ) {
				return $rss;
			}

			// Get tracks.
			$tracks = self::get_track_list( $rss );

It seems like $rss defined by self::load_feed($feed) on line 31 can also be of type object<WP_Error>; however, Jetpack_Podcast_Helper::get_track_list() does only seem to accept string, maybe add an additional type check?

			if ( empty( $tracks ) ) {
				return new WP_Error( 'no_tracks', __( 'Your Podcast couldn\'t be embedded as it doesn\'t contain any tracks. Please double check your URL.', 'jetpack' ) );

The call to WP_Error::__construct() has too many arguments starting with 'no_tracks'.

			}

			// Get podcast meta.
			$title = $rss->get_title();

The method get_title() does not seem to exist on object<WP_Error>.

			$title = self::get_plain_text( $title );

			$cover = $rss->get_image_url();

The method get_image_url() does not seem to exist on object<WP_Error>.

			$cover = ! empty( $cover ) ? esc_url( $cover ) : null;

			$link = $rss->get_link();

The method get_link() does not seem to exist on object<WP_Error>.

			$link = ! empty( $link ) ? esc_url( $link ) : null;

			$player_data = array(
				'title'  => $title,
				'link'   => $link,
				'cover'  => $cover,
				'tracks' => $tracks,
			);

			// Cache for 1 hour.
			set_transient( $transient_key, $player_data, HOUR_IN_SECONDS );
		}

		return $player_data;
	}

	/**
	 * Gets a specific track from the supplied feed URL.
	 *
	 * @param string $feed     The RSS feed to find the track in.
	 * @param string $guid     The GUID of the track.
	 * @return array|WP_Error  The track object or an error object.
	 */
	public static function get_track_data( $feed, $guid ) {
		$feed = esc_url_raw( $feed );

		// Try loading track data from the cache.
		$transient_key = 'jetpack_podcast_' . md5( "$feed::$guid" );
		$track_data    = get_transient( $transient_key );

		// Fetch data if we don't have any cached.
		if ( false === $track_data || ( defined( 'WP_DEBUG' ) && WP_DEBUG ) ) {
			// Load feed.
			$rss = static::load_feed( $feed );

Since load_feed() is declared private, calling it with static will lead to errors in possible sub-classes. You can either use self, or increase the visibility of load_feed() to at least protected.

			if ( is_wp_error( $rss ) ) {
				return $rss;
			}

			// Loop over all tracks to find the one.
			foreach ( $rss->get_items() as $track ) {

The method get_items() does not seem to exist on object<WP_Error>.

				if ( $guid === $track->get_id() ) {
					$track_data = static::setup_tracks_callback( $track );

Since setup_tracks_callback() is declared private, calling it with static will lead to errors in possible sub-classes. You can either use self, or increase the visibility of setup_tracks_callback() to at least protected.

					break;
				}
			}

			if ( false === $track_data ) {
				return new WP_Error( 'no_track', __( 'The track was not found.', 'jetpack' ) );

The call to WP_Error::__construct() has too many arguments starting with 'no_track'.

			}

			// Cache for 1 hour.
			set_transient( $transient_key, $track_data, HOUR_IN_SECONDS );
		}

		return $track_data;
	}

	/**
	 * Gets a list of tracks for the supplied RSS feed.
	 *
	 * @param string $rss      The RSS feed to load and list tracks for.
	 * @return array|WP_Error The feed's tracks or a error object.
	 */
	private static function get_track_list( $rss ) {
		// Get first ten items and format them.
		$track_list = array_map( array( __CLASS__, 'setup_tracks_callback' ), $rss->get_items( 0, 10 ) );

The method get_items cannot be called on $rss (of type string).

		// Filter out any tracks that are empty.
		// Reset the array indicies.
		return array_values( array_filter( $track_list ) );
	}

	/**
	 * Formats string as pure plaintext, with no HTML tags or entities present.
	 * This is ready to be used in React, innerText but needs to be escaped
	 * using standard `esc_html` when generating markup on server.
	 *
	 * @param string $str Input string.
	 * @return string Plain text string.
	 */
	private static function get_plain_text( $str ) {
		// Trim string and return if empty.
		$str = trim( (string) $str );
		if ( empty( $str ) ) {
			return '';
		}

		// Make sure there are no tags.
		$str = wp_strip_all_tags( $str );

		// Replace all entities with their characters, including all types of quotes.
		$str = html_entity_decode( $str, ENT_QUOTES );

		return $str;
	}

	/**
	 * Loads an RSS feed using `fetch_feed`.
	 *
	 * @param string $feed        The RSS feed URL to load.
	 * @return SimplePie|WP_Error The RSS object or error.
	 */
	private static function load_feed( $feed ) {
		$rss = fetch_feed( esc_url_raw( $feed ) );

		if ( is_wp_error( $rss ) ) {
			return new WP_Error( 'invalid_url', __( 'Your podcast couldn\'t be embedded. Please double check your URL.', 'jetpack' ) );

The call to WP_Error::__construct() has too many arguments starting with 'invalid_url'.

		}

		if ( ! $rss->get_item_quantity() ) {
			return new WP_Error( 'no_tracks', __( 'Podcast audio RSS feed has no tracks.', 'jetpack' ) );

The call to WP_Error::__construct() has too many arguments starting with 'no_tracks'.

		}

		return $rss;
	}

	/**
	 * Prepares Episode data to be used by the Podcast Player block.
	 *
	 * @param SimplePie_Item $episode SimplePie_Item object, representing a podcast episode.
	 * @return array
	 */
	private static function setup_tracks_callback( SimplePie_Item $episode ) {
		$enclosure = self::get_audio_enclosure( $episode );

		// If the audio enclosure is empty then it is not playable.
		// We therefore return an empty array for this track.
		// It will be filtered out later.
		if ( is_wp_error( $enclosure ) ) {
			return array();
		}

		// If there is no link return an empty array. We will filter out later.
		if ( empty( $enclosure->link ) ) {
			return array();
		}

		// Build track data.
		$track = array(
			'id'          => wp_unique_id( 'podcast-track-' ),
			'link'        => esc_url( $episode->get_link() ),
			'src'         => esc_url( $enclosure->link ),
			'type'        => esc_attr( $enclosure->type ),
			'description' => self::get_plain_text( $episode->get_description() ),
			'title'       => self::get_plain_text( $episode->get_title() ),
		);

		if ( empty( $track['title'] ) ) {
			$track['title'] = esc_html__( '(no title)', 'jetpack' );
		}

		if ( ! empty( $enclosure->duration ) ) {
			$track['duration'] = esc_html( self::format_track_duration( $enclosure->duration ) );
		}

		return $track;
	}

	/**
	 * Retrieves an audio enclosure.
	 *
	 * @param SimplePie_Item $episode SimplePie_Item object, representing a podcast episode.
	 * @return SimplePie_Enclosure|null
	 */
	private static function get_audio_enclosure( SimplePie_Item $episode ) {
		foreach ( (array) $episode->get_enclosures() as $enclosure ) {
			if ( 0 === strpos( $enclosure->type, 'audio/' ) ) {
				return $enclosure;
			}
		}

		return new WP_Error( 'invalid_audio', __( 'Podcast audio is an invalid type.', 'jetpack' ) );

The call to WP_Error::__construct() has too many arguments starting with 'invalid_audio'.

	}

	/**
	 * Returns the track duration as a formatted string.
	 *
	 * @param number $duration of the track in seconds.
	 * @return string
	 */
	private static function format_track_duration( $duration ) {
		$format = $duration > HOUR_IN_SECONDS ? 'H:i:s' : 'i:s';

		return date_i18n( $format, $duration );
	}
}