get_options();
$this->module_enabled = isset( $options['cfp']['enabled'] ) && $options['cfp']['enabled'];
add_filter( 'advanced-ads-output-wrapper-options', array( $this, 'add_wrapper' ), 25, 2 );
add_filter( 'advanced-ads-ad-output', array( $this, 'ad_output' ), 99, 2 );
add_action( 'wp_head', array( $this, 'wp_head' ) );
add_filter( 'advanced-ads-can-display', array( $this, 'can_display' ), 10, 3 );
// add visitor conditions
add_filter( 'advanced-ads-visitor-conditions', array( $this, 'add_visitor_conditions' ) );
add_filter( 'advanced-ads-js-visitor-conditions', array( $this, 'add_to_passive_cache_busting' ) );
//Add new node to 'Ad health' if the user is banned.
add_filter( 'advanced-ads-ad-health-nodes', array( $this, 'add_ad_health_node' ) );
// delete ban cookie before any output
add_action( 'init', array( $this, 'delete_ban_cookie' ), 50 );
if ( $this->module_enabled ) {
add_filter( 'advanced-ads-output-wrapper-options', array( $this, 'add_wrapper_options' ), 10, 2 );
add_filter( 'advanced-ads-output-wrapper-options-group', array( $this, 'add_wrapper_options_group' ), 10, 2 );
add_filter( 'advanced-ads-pro-ad-needs-backend-request', array( $this, 'ad_needs_backend_request' ), 10, 1 );
}
}
/**
* determine cookies parameter (domain or path)
*/
private function get_path_and_domain() {
$path = '';
$site_url = site_url();
$domain = '';
// get host name form server first before getting client side value
$host_name = !empty( $_SERVER['SERVER_NAME'] )? $_SERVER['SERVER_NAME'] : $_SERVER['HTTP_HOST'];
$expl_url = explode( '.', $site_url );
if ( 2 < count( $expl_url ) ) {
// using subdomain
$domain = $host_name;
}
$path = explode( $host_name, $site_url );
if ( isset( $path[1] ) ) {
$path = $path[1];
} else {
$path = $path[0];
}
return array(
'path' => $path,
'domain' => $domain,
);
}
private function get_conditions_options( $ad ) {
$options = $ad->options();
if ( !isset( $options['visitors'] ) ) return array();
$results = array();
foreach( $options['visitors'] as $cond ) {
if ( isset( $cond['type'] ) && 'ad_clicks' == $cond['type'] ) {
$results[] = $cond;
}
}
return $results;
}
/**
* Notify passive cache-busting that this condition can be checked using JavaScript.
*/
public function add_to_passive_cache_busting( $conditions ) {
$conditions[] = 'ad_clicks';
return $conditions;
}
/**
* add the visitor condition
*/
public function add_visitor_conditions( $conditions ) {
$conditions['ad_clicks'] = array(
'label' => __( 'max. ad clicks', 'advanced-ads-pro' ),
'description' => __( 'Display ad only if a click limit has not been reached', 'advanced-ads-pro' ),
'metabox' => array( $this, 'visitor_conditions_metabox' ), // callback to generate the metabox
'check' => array( $this, 'visitor_conditions_check' ) // callback for frontend check
);
return $conditions;
}
/**
* render the markup for visitor condition
*/
public function visitor_conditions_metabox( $options, $index = 0, $form_name = '' ) {
if ( ! isset ( $options['type'] ) || '' === $options['type'] ) { return; }
$type_options = Advanced_Ads_Visitor_Conditions::get_instance()->conditions;
if ( ! isset( $type_options[ $options['type'] ] ) ) {
return;
}
// form name basis
$name = Advanced_Ads_Pro_Module_Advanced_Visitor_Conditions::get_form_name_with_index( $form_name, $index );
// options
$limit = isset( $options['limit'] ) ? Advanced_Ads_Pro_Utils::absint( $options['limit'], 1 ) : 1 ;
$expiration = isset( $options['expiration'] ) ? Advanced_Ads_Pro_Utils::absint( $options['expiration'], 1 ) : 1;
?>
module_enabled && isset( $_COOKIE['advads_pro_cfp_ban'] ) && !headers_sent() ) {
$pnd = $this->get_path_and_domain();
$path = '' != $pnd['path'] ? $pnd['path'] : '/';
if ( '' != $pnd['domain'] ) {
setcookie( 'advads_pro_cfp_ban', '0', time() - 3600, $path, $pnd['domain'] );
} else {
setcookie( 'advads_pro_cfp_ban', '0', time() - 3600, $path );
}
}
}
/**
* front end check for the visitor condition
*/
public function visitor_conditions_check( $options = array(), $ad = false ) {
if ( isset( $_COOKIE['advads_pro_cfp_ban'] ) ) {
// banned user
return false;
}
if ( isset( $_COOKIE['advanced_ads_ad_clicks_' . $ad->id] ) ) {
$cval = json_decode( stripslashes( $_COOKIE['advanced_ads_ad_clicks_' . $ad->id] ), true );
$update_cookie = false;
$now = time();
foreach( $cval as $key => $value ) {
// check against the right value in case of multiple ad clicks conditions
if ( '_' . $options['expiration'] == $key ) {
if ( $now >= absint( $value['ttl'] ) ) {
// expired TTL - just skip, cookie will be updated client side
return true;
} else {
if ( absint( $value['count'] ) >= absint( $options['limit'] ) ) {
return false;
}
}
}
}
}
return true;
}
/**
* determine if ads should be hidden
*/
public function can_display( $can_display, $ad, $check_options ) {
if ( ! empty( $check_options['passive_cache_busting'] ) ) {
return $can_display;
}
// banned user && module enabled
if ( $this->module_enabled && isset( $_COOKIE['advads_pro_cfp_ban'] ) ) {
return false;
}
return $can_display;
}
/**
* create early the constructor used in ad output
*/
public function wp_head() {
// Do not enqueue on AMP pages.
if ( function_exists( 'advads_is_amp' ) && advads_is_amp() ) {
return;
}
if ( ! $this->module_enabled ) {
return;
}
$options = Advanced_Ads_Pro::get_instance()->get_options();
$exphours = isset( $options['cfp']['cookie_expiration'] )? $options['cfp']['cookie_expiration'] : 3;
$ban_duration = isset( $options['cfp']['ban_duration'] )? $options['cfp']['ban_duration'] : 7;
$click_limit = isset( $options['cfp']['click_limit'] )? absint( $options['cfp']['click_limit'] ) : 3;
$path = '';
$domain = '';
$pnd = $this->get_path_and_domain();
$path = $pnd['path'];
$domain = $pnd['domain'];
?>get_conditions_options( $ad );
if ( !empty( $cond ) || $this->module_enabled ) {
$output .= '';
}
return $output;
}
/**
* add the HTML attribute for front end JS
*/
public function add_wrapper( $wrapper, $ad ) {
$cond = $this->get_conditions_options( $ad );
if ( !empty( $cond ) || $this->module_enabled ) {
$wrapper['data-cfpa'] = $ad->id;
// print all expiration hours
if ( !empty( $cond ) ) {
$hours = array();
foreach( $cond as $_c ) {
$hours[] = floatval( $_c['expiration'] );
}
$wrapper['data-cfph'] = implode( '_', $hours );
}
}
return $wrapper;
}
/**
* Add new node to 'Ad health' if the user is banned.
*
* @param array $nodes.
* @return bool array $nodes.
*/
public function add_ad_health_node( $nodes ) {
if ( isset( $_COOKIE['advads_pro_cfp_ban'] ) ) {
$nodes[] = array( 'type' => 1, 'data' => array(
'parent' => 'advanced_ads_ad_health',
'id' => 'advanced_ads_ad_health_cfp_enabled',
'title' => __( 'Click Fraud Protection enabled', 'advanced-ads-pro' ),
'href' => 'https://wpadvancedads.com/manual/click-fraud-protection',
'meta' => array(
'class' => 'advanced_ads_ad_health_warning',
'target' => '_blank'
)
) );
}
return $nodes;
}
/**
* Add the data attribute to the top level wrapper when it is an ad wrapper.
*
* @param array $options Wrapper options.
* @param Advanced_Ads_Ad $ad Ad object.
*/
public function add_wrapper_options( $options = array(), Advanced_Ads_Ad $ad ) {
if ( ! empty( $ad->args['is_top_level'] ) ) {
$options['data-cfptl'] = true;
}
return $options;
}
/**
* Add the data attribute to the top level wrapper when it is a group wrapper.
*
* @param array $options Wrapper options.
* @param Advanced_Ads_Group $group group object.
*/
public function add_wrapper_options_group( $options = array(), Advanced_Ads_Group $group ) {
if ( ! empty( $group->ad_args['is_top_level'] ) ) {
$options['data-cfptl'] = true;
}
return $options;
}
/**
* Enable cache-busting if the module is enabled.
*
* @param string $return What cache-busting type is needed.
* @return string $return What cache-busting type is needed.
*/
public function ad_needs_backend_request( $return ) {
if ( 'static' === $return ) {
return 'passive';
}
return $return;
}
}