Kirki_Fonts_Google_Local

Complexity

Total Complexity

53

Size/Duplication

Total Lines	457
Duplicated Lines	0 %

Importance

Changes	6
Bugs	3	Features	2

17 Methods

Rating	Name	Duplication	Size	Complexity
C	get_variant_fontface_css()	0	34	9
A	__construct()	0	6	1
A	init()	0	6	2
A	get_filename_from_url()	0	7	2
A	get_fonts()	0	5	1
A	get_font_files_urls_local()	0	7	2
A	get_local_font_name()	0	45	4
A	get_font_family()	0	8	2
A	get_variant_local_url()	0	20	4
A	get_font_files_paths()	0	7	2
A	get_font_files()	0	6	2
A	download_font_file()	0	15	3
A	get_css()	0	25	5
A	get_root_path()	0	13	2
A	get_root_url()	0	20	5
A	get_remote_url_contents()	0	10	3
A	download_font_family()	0	7	4

<?php
/**
 * Handles downloading a font from the google-fonts API locally.
 * Solves privacy concerns with Google's CDN
 * and their sometimes less-than-transparent policies.
 *
 * @package     Kirki
 * @category    Core
 * @author      Aristeides Stathopoulos
 * @copyright   Copyright (c) 2017, Aristeides Stathopoulos
 * @license    https://opensource.org/licenses/MIT
 * @since       3.0.28
 */

// Do not allow directly accessing this file.
if ( ! defined( 'ABSPATH' ) ) {
	exit( 'Direct script access denied.' );
}

/**
 * The Kirki_Fonts object.
 *
 * @since 3.0.28
 */
final class Kirki_Fonts_Google_Local {

	/**
	 * The name of the font-family
	 *
	 * @access private
	 * @since 3.0.28
	 * @var string
	 */
	private $family;

	/**
	 * The system path where font-files are stored.
	 *
	 * @access private
	 * @since 3.0.28
	 * @var string
	 */
	private $folder_path;

	/**
	 * The URL where files for this font can be found.
	 *
	 * @access private
	 * @since 3.0.28
	 * @var string
	 */
	private $folder_url;

	/**
	 * The font-family array from the google-fonts API.
	 *
	 * @access private
	 * @since 3.0.28
	 * @var array
	 */
	private $font;

The private property $font is not used, and could be removed.

	/**
	 * An array of instances for this object.
	 *
	 * @static
	 * @access private
	 * @since 3.0.28
	 * @var array
	 */
	private static $instances = array();

	/**
	 * Create an instance of this object for a specific font-family.
	 *
	 * @static
	 * @access public
	 * @since 3.0.28
	 * @param string $family The font-family name.
	 * @return Kirki_Fonts_Google_Local
	 */
	public static function init( $family ) {
		$key = sanitize_key( $family );
		if ( ! isset( self::$instances[ $key ] ) ) {
			self::$instances[ $key ] = new self( $family );
		}
		return self::$instances[ $key ];
	}

	/**
	 * Constructor.
	 *
	 * @access private
	 * @since 3.0.28
	 * @param string $family The font-family name.
	 */
	private function __construct( $family ) {
		$this->family      = $family;
		$key               = sanitize_key( $this->family );
		$this->folder_path = $this->get_root_path() . "/$key";
		$this->folder_url  = $this->get_root_url() . "/$key";
		$this->files       = $this->get_font_family();

The property files does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

	}

	/**
	 * Gets the @font-face CSS.
	 *
	 * @access public
	 * @since 3.0.28
	 * @param array $variants The variants we want to get.
	 * @return string
	 */
	public function get_css( $variants = array() ) {
		if ( ! $this->files ) {

The expression $this->files of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using empty($expr) instead to make it clear that you intend to check for an array without elements.

			return;
		}
		$key    = md5( wp_json_encode( $this->files ) );
		$cached = get_transient( $key );
		if ( $cached ) {
			return $cached;
		}
		$css = '';

		// If $variants is empty then use all variants available.
		if ( empty( $variants ) ) {
			$variants = array_keys( $this->files );
		}

		// Download files.
		$this->download_font_family( $variants );

		// Create the @font-face CSS.
		foreach ( $variants as $variant ) {
			$css .= $this->get_variant_fontface_css( $variant );
		}
		set_transient( $key, $css, DAY_IN_SECONDS );

The constant DAY_IN_SECONDS was not found. Maybe you did not declare it correctly or list all dependencies?

		return $css;
	}

