monsterinsights_get_v4_id() - Code Metrics - Inspection of "8.0.0" - awesomemotive/google-analytics-for-wordpress - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 8403c0...3ede7f )

by Chris
created 2021-09-14 15:10 UTC
monsterinsights_get_v4_id() B

↳ Parent: Project
Complexity

Conditions	9
Paths	15
Size

Total Lines	28
Code Lines	12
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	9
eloc	12
c	1
b	0
f	0
nc	15
nop	0
dl	0
loc	28
rs	8.0555
<?php
/**
 * Option functions.
 *
 * @since 6.0.0
 *
 * @package MonsterInsights
 * @subpackage Options
 * @author  Chris Christoff
 */

// Exit if accessed directly
if ( ! defined( 'ABSPATH' ) ) {
	exit;
}

function monsterinsights_get_options() {
	$settings = array();

	$option_name = monsterinsights_get_option_name();
	//$settings             = get_site_option( $option_name );
	//$use_network_settings = ! empty( $use_network_settings['use_network_settings'] ) ? true : false;
	//$is_network           = is_multisite();

	//if ( $is_network && $use_network_settings ) {
	//    return $settings;
	//} else if ( $is_network ) {
		$settings = get_option( $option_name );
	//} else {
	//    return $settings;
	//}
	if ( empty( $settings ) || ! is_array( $settings ) ) {
		$settings = array();
	}
	return $settings;
}

/**
 * Helper method for getting a setting's value. Falls back to the default
 * setting value if none exists in the options table.
 *
 * @since 6.0.0
 * @access public
 *
 * @param string $key   The setting key to retrieve.
 * @param mixed $default   The default value of the setting key to retrieve.
 * @return string       The value of the setting.
 */
function monsterinsights_get_option( $key = '', $default = false ) {
	global $monsterinsights_settings;
	$value = ! empty( $monsterinsights_settings[ $key ] ) ? $monsterinsights_settings[ $key ] : $default;
	$value = apply_filters( 'monsterinsights_get_option', $value, $key, $default );
	return apply_filters( 'monsterinsights_get_option_' . $key, $value, $key, $default );
}

/**
 * Helper method for getting the UA string.
 *
 * @since 6.0.0
 * @access public
 *
 * @return string The UA to use.
 */
function monsterinsights_get_ua() {
	// Allow short circuiting (for staging sites)
	if ( defined( 'MONSTERINSIGHTS_DISABLE_TRACKING' ) && MONSTERINSIGHTS_DISABLE_TRACKING ) {

		return '';
	}

	// Try getting it from the auth UA
	$ua = MonsterInsights()->auth->get_ua();


	// If that didn't work, try the manual UA at the site level
	if ( empty( $ua ) ) {
		$ua = MonsterInsights()->auth->get_manual_ua();
		// If that didn't work try getting it from the network
		if ( empty( $ua ) ) {
			$ua = monsterinsights_get_network_ua();
			// If that didn't work, try getting it from the overall constant. If it's not there, leave it blank
			if ( empty( $ua ) ) {
				$ua = defined( 'MONSTERINSIGHTS_GA_UA' ) && MONSTERINSIGHTS_GA_UA ? monsterinsights_is_valid_ua( MONSTERINSIGHTS_GA_UA ) : '';

			}
		}
	}

	// Feed through the filter
	$pre_filter = $ua;
	$ua = apply_filters( 'monsterinsights_get_ua', $ua );

	// Only run through monsterinsights_is_valid_ua if it's different than pre-filter
	return $pre_filter === $ua ? $ua : monsterinsights_is_valid_ua( $ua );
}

function monsterinsights_get_tracking_ids() {
	$ids = array();

	$ua = monsterinsights_get_ua_to_output();
	if ( $ua ) {
		$ids[] = $ua;
	}

	$v4 = monsterinsights_get_v4_id_to_output();
	if ( $v4 ) {
		$ids[] = $v4;
	}

	return $ids;
}

/**
 * Helper method for getting the network UA string.
 *
 * @since 6.0.0
 * @access public
 *
 * @return string The UA to use.
 */
