plugin_updates(); // Load config and modules. $options = $this->get_options(); Advanced_Ads_ModuleLoader::loadModules( AAP_PATH . '/modules/', isset( $options['modules'] ) ? $options['modules'] : [] ); // Load admin on demand. if ( is_admin() ) { new Advanced_Ads_Pro_Admin(); // Run after the internal Advanced Ads version has been updated by the `Advanced_Ads_Upgrades`, because. // The `Admin_Notices` can update this version, and the `Advanced_Ads_Upgrades` will not be called. add_action( 'init', [ $this, 'maybe_update_capabilities' ] ); add_filter( 'advanced-ads-notices', [ $this, 'add_notices' ] ); } else { // Force advanced js file to be attached. add_filter( 'advanced-ads-activate-advanced-js', '__return_true' ); // Check autoptimize. if ( method_exists( 'Advanced_Ads_Checks', 'requires_noptimize_wrapping' ) && Advanced_Ads_Checks::requires_noptimize_wrapping() && ! isset( $options['autoptimize-support-disabled'] ) ) { add_filter( 'advanced-ads-output-inside-wrapper', [ $this, 'autoptimize_support' ] ); } } new Advanced_Ads_Pro_Compatibility(); add_action( 'wp_loaded', [ $this, 'wp_loaded' ] ); add_filter( 'advanced-ads-can-display-ad', [ $this, 'can_display_by_display_limit' ], 10, 3 ); add_filter( 'advanced-ads-ad-output', [ $this, 'add_custom_code' ], 30, 2 ); add_filter( 'advanced-ads-ad-output', [ $this, 'encode_ad_custom_code' ], 20, 2 ); add_filter( 'advanced-ads-placement-content-offsets', [ $this, 'placement_content_offsets' ], 10, 6 ); add_action( 'wp_head', [ $this, 'wp_head' ] ); add_action( 'wp_enqueue_scripts', [ $this, 'wp_enqueue_scripts' ] ); } /** * Remove shortcodes from the free plugin then replace it with the new ones * * @return void */ public function wp_loaded() { $this->remove_shortcodes(); $this->add_shortcodes(); } /** * Remove free plugin's shortcodes * * @return void */ public function remove_shortcodes() { remove_shortcode( 'the_ad' ); remove_shortcode( 'the_ad_group' ); remove_shortcode( 'the_ad_placement' ); } /** * Add new shortcodes * * @return void */ public function add_shortcodes() { add_shortcode( 'the_ad', [ $this, 'shortcode_display_ad' ] ); add_shortcode( 'the_ad_group', [ $this, 'shortcode_display_ad_group' ] ); add_shortcode( 'the_ad_placement', [ $this, 'shortcode_display_ad_placement' ] ); } /** * Enqueue front end script. */ public function wp_enqueue_scripts() { // Do not enqueue on AMP pages. if ( function_exists( 'advads_is_amp' ) && advads_is_amp() ) { return; } wp_enqueue_script( self::FRONTEND_SCRIPT_HANDLE, sprintf( '%sassets/js/advanced-ads-pro%s.js', AAP_BASE_URL, defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ? '' : '.min' ), [ 'jquery', ADVADS_SLUG . '-advanced-js' ], AAP_VERSION, true ); wp_localize_script( self::FRONTEND_SCRIPT_HANDLE, 'advanced_ads_cookies', [ 'cookie_path' => COOKIEPATH, 'cookie_domain' => COOKIE_DOMAIN, ] ); } /** * Front end header script. */ public function wp_head() { // Do not enqueue on AMP pages. if ( function_exists( 'advads_is_amp' ) && advads_is_amp() ) { return; } ?> options ) ) { $default_options = []; $this->options = get_option( self::OPTION_KEY, $default_options ); // Handle previous option key. if ( $this->options === [] ) { $old_options = get_option( self::OPTION_KEY . '-modules', false ); if ( $old_options ) { // Update old options. $this->update_options( $old_options ); delete_option( self::OPTION_KEY . '-modules' ); } } if ( ! isset( $this->options['placement-positioning'] ) ) { $this->options['placement-positioning'] = 'php'; } } return $this->options; } /** * Set a specific option. * * @param string $key key to identify the option. * @param mixed $value value of the option. */ public function set_option( $key, $value ) { $options = $this->get_options(); $options[ $key ] = $value; $this->update_options( $options ); } /** * Update all Advanced Ads Pro options. * * @param array $options */ public function update_options( array $options ) { $updated = update_option( self::OPTION_KEY, $options ); if ( $updated ) { $this->options = $options; } } /** * Add autoptimize support * * @param string $ad_content ad content. * @return string output that should not be changed by Autoptimize. */ public function autoptimize_support( $ad_content = '' ) { return '' . $ad_content . ''; } /** * Return internal plugin options, these are options set by the plugin * * @param bool $set_defaults true if we set default options. * @return array $options */ public function internal_options( $set_defaults = true ) { if ( ! $set_defaults ) { return get_option( 'Advanced Ads Pro' . '-internal', [] ); } if ( ! isset( $this->internal_options ) ) { $defaults = [ 'version' => AAP_VERSION, ]; $this->internal_options = get_option( 'Advanced Ads Pro' . '-internal', [] ); // Save defaults. if ( $this->internal_options === [] ) { $this->internal_options = $defaults; $this->update_internal_options( $this->internal_options ); } } return $this->internal_options; } /** * Update internal plugin options * * @param array $options new internal options. */ public function update_internal_options( array $options ) { $this->internal_options = $options; update_option( 'Advanced Ads Pro' . '-internal', $options ); } /** * Update capabilities and warn user if needed */ public function maybe_update_capabilities() { $internal_options = $this->internal_options( false ); if ( ! isset( $internal_options['version'] ) ) { $roles = [ 'advanced_ads_admin', 'advanced_ads_manager' ]; // Add notice if there is at least 1 user with that role. foreach ( $roles as $role ) { $users_query = new WP_User_Query( [ 'fields' => 'ID', 'number' => 1, 'role' => $role, ] ); if ( count( $users_query->get_results() ) ) { Advanced_Ads_Admin_Notices::get_instance()->add_to_queue( 'pro_changed_caps' ); break; } } $admin_role = get_role( 'advanced_ads_admin' ); if ( $admin_role ) { $admin_role->add_cap( 'upload_files' ); $admin_role->add_cap( 'unfiltered_html' ); } $manager_role = get_role( 'advanced_ads_manager' ); if ( $manager_role ) { $manager_role->add_cap( 'upload_files' ); $manager_role->add_cap( 'unfiltered_html' ); } // Save new version. $this->internal_options(); } } /** * Add potential warning to global array of notices. * * @param array $notices existing notices. * * @return mixed */ public function add_notices( $notices ) { $notices['pro_changed_caps'] = [ 'type' => 'update', 'text' => __( 'Please note, the “Ad Admin“ and the “Ad Manager“ roles have the “upload_files“ and the “unfiltered_html“ capabilities', 'advanced-ads-pro' ), 'global' => true, ]; $message = wp_kses( sprintf( /* translators: 1 is the opening link to the Advanced Ads website, 2 the closing link */ __( 'We have renamed the Responsive Ads add-on to ‘Advanced Ads AMP Ads’. With this change, the Browser Width visitor condition moved from that add-on into Advanced Ads Pro. You can deactivate ‘Advanced Ads AMP Ads’ if you don’t utilize AMP ads or the custom sizes feature for responsive AdSense ad units. %1$sRead more%2$s.', 'advanced-ads-pro' ), '', '' ), [ 'a' => [ 'href' => true, 'target' => true, 'class' => true, ], ] ); $notices['pro_responsive_migration'] = [ 'type' => 'info', 'text' => $message, 'global' => true, ]; return $notices; } /** * Check if the ad can be displayed based on display limit * * @param bool $can_display Existing value. * @param Ad $ad Ad instance. * @param array $check_options Options to check. * * @return bool true if limit is not reached, false otherwise */ public function can_display_by_display_limit( $can_display, Ad $ad, $check_options ) { if ( ! $can_display ) { return false; } if ( empty( $check_options['passive_cache_busting'] ) && $ad->get_prop( 'once_per_page' ) ) { foreach ( Stats::get()->entities as $item ) { if ( $item['type'] === 'ad' && absint( $item['id'] ) === $ad->get_id() ) { return false; } } } return true; } /** * Get offsets for Content placement. * * @param array $offsets Existing Offsets. * @param array $options Injection options. * @param array $placement_opts Placement options. * @param object $xpath DOMXpath object. * @param array $items Selected items. * @param object $dom DOMDocument object. * @return array $offsets New offsets. */ public function placement_content_offsets( $offsets, $options, $placement_opts, $xpath = null, $items = null, $dom = null ) { if ( ! isset( $options['paragraph_count'] ) ) { return $offsets; } if ( isset( $placement_opts['placement']['type'] ) ) { if ( 'post_content_random' === $placement_opts['placement']['type'] ) { $max = absint( $options['paragraph_count'] - 1 ); // Skip if have only one paragraph since `wp_rand( 0, 0)` generates large number. if ( $max > 0 ) { $rand = wp_rand( 0, $max ); $offsets = [ $rand ]; } } if ( 'post_content_middle' === $placement_opts['placement']['type'] ) { $middle = absint( ( $options['paragraph_count'] - 1 ) / 2 ); $offsets = [ $middle ]; } } // "Content" placement, repeat position. if ( ! empty( $placement_opts['repeat'] ) || ! empty( $options['repeat'] ) && isset( $options['paragraph_id'] ) && isset( $options['paragraph_select_from_bottom'] ) ) { $offsets = []; for ( $i = $options['paragraph_id'] - 1; $i < $options['paragraph_count']; $i++ ) { // Select every X number. if ( ( $i + 1 ) % $options['paragraph_id'] === 0 ) { $offsets[] = $options['paragraph_select_from_bottom'] ? $options['paragraph_count'] - 1 - $i : $i; } } } if ( ! empty( $placement_opts['words_between_repeats'] ) && $xpath && $items && $dom ) { $options['words_between_repeats'] = absint( $placement_opts['words_between_repeats'] ); $offset_shifter = new Advanced_Ads_Pro_Offset_Shifter( $dom, $xpath, $options ); $offsets = $offset_shifter->calc_offsets( $offsets, $items ); } return $offsets; } /** * Add custom code after the ad. * * Note: this won’t work for the Background ad placement. There is a custom solution for that in Advanced_Ads_Pro_Module_Background_Ads:ad_output * * @param string $ad_content Ad content. * @param Ad $ad Ad instance. * @return string $ad_content Ad content. */ public function add_custom_code( $ad_content, Ad $ad ) { $custom_code = $this->get_custom_code($ad); if ( empty( $custom_code ) ) { return $ad_content; } $privacy = Advanced_Ads_Privacy::get_instance(); if ( $privacy->is_ad_output_encoded( $ad_content ) ) { // If the ad_content is already encoded, do not append the custom code in plain text after it. return $privacy->encode_ad( $this->decode_output( trim( $ad_content ) ) . $custom_code, $ad ); } return $ad_content . $custom_code; } /** * Retrieve the original ad content from an encoded script tag * * @param string $output the encoded output. * * @return string */ private function decode_output( $output ) { // Strips the then base64_decode the remaining characters. return base64_decode( substr( $output, strpos( $output, '>' ) + 1, -9 ) ); } /** * If this ad has custom code, encode the output. * * @param string $output The output string. * @param Ad $ad The ad object. * * @return string */ public function encode_ad_custom_code( $output, Ad $ad ) { $privacy = Advanced_Ads_Privacy::get_instance(); if ( // don't encode if AMP. ( function_exists( 'advads_is_amp' ) && advads_is_amp() ) // privacy module is either not enabled, or shows all ads without consent. || ( empty( $privacy->options()['enabled'] ) ) // Ad is already encoded. || ( ! method_exists( $privacy, 'is_ad_output_encoded' ) || $privacy->is_ad_output_encoded( $output ) ) // Consent is overridden, and this is not an AdSense ad, don't encode it. || ( ! $ad->is_type( 'adsense' ) && $ad->get_prop( 'privacy.ignore-consent' ) ) ) { return $output; } // If we have custom code, encode the ad. if ( ! empty( $this->get_custom_code( $ad ) ) ) { $output = $privacy->encode_ad( $output, $ad ); } return $output; } /** * Get the custom code for this ad. * * @param Ad $ad The ad object. * * @return string */ public function get_custom_code( Ad $ad ) { $custom_code = $ad->get_prop( 'custom-code' ) ?? ''; return (string) apply_filters( 'advanced_ads_pro_output_custom_code', $custom_code, $ad ); } /** * Enable placement test emails */ public static function enable_placement_test_emails() { $placement_tests = get_option( 'advads-ads-placement-tests', [] ); if ( ! wp_next_scheduled( 'advanced-ads-placement-tests-emails' ) && count($placement_tests) > 0 ) { // Only schedule if not yet scheduled & tests exists. wp_schedule_event( time(), 'daily', 'advanced-ads-placement-tests-emails' ); } elseif ( wp_next_scheduled( 'advanced-ads-placement-tests-emails' ) && count($placement_tests) <= 0 ) { // deactivate if running and tests empty. self::disable_placement_test_emails(); } } /** * Disable placement test emails */ public static function disable_placement_test_emails() { wp_clear_scheduled_hook( 'advanced-ads-placement-tests-emails' ); } /** * Shortcode to include ad in frontend * * @param array $atts shortcode attributes. * @return string content as generated by the shortcode. */ public function shortcode_display_ad( $atts ) { return $this->do_shortcode( $atts, 'render_ad' ); } /** * Shortcode to include ad from an ad group in frontend * * @param array $atts shortcode attributes. * @return string content as generated by the shortcode. */ public function shortcode_display_ad_group( $atts ) { return $this->do_shortcode( $atts, 'render_group' ); } /** * Shortcode to display content of an ad placement in frontend * * @param array $atts shortcode attributes. * @return string content as generated by the shortcode. */ public function shortcode_display_ad_placement( $atts ) { return $this->do_shortcode( $atts, 'render_placement' ); } /** * Create shortcode output. * * @param array $atts shortcode attributes. * @param string $function_name function to be executed by the shortcode. * * @return string content as generated by the shortcode. */ private function do_shortcode( $atts, $function_name ) { $blog_id = isset( $atts['blog_id'] ) ? absint( $atts['blog_id'] ) : 0; if ( $blog_id && $blog_id !== get_current_blog_id() && is_multisite() ) { // Prevent database error. if ( ! Advanced_Ads_Pro_Utils::blog_exists( $blog_id ) ) { return ''; } if ( is_multisite() ) { switch_to_blog( $blog_id ); } // Use the public available function here. $result = call_user_func( [ wp_advads()->shortcodes, $function_name ], $atts ); if ( is_multisite() ) { restore_current_blog(); } return $result; } // Use the public available function here. return call_user_func( [ wp_advads()->shortcodes, $function_name ], $atts ); } /** * Plugin update. * * @return void */ private function plugin_updates(): void { $pro_options = $this->get_options(); $free_options = Advanced_Ads::get_instance()->options(); if ( isset( $pro_options['responsive-ads'] ) || ! isset( $free_options['responsive-ads'] ) ) { return; } $this->set_option( 'responsive-ads', $free_options['responsive-ads'] ); } }