	/**
	 * Get the @font-face CSS for a specific variant.
	 *
	 * @access public
	 * @since 3.0.28
	 * @param string $variant The variant.
	 * @return string
	 */
	public function get_variant_fontface_css( $variant ) {
		$font_face = "@font-face{font-family:'{$this->family}';";

		// Get the font-style.
		$font_style = ( false !== strpos( $variant, 'italic' ) ) ? 'italic' : 'normal';
		$font_face .= "font-style:{$font_style};";

		// Get the font-weight.
		$font_weight = '400';

The assignment to $font_weight is dead and can be removed.

		$font_weight = str_replace( 'italic', '', $variant );
		$font_weight = ( ! $font_weight || 'regular' === $font_weight ) ? '400' : $font_weight;
		$font_face  .= "font-weight:{$font_weight};";

		// Get the font-names.
		$font_name_0 = $this->get_local_font_name( $variant, false );
		$font_name_1 = $this->get_local_font_name( $variant, true );
		$font_face  .= "src:local('{$font_name_0}'),";
		if ( $font_name_0 !== $font_name_1 ) {
			$font_face .= "local('{$font_name_1}'),";
		}

		// Get the font-url.
		$font_url = $this->get_variant_local_url( $variant );
		$paths    = $this->get_font_files_paths();
		if ( ! file_exists( $paths[ $variant ] ) ) {
			$font_url = $this->files[ $variant ];
		}

		// Get the font-format.
		$font_format = ( strpos( $font_url, '.woff2' ) ) ? 'woff2' : 'truetype';
		$font_format = ( strpos( $font_url, '.woff' ) && ! strpos( $font_url, '.woff2' ) ) ? 'woff' : $font_format;
		$font_face  .= "url({$font_url}) format('{$font_format}');}";

		return $font_face;
	}

	/**
	 * Gets the local URL for a variant.
	 *
	 * @access public
	 * @since 3.0.28
	 * @param string $variant The variant.
	 * @return string         The URL.
	 */
	public function get_variant_local_url( $variant ) {
		$local_urls = $this->get_font_files_urls_local();

		if ( empty( $local_urls ) ) {
			return;
		}

		// Return the specific variant if we can find it.
		if ( isset( $local_urls[ $variant ] ) ) {
			return $local_urls[ $variant ];
		}

		// Return regular if the one we want could not be found.
		if ( isset( $local_urls['regular'] ) ) {
			return $local_urls['regular'];
		}

		// Return the first available if all else failed.
		$vals = array_values( $local_urls );
		return $vals[0];
	}

	/**
	 * Get the name of the font-family.
	 * This is used by @font-face in case the user already has the font downloaded locally.
	 *
	 * @access public
	 * @since 3.0.28
	 * @param string $variant The variant.
	 * @param bool   $compact Whether we want the compact formatting or not.
	 * @return string
	 */
	public function get_local_font_name( $variant, $compact = false ) {
		$variant_names = array(
			'100'       => 'Thin',
			'100i'      => 'Thin Italic',
			'100italic' => 'Thin Italic',
			'200'       => 'Extra-Light',
			'200i'      => 'Extra-Light Italic',
			'200italic' => 'Extra-Light Italic',
			'300'       => 'Light',
			'300i'      => 'Light Italic',
			'300italic' => 'Light Italic',
			'400'       => 'Regular',
			'regular'   => 'Regular',
			'400i'      => 'Regular Italic',
			'italic'    => 'Italic',
			'400italic' => 'Regular Italic',
			'500'       => 'Medium',
			'500i'      => 'Medium Italic',
			'500italic' => 'Medium Italic',
			'600'       => 'Semi-Bold',
			'600i'      => 'Semi-Bold Italic',
			'600italic' => 'Semi-Bold Italic',
			'700'       => 'Bold',
			'700i'      => 'Bold Italic',
			'700italic' => 'Bold Italic',
			'800'       => 'Extra-Bold',
			'800i'      => 'Extra-Bold Italic',
			'800italic' => 'Extra-Bold Italic',
			'900'       => 'Black',
			'900i'      => 'Black Italic',
			'900italic' => 'Black Italic',
		);

		$variant = (string) $variant;
		if ( $compact ) {
			if ( isset( $variant_names[ $variant ] ) ) {
				return str_replace( array( ' ', '-' ), '', $this->family ) . '-' . str_replace( array( ' ', '-' ), '', $variant_names[ $variant ] );
			}
			return str_replace( array( ' ', '-' ), '', $this->family );
		}

		if ( isset( $variant_names[ $variant ] ) ) {
			return $this->family . ' ' . $variant_names[ $variant ];
		}
		return $this->family;
	}

	/**
	 * Get an array of font-files.
	 * Only contains the filenames.
	 *
	 * @access public
	 * @since 3.0.28
	 * @return array
	 */
	public function get_font_files() {
		$files = array();
		foreach ( $this->files as $key => $url ) {
			$files[ $key ] = $this->get_filename_from_url( $url );
		}
		return $files;
	}

	/**
	 * Get an array of local file URLs.
	 *
	 * @access public
	 * @since 3.0.28
	 * @return array
	 */
	public function get_font_files_urls_local() {
		$urls  = array();
		$files = $this->get_font_files();
		foreach ( $files as $key => $file ) {
			$urls[ $key ] = $this->folder_url . '/' . $file;
		}
		return $urls;
	}

	/**
	 * Get an array of local file paths.
	 *
	 * @access public
	 * @since 3.0.28
	 * @return array
	 */
	public function get_font_files_paths() {
		$paths = array();
		$files = $this->get_font_files();
		foreach ( $files as $key => $file ) {
			$paths[ $key ] = $this->folder_path . '/' . $file;
		}
		return $paths;
	}

