Display Log Files for Zen Cart v1.5.0 to v1.5.4

Version 1.0.9 by lat9 & design75

Current Support Thread at Zen Cart Forums: http://www.zen-cart.com/showthread.php?204058-Display-Log-Files-Support-Thread

Version History:

• v1.0.0, 2012-12-22, Initial release.
• v1.0.1, 2013-01-05, Changed /YOUR_ADMIN/display_logs.php:
  • BUGFIX: v1.5.0 DIR_FS_LOGS(or any other missing directory) resulted in white-screen-of-death
  • Add usps*.log files; change notify*.log to notifier*.log
• v1.0.2, 2013-03-30, Changed /YOUR_ADMIN/display_logs.php:
  • Added the file-size of the debuglog to the listing
• v1.0.3, 2013-09-12:
  • Added missing constant to /YOUR_ADMIN/includes/languages/english/display_logs.php.
  • Modifications to /YOUR_ADMIN/display_logs.php to account for large files. The notifier_trace.log file, for instance, can grow to be enormous if not flushed periodically.
  • BUGFIX: $dir variable close/unset was in the wrong place (/YOUR_ADMIN/display_logs.php).
  • BUGFIX: Needed to convert htmlentities in the loaded file to ensure that any present don't disrupt the file display.
• v1.0.4, 2013-12-06:
  • BUGFIX: Unprintable characters result in blank display.
  • BUGFIX: Refreshing page after file delete results in error.
• v1.0.5, 2014-01-20:
  • BUGFIX: USPS shipping logs now start with SHIP_usps, not just usps.
• v1.0.6, 2014-02-02:
  • BUGFIX: Delete "all" button doesn't work if the CSS buttons for Admin plugin is also installed.
  • BUGFIX: Instructions aren't displayed if the admin is running in SSL mode.
• v1.0.7, 2014-07-07:
  • ADDED ENHANCEMENT using code from torvista here to display error logs in Admin header area upon the log being generated.
• v1.0.8, 2014-08-12:
  • Slight modification to change introducted in v1.0.7; if debug-logs are present, a count is shown in the admin header with a link to the Display Logs page.
• v1.0.9, 2014-12-20:
  • CHANGE: Use Zen Cart v1.5.4 version of /YOUR_ADMIN/includes/header.php as the base code.

What it does

There have been many times that I've taken a look in one of my Zen Cart's /logs (or /cache for Zen Cart v1.5.0) directories and found some debug log files that I wasn't previously aware of. This plugin allows an admin user to view (and selectively delete) any files with names that match:

• myDEBUG-*.log
• AIM_Debug_*.log
• SIM_Debug_*.log
• FirstData_Debug_*.log
• Linkpoint_Debug_*.log
• Paypal*.log
• paypal*.log
• ipn_*.log
• zcInstall*.log
• notifier*.log
• usps*.log
• SHIP_usps*.log

The plugin searches only in these directories for the matching log-files:

• /cache
• /logs
• /includes/modules/payment/paypal/logs

Once installed (see below), the plugin can be accessed by a signed-in and authorized admin user by selecting Tools->Display Log Files. In addition, starting with v1.0.8, a message is shown in your admin's header if any myDEBUG-*.log files are found in the /logs directory, if defined, or the /cache directory otherwise.

Note: Due to the potentially sensitive nature of the information contained in some of the log files, I suggest that you run your admin in SSL mode if you use this plugin.

Due the the number of files that can accumulate, only the most recent 20 are displayed by default. If you want to display more files at a time, edit the file /YOUR_ADMIN/display_logs.php and change line 23:

  define('MAX_LOG_FILES_TO_VIEW', 20);

In addition, starting with v1.0.3, there's an additional constant (on line 24) that specifies the maximum number of bytes per file to read. Some of the log files can get very large and cause this plugin to generate a debug-log due to an out-of-memory condition!

    if (!defined('MAX_LOG_FILE_READ_SIZE')) define('MAX_LOG_FILE_READ_SIZE', 80000);  /*v1.0.3a*/

The tool allows the logged-in (and authorized) admin user to:

• Sort the log files, either ascendingly or descendingly, by last-modified/creation date.
• Select (via checkbox) and then delete only the log files selected.
• Delete all log files currently being viewed.
• View the contents of an individual log file.

The initial screen for the tool looks similar to:

Installation

There is one core-file overwrite in this plugin; you should always backup your cart’s database and files prior to making any changes. Unzip the plugin's package file, rename the YOUR_ADMIN folder to match your custom admin folder's name. Merge the core file YOUR_ADMIN/includes/header.php and then copy the contents of that admin folder to your store's installation:

1. /YOUR_ADMIN/display_logs.php
2. /YOUR_ADMIN/includes/header.php
3. /YOUR_ADMIN/includes/extra_datafiles/display_logs_filenames.php
4. /YOUR_ADMIN/includes/languages/english/display_logs.php
5. /YOUR_ADMIN/includes/languages/english/extra_definitions/display_logs_name.php
6. /YOUR_ADMIN/includes/languages/english/images/buttons/button_delete_all.gif
7. /YOUR_ADMIN/includes/languages/english/images/buttons/button_delete_selected.gif

Uninstall

First, delete the files that were copied to your zen-cart installation's admin directories. Restore your backup up of then use your admin's Tools->Run SQL Patches to run the file display_logs_uninstall.sql.