File Editor

Directories:

Files:

Create New File

Edit File: class-wordads-params.php

<?php
/**
 * WordAds Param Class file.
 *
 * @package automattic/jetpack
 */

use Automattic\Jetpack\Status;

/**
 * Class WordAds_Params
 *
 * Sets parameters for WordAds.
 */
class WordAds_Params {
	/**
	 * WordAds options
	 *
	 * @var array
	 */
	public $options;

/**
	 * Current URL
	 *
	 * @access public
	 * @var string
	 */
	public $url;

/**
	 * Is this site served by CloudFlare?
	 *
	 * @access public
	 * @var bool
	 */
	public $cloudflare;

/**
	 * Jetpack Blog ID
	 *
	 * @var mixed
	 */
	public $blog_id;

/**
	 * Determine if the current User Agent is a mobile device
	 *
	 * @var bool
	 */
	public $mobile_device;

/**
	 * WordAds targeting tags
	 *
	 * @var array
	 */
	public $targeting_tags;

/**
	 * Type of page that is being loaded
	 *
	 * @var string
	 */
	public $page_type;

/**
	 * Page type code for IPW config
	 *
	 * @var int
	 */
	public $page_type_ipw;

/**
	 * Setup parameters for serving the ads
	 *
	 * @since 4.5.0
	 */
	public function __construct() {
		// WordAds setting => default.
		$settings = array(
			'wordads_approved'                => false,
			'wordads_active'                  => false,
			'wordads_house'                   => true,
			'wordads_unsafe'                  => false,
			'enable_header_ad'                => true,
			'wordads_second_belowpost'        => true,
			'wordads_inline_enabled'          => true,
			'wordads_display_front_page'      => true,
			'wordads_display_post'            => true,
			'wordads_display_page'            => true,
			'wordads_display_archive'         => true,
			'wordads_custom_adstxt'           => '',
			'wordads_custom_adstxt_enabled'   => false,
			'wordads_ccpa_enabled'            => false,
			'wordads_ccpa_privacy_policy_url' => get_option( 'wp_page_for_privacy_policy' ) ? get_permalink( (int) get_option( 'wp_page_for_privacy_policy' ) ) : '',
			'wordads_cmp_enabled'             => false,
		);

// Grab settings, or set as default if it doesn't exist.
		$this->options = array();

foreach ( $settings as $setting => $default ) {
			$option = get_option( $setting, null );

if ( $option === null ) {

// Handle retroactively setting wordads_custom_adstxt_enabled to true if custom ads.txt content is already entered.
				if ( 'wordads_custom_adstxt_enabled' === $setting ) {
					$default = get_option( 'wordads_custom_adstxt' ) !== '';
				}

// Convert boolean options to string first to work around update_option not setting the option if the value is false.
				// This sets the option to either '1' if true or '' if false.
				update_option( $setting, (string) $default, true );

$option = $default;
			}

$this->options[ $setting ] = is_bool( $default ) ? (bool) $option : $option;
		}

$this->url = esc_url_raw( ( is_ssl() ? 'https' : 'http' ) . '://' . ( isset( $_SERVER['HTTP_HOST'] ) ? wp_unslash( $_SERVER['HTTP_HOST'] ) : 'localhost' ) . ( isset( $_SERVER['REQUEST_URI'] ) ? wp_unslash( $_SERVER['REQUEST_URI'] ) : '' ) );
		if ( str_contains( $this->url, '?' ) && ! isset( $_GET['p'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
			$this->url = substr( $this->url, 0, strpos( $this->url, '?' ) );
		}

$this->cloudflare     = self::is_cloudflare();
		$this->blog_id        = Jetpack::get_option( 'id', 0 );
		$this->mobile_device  = jetpack_is_mobile( 'any', true );
		$this->targeting_tags = array(
			'WordAds' => 1,
			'BlogId'  => ( new Status() )->is_offline_mode() ? 0 : Jetpack_Options::get_option( 'id' ),
			'Domain'  => esc_js( wp_parse_url( home_url(), PHP_URL_HOST ) ),
			'PageURL' => esc_js( $this->url ),
			'LangId'  => str_contains( get_bloginfo( 'language' ), 'en' ) ? 1 : 0, // TODO something else?
			'AdSafe'  => 1, // TODO.
		);
	}

/**
	 * Is this a mobile device?
	 *
	 * @return boolean true if the user is browsing on a mobile device (iPad not included)
	 *
	 * @since 4.5.0
	 */
	public function is_mobile() {
		return ! empty( $this->mobile_device );
	}

/**
	 * Is this site served by CloudFlare?
	 *
	 * @return boolean true if site is being served via CloudFlare
	 *
	 * @since 4.5.0
	 */
	public static function is_cloudflare() {
		if (
			defined( 'WORDADS_CLOUDFLARE' )
			|| isset( $_SERVER['HTTP_CF_CONNECTING_IP'] )
			|| isset( $_SERVER['HTTP_CF_IPCOUNTRY'] )
			|| isset( $_SERVER['HTTP_CF_VISITOR'] )
		) {
			return true;
		}

return false;
	}

/**
	 * Is this an iOS device?
	 *
	 * @return boolean true if user is browsing in iOS device
	 *
	 * @since 4.5.0
	 */
	public function is_ios() {
		return in_array( $this->get_device(), array( 'ipad', 'iphone', 'ipod' ), true );
	}

/**
	 * Returns the user's device (see user-agent.php) or 'desktop'
	 *
	 * @return string user device
	 *
	 * @since 4.5.0
	 */
	public function get_device() {
		global $agent_info;

if ( ! empty( $this->mobile_device ) ) {
			return $this->mobile_device;
		}

if ( $agent_info->is_ipad() ) {
			return 'ipad';
		}

return 'desktop';
	}

/**
	 * Get page type.
	 *
	 * @return string The type of page that is being loaded
	 *
	 * @since 4.5.0
	 */
	public function get_page_type() {
		if ( ! empty( $this->page_type ) ) {
			return $this->page_type;
		}

if ( self::is_static_home() ) {
			$this->page_type = 'static_home';
		} elseif ( is_home() ) {
			$this->page_type = 'home';
		} elseif ( is_page() ) {
			$this->page_type = 'page';
		} elseif ( is_single() ) {
			$this->page_type = 'post';
		} elseif ( is_search() ) {
			$this->page_type = 'search';
		} elseif ( is_category() ) {
			$this->page_type = 'category';
		} elseif ( is_archive() ) {
			$this->page_type = 'archive';
		} else {
			$this->page_type = 'wtf';
		}

return $this->page_type;
	}

/**
	 * Get IPW code.
	 *
	 * @return int The page type code for ipw config
	 *
	 * @since 5.6.0
	 */
	public function get_page_type_ipw() {
		if ( ! empty( $this->page_type_ipw ) ) {
			return $this->page_type_ipw;
		}

$page_type_ipw = 6;
		if ( self::is_static_home() || is_home() || is_front_page() ) {
			$page_type_ipw = 0;
		} elseif ( is_page() ) {
			$page_type_ipw = 2;
		} elseif ( is_singular() ) {
			$page_type_ipw = 1;
		} elseif ( is_search() ) {
			$page_type_ipw = 4;
		} elseif ( is_category() || is_tag() || is_archive() || is_author() ) {
			$page_type_ipw = 3;
		} elseif ( is_404() ) {
			$page_type_ipw = 5;
		}

$this->page_type_ipw = $page_type_ipw;
		return $page_type_ipw;
	}

/**
	 * Returns true if page is static home
	 *
	 * @return boolean true if page is static home
	 *
	 * @since 4.5.0
	 */
	public static function is_static_home() {
		return is_front_page() &&
			'page' === get_option( 'show_on_front' ) &&
			get_option( 'page_on_front' );
	}

/**
	 * Logic for if we should show an ad
	 *
	 * @since 4.5.0
	 */
	public function should_show() {
		global $wp_query;
		if ( ( is_front_page() || is_home() ) && ! $this->options['wordads_display_front_page'] ) {
			return false;
		}

if ( is_single() && ! $this->options['wordads_display_post'] ) {
			return false;
		}

if ( is_page() && ! $this->options['wordads_display_page'] ) {
			return false;
		}

if ( ( is_archive() || is_search() ) && ! $this->options['wordads_display_archive'] ) {
			return false;
		}

if ( is_single() || ( is_page() && ! is_home() ) ) {
			return true;
		}

// TODO this would be a good place for allowing the user to specify.
		if ( ( is_home() || is_archive() || is_search() ) && 0 === $wp_query->current_post ) {
			return true;
		}

return false;
	}
}

File Editor

Directories:

Files:

Create New File

Edit File: class-wordads-params.php

Rename File