	/**
	 * Downloads a font-file and saves it locally.
	 *
	 * @access private
	 * @since 3.0.28
	 * @param string $url The URL of the file we want to get.
	 * @return bool
	 */
	private function download_font_file( $url ) {
		$contents = $this->get_remote_url_contents( $url );
		$path     = $this->folder_path . '/' . $this->get_filename_from_url( $url );

		// If the folder doesn't exist, create it.
		if ( ! file_exists( $this->folder_path ) ) {
			wp_mkdir_p( $this->folder_path );
		}
		// If the file exists no reason to do anything.
		if ( file_exists( $path ) ) {
			return true;
		}

		// Write file.
		return Kirki_Helper::init_filesystem()->put_contents( $path, $contents, FS_CHMOD_FILE );

The constant FS_CHMOD_FILE was not found. Maybe you did not declare it correctly or list all dependencies?

	}

	/**
	 * Get a font-family from the array of google-fonts.
	 *
	 * @access public
	 * @since 3.0.28
	 * @return array
	 */
	public function get_font_family() {

		// Get the fonts array.
		$fonts = $this->get_fonts();
		if ( isset( $fonts[ $this->family ] ) ) {
			return $fonts[ $this->family ];
		}
		return array();
	}

	/**
	 * Gets the filename by breaking-down the URL parts.
	 *
	 * @access private
	 * @since 3.0.28
	 * @param string $url The URL.
	 * @return string     The filename.
	 */
	private function get_filename_from_url( $url ) {
		$url_parts   = explode( '/', $url );
		$parts_count = count( $url_parts );
		if ( 1 < $parts_count ) {
			return $url_parts[ count( $url_parts ) - 1 ];
		}
		return $url;
	}

	/**
	 * Get the font defined in the google-fonts API.
	 *
	 * @access private
	 * @since 3.0.28
	 * @return array
	 */
	private function get_fonts() {
		ob_start();
		include wp_normalize_path( dirname( __FILE__ ) . '/webfont-files.json' );
		$json = ob_get_clean();
		return json_decode( $json, true );
	}

	/**
	 * Gets the root fonts folder path.
	 * Other paths are built based on this.
	 *
	 * @since 1.5
	 * @access public
	 * @return string
	 */
	public function get_root_path() {

		// Get the upload directory for this site.
		$upload_dir = wp_upload_dir();
		$path       = untrailingslashit( wp_normalize_path( $upload_dir['basedir'] ) ) . '/webfonts';

		// If the folder doesn't exist, create it.
		if ( ! file_exists( $path ) ) {
			wp_mkdir_p( $path );
		}

		// Return the path.
		return apply_filters( 'kirki_googlefonts_root_path', $path );
	}

	/**
	 * Gets the root folder url.
	 * Other urls are built based on this.
	 *
	 * @since 1.5
	 * @access public
	 * @return string
	 */
	public function get_root_url() {

		// Get the upload directory for this site.
		$upload_dir = wp_upload_dir();

		// The URL.
		$url = trailingslashit( $upload_dir['baseurl'] );

		// Take care of domain mapping.
		// When using domain mapping we have to make sure that the URL to the file
		// does not include the original domain but instead the mapped domain.
		if ( defined( 'DOMAIN_MAPPING' ) && DOMAIN_MAPPING ) {

The constant DOMAIN_MAPPING was not found. Maybe you did not declare it correctly or list all dependencies?

			if ( function_exists( 'domain_mapping_siteurl' ) && function_exists( 'get_original_url' ) ) {
				$mapped_domain   = domain_mapping_siteurl( false );
				$original_domain = get_original_url( 'siteurl' );
				$url             = str_replace( $original_domain, $mapped_domain, $url );
			}
		}
		$url = str_replace( array( 'https://', 'http://' ), '//', $url );
		return apply_filters( 'kirki_googlefonts_root_url', untrailingslashit( esc_url_raw( $url ) ) . '/webfonts' );
	}

	/**
	 * Download font-family files.
	 *
	 * @access public
	 * @since 3.0.28
	 * @param array $variants An array of variants to download. Leave empty to download all.
	 * @return void
	 */
	public function download_font_family( $variants = array() ) {
		if ( empty( $variants ) ) {
			$variants = array_keys( $this->files );
		}
		foreach ( $this->files as $variant => $file ) {
			if ( in_array( $variant, $variants ) ) { // phpcs:ignore WordPress.PHP.StrictInArray.MissingTrueStrict

Not using strict comparison for in_array; supply true for third argument.

Inline comments must end in full-stops, exclamation marks, or question marks

				$this->download_font_file( $file );
			}
		}
	}

	/**
	 * Gets the remote URL contents.
	 *
	 * @access private
	 * @since 3.0.28
	 * @param string $url The URL we want to get.
	 * @return string     The contents of the remote URL.
	 */
	public function get_remote_url_contents( $url ) {
		$response = wp_remote_get( $url );
		if ( is_wp_error( $response ) ) {
			return array();
		}
		$html = wp_remote_retrieve_body( $response );
		if ( is_wp_error( $html ) ) {
			return;
		}
		return $html;
	}
}