switch to keep logs instead of removing permanently

Author: caseycs

.gitignore

@@ -1 +1,2 @@
 php_error.log
+.idea

example-53.php

@@ -2,8 +2,9 @@
 error_reporting(-1);
 ini_set('display_errors', true);
 
-$log = __DIR__ . '/php_error.log';
+$log = '/tmp/php_error.log';
 $logTemporaryDir = '/tmp/php_error';
+$keepLogsDir = '/tmp/php_error_keep';
 
 //callback function
 $sendErrors = function(array $errors) {
@@ -13,5 +14,5 @@
 
 //run
 require 'lib-53.php';
-$a = new PhpLogParser53($log, $logTemporaryDir, $sendErrors, 1);
+$a = new PhpLogParser53($log, $logTemporaryDir, $sendErrors, 1, $keepLogsDir);
 $a->start();

example-mysql-53.php

@@ -5,6 +5,8 @@
 //get env
 $log = getenv('LOG') ?: '/tmp/php_error.log';
 $logTemporaryDir = getenv('LOG_TEMPORARY_DIR') ?: '/tmp/php_error';
+$keepLogDir = getenv('KEEP_LOG_DIR') ?: '/tmp/php_error_keep';
+
 $host = getenv('MYSQL_HOST') ?: 'localhost';
 $port = getenv('MYSQL_PORT') ?: 3306;
 $user = getenv('MYSQL_USER') ?: 'root';
@@ -55,5 +57,5 @@
 
 //run
 require 'lib-53.php';
-$a = new PhpLogParser53($log, $logTemporaryDir, $sendErrors, 1);
+$a = new PhpLogParser53($log, $logTemporaryDir, $sendErrors, 1, $keepLogDir);
 $a->start();

generateErrors.php

@@ -1,7 +1,7 @@
 <?php
 error_reporting(-1);
 ini_set('display_errors', true);
-ini_set('error_log', __DIR__ . '/php_error.log');
+ini_set('error_log', '/tmp/php_error.log');
 if (function_exists('xdebug_disable')) {
     xdebug_disable();
 }
@@ -12,6 +12,5 @@
 }
 
 //generate errors
-for ($i = 0; $i < 2; $i ++) {
-    echo $a;
-}
+echo $a;
+throw new Exception;

lib-53.php

@@ -5,45 +5,33 @@ public function __construct(
         $logPath, 
         $temporaryDir,
         \Closure $deliverErrorsCallback,
-        $pollDelay = 1
+        $pollDelay = 1,
+        $keepLogDir = null
     ) {
         $this->logPath = $logPath;
         $this->temporaryDir = $temporaryDir;
         $this->pollDelay = $pollDelay * 1000000; //to milliseconds
         $this->deliverErrorsCallback = $deliverErrorsCallback;
+        $this->keepLogDir = $keepLogDir;
     }
 
     public function start() {
-        $this->checkTemporaryDir();
         $this->processOldLogFiles();
         $this->loopOnNewFile();
     }
 
-    protected function checkTemporaryDir()
-    {
-        if (is_dir($this->temporaryDir)) {
-            if (!is_readable($this->temporaryDir)) {
-                throw new \Exception('temporary dir does not exists or not readable:' . $this->temporaryDir);
-            }
-        } elseif (!mkdir($this->temporaryDir)) {
-            throw new \Exception('failed to create temporary dir:' . $this->temporaryDir);
-        }
-    }
-
     protected function processOldLogFiles()
     {
         self::log('process old log files');
+        $this->prepareDir($this->temporaryDir);
         $it = new FilesystemIterator($this->temporaryDir);
         foreach ($it as $fileinfo) {
-            $result = $fileinfo->getPathname();
-            if (!is_file($result) || !is_readable($result)) {
-                throw new \Exception('file does not exists or is not readable:' . $result);
-            }
+            $filepath = $fileinfo->getPathname();
 
-            $content = $this->readFile($result);
+            $content = $this->readFile($filepath);
             $errors = $this->parseLog($content);
             $this->sendErrors($errors);
-            $this->unlink($result);
+            $this->unlinkProcessedLog($filepath);
         }
     }
 
@@ -57,19 +45,17 @@ protected function loopOnNewFile()
                 }
 
                 if (filesize($this->logPath)) {
-                    $newPath = $this->temporaryDir . '/' . time() . '_' . uniqid();
-                    if (rename($this->logPath, $newPath)) {
-                        self::log("rename success: {$this->logPath} -> {$newPath}");
-                } else { 
-                        throw new \Exception("rename failed: {$this->logPath} -> {$newPath}");
-                    }
+                    $newName = date('Y-m-d_H-i-s') . '_' . microtime(true);
+                    $newPath = $this->temporaryDir . '/' . $newName;
+
+                    $this->rename($this->logPath, $this->temporaryDir, $newName);
 
                     $content = $this->readFile($newPath);
                     $errors = $this->parseLog($content);
                     unset($content);
                     $this->sendErrors($errors);
                     unset($errors);
-                    $this->unlink($newPath);
+                    $this->unlinkProcessedLog($newName);
 
                     self::log('memory usage ' . (memory_get_usage(true)/1024) . 'K');
                 }
@@ -78,22 +64,53 @@ protected function loopOnNewFile()
         }
     }
 
+    protected function prepareDir($dir)
+    {
+        if (is_dir($dir)) {
+            if (!is_readable($dir)) {
+                throw new \Exception('Directory does not exists or not readable:' . $dir);
+            }
+        } elseif (!mkdir($dir)) {
+            throw new \Exception('failed to create directory:' . $dir);
+        }
+    }
+
     protected function readFile($filename)
     {
         if (!is_file($filename) || !is_readable($filename)) {
             throw new \Exception('file does not exists or is not readable:' . $filename);
         }
         self::log('read file ' . $filename);
         $result = file_get_contents($filename);
+        if (false === $result) {
+            throw new \Exception('file_get_contents failed:' . $filename);
+        }
         return $result;
     }
 
-    protected function unlink($filename)
+    protected function unlinkProcessedLog($filename)
+    {
+        if ($this->keepLogDir) {
+            $this->prepareDir($this->keepLogDir);
+            $this->rename($this->temporaryDir . '/' . $filename, $this->keepLogDir, $filename);
+        } else {
+            if (unlink($this->temporaryDir . '/' . $filename)) {
+                self::log('file deleted successfully: ' . $filename);
+            } else {
+                throw new \Exception('remove error log file failed: ' . $filename);
+            }
+        }
+    }
+
+    protected function rename($pathFrom, $dirTo, $nameTo)
     {
-        if (unlink($filename)) {
-            self::log('file deleted successfully: ' . $filename);
+        $this->prepareDir($dirTo);
+        $to = $dirTo . '/' . $nameTo;
+
+        if (rename($pathFrom, $to)) {
+            self::log("rename success: {$pathFrom} -> {$to}");
         } else {
-            throw new \Exception('remove error log file failed: ' . $filename);
+            throw new \Exception("rename failed: {$pathFrom} -> {$to}");
         }
     }
 
@@ -124,7 +141,6 @@ protected function sendErrors(array $errors)
 
     public static function log($message)
     {
-        echo date('[Y-m-d H:i:s] ') . $message . PHP_EOL;
+        echo date('[Y-m-d H:i:s]') . ' ' . $message . PHP_EOL;
     }
-
 }