Prolog Mod

From TNG_Wiki
Jump to navigation Jump to search

Caution!! If this mod is installed or configured incorrectly it could make your site appear to crash. Don't panic. Edit your subroot.php and remove the last line pertaining to Prolog. Then in mod manager "Clean" the partially installed Prolog to remove the mod. See Below for detail

Restricted Downloads of Prolog Mod are restricted to logged in users. If you do not have a user account on the TNG Wiki use the Request Account link to request a user account Restricted
Caution If you have trouble downloading with Google Chrome, Vivaldi, Brave or other Chromium based browser, try using a right-click and select Open in new Window, then F5, or use another browser such as Firefox


Caution


Prolog Mod
Summary Adds PHP Rotating Logs to TNG site
Validation
Mod Updated 3 Mar 2020
Download link
Download stats view statistics
Author(s) Rick Bisbee
Homepage Bisbee Family Connection
Mod Support Support for Prolog_Mod
Contact Developer As above
Latest Mod 12.2.0.4
Min TNG V 12.2
Max TNG V 12.2+
Files modified
Related Mods
Notes



Prolog (PHP Rotating Log) Introduction

Prolog6.png

Prolog is a utility for TNG testers, mod developers and anyone who wants to monitor their websites for PHP or user issues. It is an extension of the Show PHP Errors mod created by Roger Mitchell (decd) and provides three selectable levels of error logging: 1) just errors; 2) all errors, warnings and deprecations except for notices (default); or 3) all errors, warnings, notices, and deprecated functions.

An important feature is that fatal errors displayed to the screen are generic and never reveal server information that a hacker may be looking for.

Prolog puts its daily PHP log files in a location provided by the user in the mod's Edit Options page. If the user has a PHP log file defined in php.ini, Prolog will override it. However, if the user sets the log file path in Prolog the same as in the php.ini, all logs will go to the same folder. Note that the log specified in php.ini will be a single file containing many days worth of errors and can grow very large.

For TNG scripts, Prolog modifies subroot.php to add logging to any page that includes it. Scripts that work independently of TNG will not be logged by this mod; however, those errors will be logged in the file set in php.ini.

That said, if you do want to Prolog independent scripts, you can include prolog_conf.php at the top of a primary (as opposed to an included) script and as long as the mod remains installed, errors will be logged to the same rotating logs, at the same level as the others.

if(file_exists('prolog_conf.php'))
   require_once 'prolog_conf.php';


Prolog has two main files:

  1. prolog_conf.php creates the log files and directs the logging
  2. prolog.php displays and manages rotating logs from the Admin screen.

Features

Prolog adds a log access page link in the TNG Admin management area and features the following:

  • Rotating error logs created daily to prevent them becoming too large to manage;
  • Daily logs and error entries are timestamped in GMT;
  • A GMT clock is provided for admin perspective on timestamps;
  • Mod Edit Option to select error level for logging;
  • Mod Edit Option to set number of daily logs to keep before auto-deleting the oldest;
  • Daily logs selectable from drop down list for viewing and/or deletion (see visualization);
  • Other .log files can be viewed and manipulated;
  • Logged items are listed from most recent to oldest for admin convenience;
  • Filter that limits viewing of logged errors to only items of interest;
  • Language support included in mod folder for easier maintenance;
  • A fatal shutdown handler.

Shutdown Handler

The shutdown handler is for errors that might not otherwise be logged because the system shuts down before processing them. Some, but not all servers are able to log fatal errors before shutting down, so there may be double entries in the logs -- but there will always be at least one if it occurs.

Fatal errors are very useful for revealing deliberate attacks that often result in displaying server information that attackers hope to exploit. While Prolog records them for the administrator, all the attacker sees is this, for example, after attempting to access a forbidden script:

[20-02-24 18:34:02] Something went wrong. Please report the error or come back later.

The exact time can be used to compare with the logs, should a legitimate user choose to report it. Compare the actual log entry for displayed message above:

[24-Feb-2020 18:34:02 GMT] Fatal error: File access violation in fgw/fgw_setup.php on line 26 

This was probably a hack attempt. In this case the error was generated by the author of fgw_setup.php, not PHP itself.

// ONLY ADMINISTRATOR GETS ACCESS TO THE SETUP PAGE
if( empty( $superuser ) ) {
	trigger_error( $admtext['wse_access'], E_USER_ERROR );
   die();
}

Language Support

The mod support folder includes support for Czech, English, French, German, Spanish and Swedish. You can modify the files right in the support folder to change the translations. You can add new folders with other languages if you like. If you make changes or additions I will be happy to add them to the distribution package for others to use as well. Just email them to me or use the mod support link on the Prolog_Mod TNGWiki page.

