<?php
/**
   c_log.php: Standardized logging of processes for your php web scripts.  
   
   How It Works:
      1) Add this line to your web script - make sure to get the directory location correct
            include 'common/clog.php';           // Standard cazh1 output logging
      2) Before you start logging stuff, initialize the routines by calling
            clog_Start("logs\LogFileName");      // Initialize cazh1 output logging                   

   Notes:
   * Be careful about naming conflicts in the calling routine ...
      - All variables herein are predicated with $CL_ 
      - All functions herein are predicated with clog_
         
   Version History:
      0.10 - 11/2005 jpm        Hello, World
             Log Format:        datetime taskET loginfo        
         
   Feature Requests:
   * Add y/n flag to restart log file - maybe some indicator of log file size?
   * Add Batch ID and Batch Elapsed Time to all lines - can / should batches nest? show nest level
      - this will cover total ET for the whole thing
   * Add Task ID to all lines
   * Routines currently keep the outfile open until done - maybe add switch to open / shut file 
     between line items or maybe close, reopen between batches?
      - alternative might be to name the outfile with the session ID, in case of multi user / web
   * fopen assumes folder currently exists - should check if full path exists, create if req'd
      - maybe you should hold the file open the whole time, get away from the open/close every time?
   * should figure out if I am on win, ux, or mac and set line delimiter appropriately / automatically
   * code mover should push these types of files around as well
   * Add an error code for returned error(s) from shell process

   ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----   
   Copyright (c) 2005 James P. MacLennan   All Rights Reserved
   Questions? Comments? Suggestions? Let me know ... www.cazh1.com
   
   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2 of the License, or
   (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.
   ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----   
*/
/******* Other required routines ********************************************************************************/
include 'get_elapsed_time.php';   // ET calcs, thanks to http://www.befriend.com
  
/*************************************************************************************************/
function clog_Start($CL_LogFileNameIn) { // Initialize the log file, some key formats and session values   

   global $CL_DateTimeFormat;
   global $CL_FieldDelimiter;
   global $CL_LogFileName;
   global $CL_EOL;
   global $CL_LogVersion;
   
   $CL_LogFileName = $CL_LogFileNameIn . ".log"; // Calling application specifies the log file name, location
   $CL_DateTimeFormat = "Y-m-d H:i:s";           // ex. 2000-06-14 06:30:00      MySQL DATETIME format
                                                 // date / time stamp should be able to 
                                                 // pull directly into database as datetime
   $CL_FieldDelimiter = ", ";                    // field delimiter, in between "fields" of the log file
   $CL_EOL = "\r\n";                             // End Of Line, CRLF for Windows systems
//   $CL_EOL = "\n";                             // End Of Line, LF for Unix systems
//   $CL_EOL = "\r";                             // End Of Line, CR for Mac systems
    
   // Initialize all of your timers
   $CL_StartTime = getdate();                 

   // Log entry for the start: see version history above
   $CL_LogVersion = "c_log.php ver 0.10 -- Copyright (c) 2005-2006 James P. MacLennan -- All Rights Reserved -- www.cazh1.com";  
   clog_Print ("c_Log Start " . $CL_LogVersion, "No Echo");
}

// Add a line to the log
function clog_Print($CL_loginfo, $CL_EchoFlag) {

   global $CL_DateTimeFormat;
   global $CL_FieldDelimiter;
   global $CL_LogFileName;
   global $CL_CheckLastItemTime;
   global $CL_CheckThisItemTime;
   global $CL_EOL;
   
   // date / time
   $CL_Line_DateTime = trim(date($CL_DateTimeFormat));
   $CL_CheckThisItemTime = $CL_Line_DateTime;
   if ($CL_CheckLastItemTime == "") {  
      $CL_CheckLastItemTime = $CL_Line_DateTime;
   }
   // batch id
   // task id
   // batch ET (since start)
   // task ET (since last line)
   $CL_TaskET = get_elapsed_time($CL_CheckLastItemTime, $CL_CheckThisItemTime, 'seconds', 2);
  //$CL_TaskET = $CL_CheckLastItemTime - $CL_CheckThisItemTime;
  // } else {
   //   $CL_TaskET = 0;
   //}
   $CL_CheckLastItemTime = $CL_CheckThisItemTime;
   // loginfo
   $CL_Line_LogInfo = $CL_loginfo; 
   
   // Finally .. just o/p the durn thing
   $CL_OutFile = fopen($CL_LogFileName, "a");
   $CL_OutLine = $CL_Line_DateTime . $CL_FieldDelimiter . $CL_TaskET . $CL_FieldDelimiter . "\"" . trim($CL_Line_LogInfo, "\"") . "\"" . $CL_EOL;
   fwrite($CL_OutFile, $CL_OutLine);
   fclose($CL_OutFile);
   if (strtolower($CL_EchoFlag) == "echo") {
      print str_replace(" ", "&nbsp;", $CL_Line_LogInfo) . "<br />";
      flush();
   }   
}
  
// Close the log 
function clog_Stop() {

   global $CL_LogVersion;

   clog_Print ("c_Log Stop  " . $CL_LogVersion, "No Echo");
   clog_Print ("---------- ---------- ---------- ---------- ---------- ---------- ---------- ", "No Echo");
}
?>