function monsterinsights_get_network_ua() {
	if ( ! is_multisite() ) {
		return '';
	}

	// First try network auth UA
	$ua = MonsterInsights()->auth->get_network_ua();

	if ( ! empty( $ua ) ) {
		return $ua;
	}

	// Then try manual network UA
	$ua = MonsterInsights()->auth->get_network_manual_ua();
	if ( ! empty( $ua ) ) {
		return $ua;
	}

	// See if the constant is defined
	if ( defined( 'MONSTERINSIGHTS_MS_GA_UA' ) && monsterinsights_is_valid_ua( MONSTERINSIGHTS_MS_GA_UA ) ) {

		return MONSTERINSIGHTS_MS_GA_UA;
	}

	return '';
}

/**
 * Helper method for getting the UA string that's output on the frontend.
 *
 * @since 6.0.0
 * @access public
 *
 * @param array $args Allow calling functions to give args to use in future applications.
 * @return string The UA to use on frontend.
 */
function monsterinsights_get_ua_to_output( $args = array() ) {
	$ua = monsterinsights_get_ua();
	$ua = apply_filters( 'monsterinsights_get_ua_to_output', $ua, $args );
	return monsterinsights_is_valid_ua( $ua );
}

/**
 * Helper method for getting the V4 string.
 *
 * @since 6.0.0
 * @access public
 *
 * @return string The V4 ID to use.
 */
function monsterinsights_get_v4_id() {
	// Allow short circuiting (for staging sites)
	if ( defined( 'MONSTERINSIGHTS_DISABLE_TRACKING' ) && MONSTERINSIGHTS_DISABLE_TRACKING ) {

		return '';
	}

	// Try getting it from the auth V4
	$v4_id = MonsterInsights()->auth->get_v4_id();


	// If that didn't work, try the manual V4 at the site level
	if ( empty( $v4_id ) ) {
		$v4_id = MonsterInsights()->auth->get_manual_v4_id();
		// If that didn't work try getting it from the network
		if ( empty( $v4_id ) ) {
			$v4_id = monsterinsights_get_network_v4_id();
			// If that didn't work, try getting it from the overall constant. If it's not there, leave it blank
			if ( empty( $v4_id ) ) {
				$v4_id = defined( 'MONSTERINSIGHTS_GA_V4_ID' ) && MONSTERINSIGHTS_GA_V4_ID ? monsterinsights_is_valid_v4_id( MONSTERINSIGHTS_GA_V4_ID ) : '';

			}
		}
	}

	// Feed through the filter
	$pre_filter = $v4_id;
	$v4_id = apply_filters( 'monsterinsights_get_v4_id', $v4_id );

	// Only run through monsterinsights_is_valid_v4 if it's different than pre-filter
	return $pre_filter === $v4_id ? $v4_id : monsterinsights_is_valid_v4_id( $v4_id );
}

/**
 * Helper method for getting the network V4 string.
 *
 * @since 6.0.0
 * @access public
 *
 * @return string The V4 ID to use.
 */
function monsterinsights_get_network_v4_id() {
	if ( ! is_multisite() ) {
		return '';
	}

	// First try network auth UA
	$v4_id = MonsterInsights()->auth->get_network_v4_id();

	if ( ! empty( $v4_id ) ) {
		return $v4_id;
	}

	// Then try manual network UA
	$v4_id = MonsterInsights()->auth->get_network_manual_v4_id();
	if ( ! empty( $v4_id ) ) {
		return $v4_id;
	}

	// See if the constant is defined
	if ( defined( 'MONSTERINSIGHTS_MS_GA_V4_ID' ) && monsterinsights_is_valid_v4_id( MONSTERINSIGHTS_MS_GA_V4_ID ) ) {

		return MONSTERINSIGHTS_MS_GA_V4_ID;
	}

	return '';
}

/**
 * Helper method for getting the UA string that's output on the frontend.
 *
 * @since 6.0.0
 * @access public
 *
 * @param array $args Allow calling functions to give args to use in future applications.
 * @return string The UA to use on frontend.
 */
function monsterinsights_get_v4_id_to_output( $args = array() ) {
	$v4_id = monsterinsights_get_v4_id();
	$v4_id = apply_filters( 'monsterinsights_get_v4_id_to_output', $v4_id, $args );
	return monsterinsights_is_valid_v4_id( $v4_id );
}

