Click Counter II Email Notify

Click Counter II Email Notify
Summary	Adds an email notification message to the Mod Developer tracking mod downloads
Validation	N/A
Mod Updated	31 May 2019
Download link	For TNG 12.0 click_counter_email_notify_v12.0.0.0.zip TNG 9.0 TNG 10.0 TNG 11.1 click_counter_email_notify_v9.0.0.3a.zip
Download stats	V12.0.0.1 download statistics Other version download statistics
Author(s)	Jeff Robison and Ken Roy
Homepage	Click Counter II Email Notify (This page)
Mod Support	TNG Community Forums
Contact Developer	TNG Community Forums
Latest Mod	v12.0.0.1
Min TNG V	v9.0
Max TNG V	v12+
Files modified	ccount/click.php ccount/index.php
Related Mods	None
Notes	This mod requires that you have Bart Degryse's Click Counter II installed

Purpose of the Mod

This mod extends the capability of Bart 'Roebie' Degryse's Click Counter II to

• Notify the Mod Developer/co-Mod Developer via email that their mod was downloaded.

• Notify the Mod Developer/co-Mod Developer via email that an Anonymous user requested a mod download, if the downloads are restricted to logged in users

• Provide TNG Wiki username if mod was downloaded by a logged in user.

• Provide the TNG Wiki URL for the mod article.

Mod Developer

Original mod by Jeff Robison

MediaWiki user and article link added by Ken Roy

A huge THANKS to multiple version tester Graham Chamberlain.

V12.0.0.1 updated by Brent Hemphill for sites that require login and use SMTP

and by Ken Roy to fix 404 error if site is in TNG Maintenance Mode

Deny Downloads

The mod can also restrict downloads to logged on users only. If user is not logged in, they will get the following message when they click the download link

You must be logged in to TNG Wiki to download this mod! If you do not have a user ID, use the Request Account or Register links to get a TNG Wiki username!

Restricted mod download notification is also implemented using the TNG Wiki Restricted template

Pre Install Changes

If the Mod Manager returns a Cannot Install status, you may need to update the cfg file.

For example, if you installed the Click Counter II in a ccount folder that is at the same level as your TNG install folder, the Mod Manager will not find the target files. If that is the case, you must edit the cfg file for it to install and work correctly on your site:

• in the %description: directive for the mod change '/ccount/update_ccountdb_links.php' to '../ccount/update_ccountdb_links.php'
• change %target:/ccount/click.php% to %target:../ccount/click.php%
• change include('../tng_begin.php'); to include('../tng/tng_begin.php');

where tng is your TNG folder name

• change %target:/ccount/index.php% to %target:../ccount/index.php%

Installation

1. Download the appropriate mod for your TNG version from the download links in the summary area in the upper right.
2. Extract the appropriate zip file to your TNG mods folder.
3. Update the mod cfg file as documented in the Pre Install Changes, if your install TNG in a folder instead of the web site root
4. FTP or upload the mod to your TNG mods folder
5. Install the mod using the Mod Manager
6. Follow Post Install Actions, Edit the Options and update wiki mod articles

Post Install Actions

After installing the mod, you must

• click the 'Update Links Table' button in Mod Manager
• edit the options in Mod Manager
• update your mod articles on the TNG Wiki, if you chose to deny downloads to anonymous users

Edit Options

After you install the mod, you need to Edit Options to

• specify your email address
• set the option for restrict download access
  • false to allow anonymous user downloads
  • true to deny the mod download to anonymous users
• Include geo information in notification

Update Mod Wiki Articles

If you chose to deny mod downloads to anonymous users, you need to update your TNG mod wiki articles

• to add the Restricted Template as the first line in the article

{{restricted}}

to let users know they need to login or get a user ID on the wiki and then login to download mods.

• to update the URL links to pass the logged on user and the wiki page name without blanks by adding &user={{#replace:{{CURRENTLOGGEDUSER}}}}&page={{PAGENAMEE}} to your site click URL so that it looks like the following

[https://www.royandboucher.com/ccount/click.php?id=364&user={{#replace:{{CURRENTLOGGEDUSER}}}}&page={{PAGENAMEE}} mobile_site_v11.0.0.1.zip]

Add CC Recipients To Email Notification

If there is a co-author for a mod you can send them a copy of the email notification.

• Open the Click Counter II Admin Panel

Click the 'Edit' icon for any link you want to add a CC address to.

3 new fields have been added. 'Ignore user restriction', 'CC address' and 'CC name'.

• In the visualization above 'Ignore user restriction' is set to 1.

This will allow access to this link no matter the user restriction setting.

Leave the field blank to enforce the user restriction setting.

• In the visualization above the 'CC address' field has 2 email addresses separated with a ', '.

A download notification will be sent to the 2 addresses.

• In the visualization above the 'CC name' field is optional.

Mainly for easily identifying the email address(s).

Revision History

Version	Date	Contents
v12.0.0.1	31 May 2019	updated by Brent Hemphill to work on sites that require login and use SMTP mail updated by Ken Roy to use new cust_text.php guidelines and fix 404 error if site is in TNG Maintenance Mode
v9.0.0.3a	28 May 2017	Colons in custom text was causing problems. Removed. Added an edit option after install to choose whether or not to include geo info in the notification.
v9.0.0.3	19 March 2017	Updated to add options to the Click Counter database to: Ignore user restriction to override download restriction for any mod by setting field to 1 CC address to specify the email address of the user to carbon copy on the download email
v9.0.0.2a	11 March 2017	Added the ability to override download restriction for any mod.
v9.0.0.2	5 March 2017	Added country, region and city break down of IP address Added the ability to send a notification to a mod co-author (cc) Fixed French messages and subject line when accented characters are used
v9.0.0.1	2 March 2017	Moved deny emails so that cookie is not set and updated $text variables content
v9.0.0.0	1 March 2017	Updated messages to use TNG $text language capability
v6.0.0.2	26 February 2017	Added Restrict capability to prevent mod downloads by anonymous users
v6.0.0.1	8 Feb 2017	Expanded email content
v6.0.0.0	5 Feb 2017	Initial beta test of email notification

Visualization

If you chose to deny downloads to anonymous users, you will get an email notification similar to the following.

You will get an email similar to the following when logged-in user downloads your mod.

Sites Using This mod

Please add your site to the table if you use this modification.

URL	User	Note	Mod-Version	TNG-Version	User-language
A Bisbee Family History	Rick Bisbee	A must-have for mod developers	9.0.0.3	11.0.2	English
Robison and Blythe Genealogy	Jeff Robison	Mod developer along with Ken Roy	9.0.0.3	11.1	English
Our Roy and Boucher Families	Ken Roy	Worked with Jeff to restrict the downloads to TNG Wiki logged-in users.	12.0.0.1	12.1	English, French
Chamberlain & Eidenbenz Genealogy	Graham Chamberlain	beta tester	12.0.0.0	12.0.1	EN, FR, DE, ES, NL
Andersson-Hoppe-Sahlin-Thorell	Erik Hoppe		9.0.0.3	10.1.3	SV,EN, DE
Not a public site	Brett	Modified email format	12.0.0.1	TNG 12.3	EN