Customized Logs Mod

From TNG_Wiki
Revision as of 15:23, 7 July 2018 by Steve1200 (talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
Customized Logs
Summary Splits search engine bot access to a different log file
Validation
Mod Updated {{{mod_last_update}}}
Download link for
TNG 12.0
TNG 11.1
customized_logs_v11.1.0.4.zip
for
TNG 11.0
customized_logs_v11.0.0.0.zip
for
TNG 10.0
TNG 10.1.0
customized_logs_v10.0.0.8.zip
for
TNG 9.2.2
[1]
for
TNG 9.2.1
customized_logs_v9.2.0.3.zip
for
TNG 9.1.1
customized_logs_v9.1.1.2.zip
for
TNG 9.1
customized_logs_v9.1.0.1.zip
for
TNG 9.0
customized_logs_v9.0.0.0.zip
for
TNG 8.0.2
customized_logs_v8.1.0a.zip
for
TNG 8.0
customized_logs_v8.1.0.zip
for
TNG 7.0
customized_logs_v2.2.zip
Download stats statistics for v11.1.0.4NOT CURRENTLY WORKING

statistics for v9.2.2.6 to v11.0.2.3NOT CURRENTLY WORKING
statistics for v9.2.2.5

statistics for v9.1.1.2 to v9.2.0.3
statistics for earlier versions
Author(s) Brian McFadyen
Ken Roy developed install config file
Previously maintained by Rick Bisbee
Current development by Bryan S. Larson
Homepage Customized Logs Mod (this page)
Customized Logs for history
Mod Support TNG Community Forums
Contact Developer Support for Customized Logs
Latest Mod See download links
Min TNG V 7.1.0
Max TNG V 11.1.0
Files modified
clconfig.php
showlog.php
log.php
botgenlog.txt
botlogxml.php
showbotlog.php
showuserlog.php
userlog.txt
userlogxml.php
extensions/log_botchecks.php
Related Mods
You can change the default log option to include the referrer info, to display the UserAgent string and to enable logging to the userlog.txt file
Notes


Introduction

The Customized Logs mod splits the search engine bots from the normal TNG user access into three separate logs, one for normal access by visitors, one for normal access by users and one for bots. This TNG modification will also change the way site accesses are logged.

  • It will include additional information indicating where the access was linked from (the referrer info) if you change the option
  • It will include additional information containing the User-Agent string of the visiting user in the Visitor log if you change the option
  • It will split the log into three files: one for visiting browsers, one for known users and one for crawlers
  • It will enhance the filter options available through the Admin->Setup->Log Settings. Filtering based upon Host IP Address and logged in User Descriptions will be added to the existing filter on Host Name.
  • It will optionally add a button to Backup / Clear Log file. Clicking on the button makes a backup of the log file then clears all of the entries from the log file.

The mod has an option to show the referrer information in the access log. The default install option is to not show the referrer, which will cause the log to appear the same as the original TNG log. You can change the option to include the referrer using the Mod Manager Edit capability.

The mod has an option to show the user-agent information in the access log. The default install option is to not show the user-agent, which will cause the log to appear the same as the original TNG log. You can change the option to include the user-agent using the Mod Manager Edit capability.

The mod has an option to split the known users from the visiting users in different logs. The default install option is to split the information. You can change the option to include the user-agent using the Mod Manager Edit capability.


Developer

  • The TNG Customized Logs Mod was originally developed by Brian McFadyen.
  • It includes a List of Bots provided by Jerome Liebowitz on the user list.
  • The original Mod Manager configuration file was created by Ken Roy.
  • The Backup/Clear function was originally developed by Jim Graham and incorporated into the Customized Logs mod by Bryan S. Larson.
  • Customized Logs is currently maintained and developed by Bryan S. Larson.


Requirements

  • A working TNG installation.
  • A backup of the TNG log.php and showlog.php files.
  • An installed current version of the Mod Manager.
  • ensure the new logfiles botgenlog.txt and userlog.txt are writeable


Upgrading / Installing Customized Logs Mod V10.0.0.2 and later

First time installation:

  1. Download the appropriate zip file for the Mod Manager configuration file
  2. Extract all the files in customized_logs zip file
  3. Upload customized_logs_v10.0.0.n.cfg and the entire customized_logs folder to your mods folder.
  4. Follow the normal automated installation for Mod Manager, as shown in the example Mod Manager - Installing Config Files to install the customized_logs file.
  5. Click the Check Now button in Mod Manager screen to create the necessary user and bot log.txt files if they do not exist
  6. Optionally, Optional Parameters using the Mod Manager Edit capability

Upgrading from previous versions:

  1. Create backups of botgenlog.txt and userlog.txt (those files are deleted by versions 10.0.0.0 and earlier of this mod)
  2. Installing the mod:
    1. From versions 10.0.0.0 and older
      1. Uninstall the old version of the mod using the mod manager
      2. Unzip and upload the new version of the mod to your mods directory
      3. Follow the normal automated installation for Mod Manager, as shown in the example Mod Manager - Installing Config Files to install the new version of the customized_logs file.
      4. Restore your backed up copies of botgenlog.txt and userlog.txt to your root directory

Automated Installation V10.0.0.0 and earlier

  1. Download the appropriate zip file for the Mod Manager configuration file
  2. Remove Previously Installed mod
  3. Extract all the files in customized_logs zip file to your mods folder.
  4. Follow the normal automated installation for Mod Manager, as shown in the example Mod Manager - Installing Config Files to install the customized_logs file.
  5. Click the "Check Now" button - this will create empty an userlog and botlog if they do not already exist.
  6. Optionally, Optional Parameters using the Mod Manager Edit capability


Optional Parameters

This mod has 5 optional parameters which can be modified using the Mod Manager Edit capability.

  1. Restrict logs to admin only: When enabled, this option restricts all log files to administrators only. This is enabled by default.
  2. Add link to clear/backup log files: When enabled, each log file will have a button to clear/backup that log file. The first time the button is used, a directory is created (genlog_backup) where all backups generated by this button are stored.
  3. Referrer Option: When enabled, this option will show the referrer information in the access log. This is disabled by default.
  4. Include useragent string in the log file: When enabled, this option appends the useragent string to each log entry. This is disabled by default.
  5. Log the user actions in separate user log: This option logs all action by registered users in a separate user log. This option is enabled by default.
  6. Specify a preferred time format for timestamps (i.e. 12 hour or 24 hour short or long).


Revision History

Version Date Contents
V11.1.0.4 6 Feb 2017 This version has been updated to support TNG V11.1.
V11.0.2.3 25 Jan 2017 This version has minor changes to code to add support for TNG/WordPress sites. Thanks goes to Roger Moffat for this change.
V11.0.2.2 6 Sep 2016 This version has been updated to support mod manager changes in TNG V11.0.2 which now uses the $extspath variable for the extensions folder.
V11.0.0.0 14 Mar 2016 This version has been updated to support TNG V11. It also adds BOLD text for usernames in the user log (suggested by Jay Wilpolt) and adds translations for the backup/clear button.
V10.0.0.8 23 Jan 2016 This version adds an option for 4 different time formats for the timestamp on log entries. Thanks to Bernard Wortelboer for the suggestion and some of the code for this feature. This version also corrects an error in the cust_text modifications in some languages.
V10.0.0.7 4 Jan 2016 This version adds support for Italian as well as updated translations for German and Dutch. Thanks goes to Richard Falzini, Oname.gif and Marco van den Heuvel for the translations of text variables.
V10.0.0.6 25 Mar 2015 This version adds code to show the original IP address on sites that use a CDN service (i.e. CloudFlare). Thanks goes to Fred Feldman for the suggestion and the code.
V10.0.0.5 5 Mar 2015 This version fixes several bugs, improves logging of bots, adds new bots to the list of identified bots, cleans up syntax and other code changes as well. NOTE: this version has only been tested with TNG V10.1 and may or may not work with older versions of TNG. Please report any incompatibility issues with older versions so the wiki can be updated appropriately.
V10.0.0.4 24 Feb 2015 This version fixes a syntax error found in V10.0.0.3
V10.0.0.3 20 Feb 2015 This version adds improvements and fixes from previous versions of the mod:
  • The "Check Now" button should now work on more sites. In some cases, the file that ran the checks was converted to a single line of code by FTP processes - this file is now created by the mod rather than moved by the mod.
  • Other minor improvements
  • Cleaned up mod manager instructions for a more clarity
V10.0.0.2 2 Jul 2014 This version adds several improvements from previous versions of the mod:
  • Simplified installation procedure while still protecting existing logs and eliminates the customized_logs_readme.txt file. Now, there is a "Check Now" button that checks to see if the appropriate logs exist and if necessary, create those files
  • Optional button to backup/clear the log files - there are buttons specific to each separate log
  • Option to restrict all logs to admin only
  • Cleaned up edit options screen for a more clean set of options for changing options


Credit goes to Jim Graham for developing the original backup/clear function that was modified for this version.

V10.0.0.1 30 Mar 2014 Updated to prevent user log and bot log from being cleared when reinstalling mod.

Note: follow instructions from customized_logs_readme.txt file before installing or upgrading this version of the mod!
Thanks to Graham Chamberlain for the suggestion used for this version.

V10.0.0.0 6 February 2014 Updated for TNG V10
V9.2.2.6 4 October 2013
  • Minor bugfix
V9.2.2.5 10 August 2013
  • Bugfix, making the V9.2.2.4 version install with the changed log.php file from TNG 9.2.2
V9.2.2.4 27 May 2013
  • Essentially the same as V9.2.0.4 with the correct versioning system applied
V9.2.0.4 26 May 2013
  • Use this version only if you have installed the new log.php file for testing in TGNv9.2.1. Otherwise use the older version 9.2.0.3
    Note that this mod should have been named 9.2.2.4 to avoid any confusion that it applies to log.php released after TNG 9.2.1
  • added the custom known users logfile
  • using the translation files for the frontend files and added the English and Dutch languages
  • using additional filtering on User Agent stings
  • added descriptive page-titles, headers and changed the navigation structure
V9.2.0.3 13 Apr 2013
  • Use this version only if you have installed the new log.php file for testing in TGNv9.2.0. Otherwise use the older version 9.1.1.2.
  • Temporary stop-gap for modified log.php file released for testing about 12 April 2013.
  • changes log_botchecks.php to simplify the bot list.
V9.1.1.2 23 Jan 2013 Updated for TNG V9.1.1
V9.1.0.1 24 Dec 2012 Updated for TNG V9.1.0
V9.0.0.0 2 Feb 2012 Updated for TNG V9
V8.1.0a 16 Oct 2010 Updated for TNG V8.0.2
V8.1.1 30 May 2010 Corrections for TNG V8 and revised .cfg to conform to new standard folder distribution.
V8.1.0 24 May 2010 Updated for TNG8 and new version schema.
V2.2 5 Dec 2009 Updated Mod Manager config file to include List of Bots provided by Jerome Leibowitz and to provide the Edit capability for the logging option.
V2.0 16 May 2009 Original Mod Manager config file
Rev 1.11 27 Apr 2009 validated and updated for V7.1.0
See Customized Logs on Brian McFadyen's site for previous revision history

Sites using this mod

If you download and install this mod, please add your TNG site to the table below

URL User Note Mod-Version TNG-Version User-language
Our Family Histories Bryan S. Larson Current Developer. I added new options and features for V10.0.0.2 through the current version as well as past fixes and tweaks. On my own site, I have also added buttons linking to additional analytics pages that I use. v11.0.2.3 v11.0.2 EN
Brian McFadyen's Genealogy site Brian McFadyen Developer of the customized logs mod V8.1.1
V8.1.3/
8.0.2
TNG 8.1.1 test
EN
Our Roy and Boucher Family Ken Roy I have used Brian McFadyen's customized log since its early days. V10.0.0.2 TNG 10.0.2 English, French
Roni & Jerry's Genealogy and Family History Jerry Liebowitz If a new bot appears that I haven't identified on Brian's mod, I just add it to extensions> log_botchecks.php
(as described in the instructions as provided on the user list)
V9.2.2.6 TNG 9.2.2 EN
Chamberlain & Eidenbenz Geneaolgy Graham Chamberlain Public Site v11.1.0.4 v12.0.1 EN, FR, DE, ES, NL
A Bisbee Family History Rick Bisbee v9.0.0.0 v9.0.4 EN
Chambers Family Ancestry Tom Chambers Very smooth installation & configuration, and helps to catch the bad guys. v9.1.1.2 v9.1.1 EN
Arsenault/Simpson Family Website Bob Arsenault v9.1.1.2 v9.1.2 EN
Gilbert family history Warren S Gilbert v10.0.0.0 TNG 10.0.0 EN
Max Westen's genealogy site Max Westen Developer of some additions of this mod(starting 9.2.0.4) v9.2.2.4 TNG 9.2.1 NL, EN
MOTYER Family Genealogy John Mark Motyer Public site see here see here EN, DE, RU
British 1820 Settlers to South Africa Paul Tanner-Tremaine Public site v10.0.0.6 TNG 10.1.1 EN
Mitchell Families Online Roger Mitchell Another great update - excellent mod! v10.0.0.2 TNG 10.0.2 EN
Total Family History Scott Bennett Private Site (For right now) v10.0.0.1 TNG 10.0.1 EN
Hooley Family Links Rick Hooley Public Site v11.0.2.2 TNG11.0.2 EN
Wortelboer Genealogy Bernard Wortelboer v11.0.2.2 11.0.2 NL/EN
Schmit/Heemskerk Family Rudi Schmit v10.0.0.7 10.1.3 NL
Familie van Seeventer Sandor van Seeventer Public site V11.1.0.4 12.0.1 beta 2 DE/EN/NL
Brady Family Tree in Western Australia Darryl Brady Public site 10.0.0.6 10.1.1 EN, DE
Kemp(e) Family History Andrew Kemp Public site see User:Kempons see User:Kempons EN
Sackett Family Database Ted Smith Public Site v10.0.0.6 TNG10.1.1 EN
Gambrill Family Tree Bobby Gambrill Public site V11.0.2.2 11.0.2 EN
R G Strong Family Genealogy Russell Strong Public Site 11.0.0.0 11.0.0 EN, FR, DE, NL
The Grahams of Helensburgh Jim Graham Public/Private 11.1.0.4 12.0 EN
Roebuck and Families Ancestry Website Donald Roebuck Public site except for Living 11.0.2.2 11.0.2 EN
Crawford County Genealogy Gateway Frank Bernosky Public site except for Living 11.1.0.4 11.1 EN
Rintoul/Bowman Family Andrew Rintoul Public/Private 11.1.0.4 12.0 EN, DE, ES, FR
racine d'Alsace J-L Valory Public-Private - template 1 11.1.0.4 11.1.1 French
Bumbery-Wangler Bob Bumbery Public site 11.1.0.4 11.1.2 English
Family HIstories Steven Davis Public/Private site v11.1.0.4 v12.0.1 English