/**
 * Helper method for updating a setting's value.
 *
 * @since 6.0.0
 * @access public
 *
 * @param string $key   The setting key.
 * @param string $value The value to set for the key.
 * @return boolean True if updated, false if not.
 */
function monsterinsights_update_option( $key = '', $value = false ) {

	// If no key, exit
	if ( empty( $key ) ){
		return false;
	}

	if ( empty( $value ) ) {
		$remove_option = monsterinsights_delete_option( $key );
		return $remove_option;
	}

	$option_name = monsterinsights_get_option_name();

	// First let's grab the current settings

	// if on network panel or if on single site using network settings
	//$settings              = get_site_option( $option_name );
	//$use_network_settings  = ! empty( $use_network_settings['use_network_settings'] ) ? true : false;
	//$is_network            = is_multisite();
	//$update_network_option = true;
	//if ( ! is_network_admin() && ! ( $is_network && $use_network_settings ) ) {
	   $settings = get_option( $option_name );
	//   $update_network_option = false;
	//}

	if ( ! is_array( $settings ) ) {
		$settings = array();
	}

	// Let's let devs alter that value coming in
	$value = apply_filters( 'monsterinsights_update_option', $value, $key );

	// Next let's try to update the value
	$settings[ $key ] = $value;
	$did_update = false;

	//if ( $update_network_option ) {
	//    $did_update = update_site_option( $option_name, $settings );
	//} else {
		$did_update = update_option( $option_name, $settings );
	//}

	// If it updated, let's update the global variable
	if ( $did_update ){
		global $monsterinsights_settings;
		$monsterinsights_settings[ $key ] = $value;
	}

	return $did_update;
}

 /**
 * Helper method for deleting a setting's value.
 *
 * @since 6.0.0
 * @access public
 *
 * @param string $key   The setting key.
 * @return boolean True if removed, false if not.
 */
function monsterinsights_delete_option( $key = '' ) {
	// If no key, exit
	if ( empty( $key ) ){
		return false;
	}

	$option_name = monsterinsights_get_option_name();

	// First let's grab the current settings

	// if on network panel or if on single site using network settings
	//$settings              = get_site_option( $option_name );
	//$use_network_settings  = ! empty( $use_network_settings['use_network_settings'] ) ? true : false;
	//$is_network            = is_multisite();
	//$update_network_option = true;
	//if ( ! is_network_admin() && ! ( $is_network && $use_network_settings ) ) {
	   $settings = get_option( $option_name );
	//   $update_network_option = false;
	//}

	// Next let's try to remove the key
	if( isset( $settings[ $key ] ) ) {
		unset( $settings[ $key ] );
	}

	$did_update = false;

	//if ( $update_network_option ) {
	//    $did_update = update_site_option( 'monsterinsights_settings', $settings );
	//} else {
		$did_update = update_option( $option_name, $settings );
	//}

	// If it updated, let's update the global variable
	if ( $did_update ){
		global $monsterinsights_settings;
		$monsterinsights_settings = $settings;
	}

	return $did_update;
}

 /**
 * Helper method for deleting multiple settings value.
 *
 * @since 6.0.0
 * @access public
 *
 * @param string $key   The setting key.
 * @return boolean True if removed, false if not.
 */
function monsterinsights_delete_options( $keys = array() ) {
	// If no keys, exit
	if ( empty( $keys ) || ! is_array( $keys ) ){
		return false;
	}

	$option_name = monsterinsights_get_option_name();

	// First let's grab the current settings

	// if on network panel or if on single site using network settings
	//$settings              = get_site_option( $option_name );
	//$use_network_settings  = ! empty( $use_network_settings['use_network_settings'] ) ? true : false;
	//$is_network            = is_multisite();
	//$update_network_option = true;
	//if ( ! is_network_admin() && ! ( $is_network && $use_network_settings ) ) {
	   $settings = get_option( $option_name );
	//   $update_network_option = false;
	//}

	// Next let's try to remove the keys
	foreach ( $keys as $key ) {
		if( isset( $settings[ $key ] ) ) {
			unset( $settings[ $key ] );
		}
	}

	$did_update = false;

	//if ( $update_network_option ) {
	//    $did_update = update_site_option( 'monsterinsights_settings', $settings );
	//} else {
		$did_update = update_option( $option_name, $settings );
	//}

	// If it updated, let's update the global variable
	if ( $did_update ){
		global $monsterinsights_settings;
		$monsterinsights_settings = $settings;
	}

	return $did_update;
}

