AdBlock Tracker & Usergroup Swap v2.3.4

• FIX: Incorrect methodname() on UserGroupChange

• Remove unused repository call from previous update
• Add missing repository code
  • Add findOneByUserId() in Repository
  • Add findAllByUserId() in Repository

• NEW: Added the ability to choose a specific remote loading JavaScript URL that matches your current AdServing network
  • Adds a performance improvement by not having to reload an existing asset if its already available (only applies if using Remote Loading Detection)
• UPDATE: Added validation to URL's to ensure they're semantically correct URL's

* forgot to add these update notes to the previous update

• Two new options under "User Displays"
  • Option to allow full history (shows both "Clear" and "AdBlock" history instead of just "AdBlock" history)
  • Option to "hide history" when user is clear and only show the thank you message
• CHANGE: "Maximum device history records to display"
  • When set to 0, it will show 3x or 6x "Always preserve device records"
  • Or, it will obey the maximum set
• ADDED: Two phrases with corrected English:
  • phrase_alert_user_adblock_tracker_removed
  • phrase_alert_user_adblock_tracker_added

• Added two preference checkboxes (see screenshot) (enabled by default)
• Receive Alert when added from AdBlock group
• Receive Alert when removed from AdBlock group
• Two new phrases:
  • wutime_adblock_tracker_removed
  • wutime_adblock_tracker_added

• NEW: Alert users when they're added to the AdBlocking usergroup
• NEW: Alert users when they're removed from the usergroup
  • Both alerts are separate options
  • Both alerts are separate templates to edit
• NEW: Job to rebuild caches for ignored user roles (read below)
• ADDED: Removed AssignRoleId as a possible selection under "Ignore these usergroups"
• ADDED: Remember tab selection on admin options (admin.js wasn't previously included in builds)
• ADDED: Created listener on usergroupchange to check if the user was added to an ignored role, if so, delete AdBlock Detected entity (which in turn removes the AdBlock usergroup and deletes all device and entity data)
• ADDED: Created job to check and remove users from [AdBlock Detected] entity if they're in an ignored role
• Job can only be run from rebuild caches admin tool: admin.php?tools/rebuild#job-wutime\adblocktracker\job\rebuildadblocktrackingusers
  • This shouldn't be required moving forward, but will be useful for webmasters that have been running this add-on for a while (recommend running this after upgrade)
  • Also recommend to be run AFTER making any "Ignore Usergroup" changes in options
  • You can review: admin.php?logs/user-change to see whether there was a large number of users that needed to be removed

• NEW: Added the ability to choose a specifc remote loading JavaScript URL that matches your current adserving network
• NEW: Option to display admin options in TABS
• UPDATE: Options have been re-organized as well as placed in groups
• UPDATE: Better descriptors for detection methods provided

• FIX: username not properly passing display under certain conditions
• FIX: opening history display on public side tries to load buttons that are admin only
• ADD: canView permission for AdBlockHistory permission by extending User
• ADD: CSS in xenforo xf:css template for proper inclusion where needed
• Updated title on admin listing page to remove html from <title>

• FIXED: Moderator/administrative tooltip added for AdBlock History reviewing
• ADDED: Config.php option to enable guest session variable
• ADDED: Config.php option to enable cache busting
• UPDATED: FAQ with help information regarding template modifications

You can add an option to your config.php as follows. I recommend you use a unique variable name in your config. This example uses: isAdBlocking

Update your config.php as shown below.

Please ensure you have guest tracking enabled in the Add-On options or the following will changes will have no effect within templates for guests:

Config.php Update

PHP:

/* AdBlock Tracker and Usergroup Swap */
/* https://xenforo.com/community/resources/adblock-tracker-usergroup-swap.7530/field?field=faq */
$config['adBlockTrackerGuestSession']['enabled'] = true;
$config['adBlockTrackerGuestSession']['config'] = [
    'variable' => 'isAdBlocking', // recommend using something unique here
    'removeOnNonDetect' => true,
    'forceRemoval' => false,
];

You can access the following in your templates once this is set.

Here's an example:

Code:

<xf:if is="$xf.session.isAdBlocking">
    <div style="background-color:#f8d7da;color:#721c24;padding:20px;border-radius:8px;">
        <p>Ad Blocking Detected!</p>
        <p>Pages counted: {{ $xf.session.isAdBlocking }}</p>
    </div>
</xf:if>

By default, your variable (isAdBlocking in this example), will be the count of the number of page views AdBlocked consecutively. If the AdBlocker is disabled the session variable will be unset and cleared.

Note, depending on your caching system you may need to enable forceRemoval. This will delete the sessionId from the database directly. Use at your own risk.

• ADDED: viewAdBlockTrackerHistory permission as a general "General Moderator Permission"
• NOTE: Permission needs to be added to the Moderator group to allow access
• NEW: "View AdBlock Tracker history" now available from member_tooltip