Version 4 (v12.2.0.4) Enhancements

Prolog version 4 will open any .log file in the Prolog directory set in the mod's Edit Options page. Therefore it will handle php.ini and WAMPS server logs if you set it up to do so. Here's how to do it in a directory above the public_html (www) on a Windows WAMP Server at

D:/wampsdir/mylogs/

In your php.ini set the logfile:

error_log = D:/wampsdir/mylogs/php_error.php

In Prolog's Mod Edit options page set the path to

D:/wampsdir/mylogs/

In your WAMPS httpd.conf file set up a VirtualHost something like this.

<VirtualHost *:80>
	ErrorDocument 404 /errdocs/_err404.php
	ErrorDocument 403 /errdocs/_err403.php
	ErrorLog D:/wampsdir/logs/server_error.log
</VirtualHost>

Now all log files will go to the mylogs directory, will be listed in Prolog's dropdown menu and can be vieweds and managed by Prolog.

TNG Version Compatibility

Prolog is compatible with TNG version 12 and up.

Mod Revision History

Version Date Updates
v12.2.0.4 3 Mar 2020
  • Fixes wrong support package bug
  • Adds viewing and manipulation of all logs (PHP and system) in Prolog directory
v12.2.0.3 1 Mar 2020
  • Adds link to TNGWiki article
  • Minor Update to language files
v12.2.0.2 24 Feb 2020
  • Initial release

Screen Shots

Prolog3.jpg

PHP Prolog link in the Admin page header menu. Note the daily log selected from the drop down list, and that the site's PHP version and current error reporting level are displayed in the prolog header bar. In the above example, All errors, notices, warnings and deprecations are being logged. A developer would want to show all errors and correct those thrown by their own mods or scripts, which can be isolated from any others by using the filter.

The filter searches each logged entry for a matching sub-string and displays the whole line if found. You could filter on a file name to display errors coming from just that script, or on 'Warning' to only see warnings, or 'Undefined: index' to only display those kinds of notices. After entering the filter string you can hit enter or click on the circular arrows to activate it.

Prolog4.jpg

Installation

Prolog installs as a normal TNG mod. Download and unzip the contents -- one file and one folder. Place the prolog.cfg file and the support folder into your TNG site's mods directory. Do not remove folders and files from the support folder -- just leave them there. Navigate to your Mod Manager, find and open the mod listing and click on Install.

Configuration

Location for Daily Error Logs

This is very important. As soon as you've installed the mod, open it in the mod manager and click on Edit Options. There you must enter the server path to an existing directory for your daily logs. For best results, always use an absolute server path.

D:/wamps/mylogs/
OR
/home2/mysite/mylogs/

Be sure to terminate the path with a forward slash and do not surround it with quotes of any kind. Your server path can lead to a location above the public_html directory for extra security if you like (recommended.) If you fail to specify a log file path, or if the path does not exist, Prolog will show a message explaining the problem when the PHP Prolog link is clicked at the top of the TNG Admin page.

Setting the Error Level

  • Error level 1 will only log actual, usually fatal errors.
  • Error level 2, the default, should be about right for a live site. It will log errors, warnings and PHP function deprecations. That latter means the scripts will stop working with new PHP upgrades, so we should know about them.
  • Error level 3 logs everything -- errors, notices, warnings and deprecations. Because TNG emotes large numbers of notices right now, error level 3 should only be used while actually testing a script and reduced back to 1 or 2 when not testing. Even a daily log can get very large at error level 3.

Warning

If installed incorrectly this mod can cause the site to appear to crash. Don't panic. Edit subroot.php and remove the last line pertaining to Prolog. The site will come good again. Then go to mod manager and Clean up the partially installed Prolog mod. Prolog modifies subroot.php by including prolog_conf.php with parameters that are set in the mod's Edit Options. If incorrectly set or if the mod is partially installed for some reason, subroot.php may fail and so will all pages that include it.

There was a bug in Mod Manager up to TNGv12.3 beta which was corrected during testing. If a parameter expects a numeric value and you update it with and empty field, it renders a parameter variable such as $mycount as

 $mycount = ;

and will cause the script containing the parameter to fail. After the fix to mod manager it will render it as

$mycound = 0;

which fixes the problem.

Sites using this mod

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

URL User Note Mod-Version TNG-Version User-language
A Bisbee Family History Rick Bisbee Mod Developer. A must-have for mod developers 12.2.0.4 12.1 English
Our Roy and Boucher Family Ken Roy Using with Show PHP Error Log on test site 12.2.0.3 12.2.0/12.3.0 beta EN, FR
Roots & Relatives Remembered Ron Krzmarzick Public & Private See Here See Here EN,DE,CS,ES