function monsterinsights_sanitize_tracking_id( $id ) {
	$id = (string) $id; // Rare case, but let's make sure it never happens.
	$id = trim( $id );

	if ( empty( $id ) ) {
		return '';
	}

	// Replace all type of dashes (n-dash, m-dash, minus) with normal dashes.
	$id = str_replace( array( '–', '—', '−' ), '-', $id );

	return $id;
}

/**
 * Is valid ua code.
 *
 * @access public
 * @since 6.0.0
 *
 * @param string $ua_code UA code to check validity for.
 *
 * @return string|false Return cleaned ua string if valid, else returns false.
 */
function monsterinsights_is_valid_ua( $ua_code = '' ) {
	$ua_code = monsterinsights_sanitize_tracking_id( $ua_code );

	if ( preg_match( "/^(UA|YT|MO)-\d{4,}-\d+$/", $ua_code ) ) {
		return $ua_code;
	}

	return '';
}

function monsterinsights_is_valid_v4_id( $v4_code = '' ) {
	$v4_code = monsterinsights_sanitize_tracking_id( $v4_code );

	if ( preg_match( '/G-[A-Za-z\d]+/', $v4_code ) ) {
		return strtoupper( $v4_code );
	}

	return '';
}

/**
 * Helper method for getting the license information.
 *
 * @since 6.0.0
 * @access public
 *
 * @param string $key   The setting key to retrieve.
 * @param mixed $default_value   The default value of the setting key to retrieve.
 * @return string       The value of the setting.
 */
function monsterinsights_get_license() {
	$license  = MonsterInsights()->license->get_site_license();

	$license  = $license ? $license : MonsterInsights()->license->get_network_license();
	$default  = MonsterInsights()->license->get_default_license_key();
	if ( empty( $license ) && ! empty( $default ) ) {
		$license        = array();
		$license['key'] = MonsterInsights()->license->get_default_license_key();
	}
	return $license;
}

/**
 * Helper method for getting the license key.
 *
 * @since 6.0.0
 * @access public
 *
 * @param string $key   The setting key to retrieve.
 * @param mixed $default_value   The default value of the setting key to retrieve.
 * @return string       The value of the setting.
 */
function monsterinsights_get_license_key() {
	if ( monsterinsights_is_pro_version() ) {
		return MonsterInsights()->license->get_license_key();

	}
	return '';
}

function monsterinsights_get_option_name() {
	//if ( monsterinsights_is_pro_version() ) {
		return 'monsterinsights_settings';
	//} else {
	//	return 'monsterinsights_settings';
	//}
}

function monsterinsights_export_settings() {
	$settings = monsterinsights_get_options();
	$exclude  = array(
				'analytics_profile',
				'analytics_profile_code',
				'analytics_profile_name',
				'oauth_version',
				'cron_last_run',
				'monsterinsights_oauth_status',
	);

	foreach ( $exclude as $e ) {
		if ( ! empty( $settings[ $e ] ) ) {
			unset( $settings[ $e ] );
		}
	}
	return wp_json_encode( $settings );
}

/**
 * Always return 'gtag' when grabbing the tracking mode.
 *
 * @param string $value The value to override.
 *
 * @return string
 */
function monsterinsights_force_tracking_mode( $value ) {
function monsterinsights_force_tracking_mode( /** @scrutinizer ignore-unused */ $value ) {
	return 'gtag';
}
add_filter( 'monsterinsights_get_option_tracking_mode', 'monsterinsights_force_tracking_mode' );

/**
 * Always return 'js' when grabbing the events mode.
 *
 * @param string $value The value to override.
 *
 * @return string
 */
function monsterinsights_force_events_mode( $value ) {
function monsterinsights_force_events_mode( /** @scrutinizer ignore-unused */ $value ) {
	return 'js';
}
add_filter( 'monsterinsights_get_option_events_mode', 'monsterinsights_force_events_mode' );

awesomemotive / google-analytics-for-wordpress

Push — master ( 8403c0...3ede7f )

monsterinsights_get_v4_id() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
