Merge pull request #263 from opcodesio/bug/handle-inaccessible-files

handle inaccessible files

Author: arukompas

src/Concerns/LogReader/KeepsFileHandle.php

@@ -41,7 +41,11 @@ protected function openFile(): static
             return $this;
         }
 
-        $this->fileHandle = fopen($this->file->path, 'r');
+        try {
+            $this->fileHandle = fopen($this->file->path, 'r');
+        } catch (\ErrorException $exception) {
+            throw new CannotOpenFileException('Could not open "'.$this->file->path.'" for reading.', 0, $exception);
+        }
 
         if ($this->fileHandle === false) {
             throw new CannotOpenFileException('Could not open "'.$this->file->path.'" for reading.');

src/LogFile.php

@@ -4,6 +4,7 @@
 
 use Illuminate\Support\Arr;
 use Opcodes\LogViewer\Events\LogFileDeleted;
+use Opcodes\LogViewer\Exceptions\CannotOpenFileException;
 use Opcodes\LogViewer\Exceptions\InvalidRegularExpression;
 use Opcodes\LogViewer\Facades\LogViewer;
 use Opcodes\LogViewer\Logs\LogType;
@@ -118,7 +119,12 @@ public function getFirstLine(): string
 
     public function getNthLine(int $lineNumber): string
     {
-        $handle = fopen($this->path, 'r');
+        try {
+            $handle = fopen($this->path, 'r');
+        } catch (\ErrorException $e) {
+            throw new CannotOpenFileException('Could not open "'.$this->path.'" for reading.', 0, $e);
+        }
+
         $line = '';
         for ($i = 0; $i < $lineNumber; $i++) {
             $line = fgets($handle);

src/LogTypeRegistrar.php

@@ -2,6 +2,7 @@
 
 namespace Opcodes\LogViewer;
 
+use Opcodes\LogViewer\Exceptions\CannotOpenFileException;
 use Opcodes\LogViewer\Exceptions\SkipLineException;
 use Opcodes\LogViewer\Logs\HorizonLog;
 use Opcodes\LogViewer\Logs\HorizonOldLog;
@@ -58,7 +59,11 @@ public function guessTypeFromFirstLine(LogFile|string $textOrFile): ?string
     {
         if ($textOrFile instanceof LogFile) {
             $file = $textOrFile;
-            $textOrFile = $textOrFile->getFirstLine();
+            try {
+                $textOrFile = $textOrFile->getFirstLine();
+            } catch (CannotOpenFileException $exception) {
+                return null;
+            }
         }
 
         foreach ($this->logTypes as [$type, $class]) {
@@ -74,6 +79,8 @@ public function guessTypeFromFirstLine(LogFile|string $textOrFile): ?string
                             if ($class::matches($file->getNthLine($lineNumber))) {
                                 return $type;
                             }
+                        } catch (CannotOpenFileException $exception) {
+                            return null;
                         } catch (SkipLineException $exception) {
                             continue;
                         }

src/Readers/MultipleLogReader.php

@@ -5,6 +5,7 @@
 use Illuminate\Pagination\LengthAwarePaginator;
 use Illuminate\Pagination\Paginator;
 use Opcodes\LogViewer\Direction;
+use Opcodes\LogViewer\Exceptions\CannotOpenFileException;
 use Opcodes\LogViewer\Facades\LogViewer;
 use Opcodes\LogViewer\LevelCount;
 use Opcodes\LogViewer\LogFile;
@@ -218,7 +219,11 @@ public function scan(int $maxBytesToScan = null, bool $force = false): void
 
             $fileSizeScanned += $logQuery->numberOfNewBytes();
 
-            $logQuery->scan($maxBytesToScan, $force);
+            try {
+                $logQuery->scan($maxBytesToScan, $force);
+            } catch (CannotOpenFileException $exception) {
+                continue;
+            }
 
             if (isset($maxBytesToScan) && $fileSizeScanned >= $maxBytesToScan) {
                 break;

tests/Pest.php

@@ -11,6 +11,10 @@
 uses(TestCase::class)->in(__DIR__);
 uses()->afterEach(fn () => clearGeneratedLogFiles())->in('Feature', 'Unit');
 uses()->beforeEach(fn () => Artisan::call('log-viewer:publish'))->in('Feature');
+uses()->beforeEach(function () {
+    // let's not include any of the default mac logs or similar
+    config(['log-viewer.include_files' => ['*.log', '**/*.log']]);
+})->in('Unit', 'Feature');
 
 /*
 |--------------------------------------------------------------------------

tests/Unit/CustomLogs/ExtendableLogReaderTest.php

@@ -54,6 +54,18 @@
     ],
 ]);
 
+it('handles unaccessible files', function () {
+    if (PHP_OS_FAMILY === 'Windows') {
+        $this->markTestSkipped('File permissions work differently on Windows. The feature tested might still work.');
+    }
+
+    $file = generateLogFile(randomContent: true);
+    chmod($file->path, 0333); // prevent reading
+
+    expect($this->logRegistrar->guessTypeFromFirstLine($file))
+        ->toBeNull();
+});
+
 it('prefers user-defined log types over default ones', function () {
     // first, the default http access log
     $defaultAccessLogLine = '8.68.121.11 - UID 123 - [01/Feb/2023:01:53:51 +0000] "POST /main/tag/category HTTP/2.0" 404 4819 "-" "-"';

tests/Unit/LogReaderTest.php

@@ -1,6 +1,7 @@
 <?php
 
 use Illuminate\Support\Facades\File;
+use Opcodes\LogViewer\Exceptions\CannotOpenFileException;
 use Opcodes\LogViewer\Readers\IndexedLogReader;
 
 beforeEach(function () {
@@ -40,3 +41,14 @@
         ->and($index->count())->toBe(2)
         ->and($index->getFlatIndex())->toHaveCount(2);
 });
+
+it('throws an exception when file cannot be opened for reading', function () {
+    if (PHP_OS_FAMILY === 'Windows') {
+        $this->markTestSkipped('File permissions work differently on Windows. The feature tested might still work.');
+    }
+
+    chmod($this->file->path, 0333); // prevent reading
+    $logReader = $this->file->logs();
+
+    $logReader->scan();
+})->expectException(CannotOpenFileException::class);

tests/Unit/MultipleLogReaderTest.php

@@ -0,0 +1,28 @@
+<?php
+
+use Opcodes\LogViewer\Facades\LogViewer;
+
+it('continues reading when one file cannot be read', function () {
+    if (PHP_OS_FAMILY === 'Windows') {
+        $this->markTestSkipped('File permissions work differently on Windows. The feature tested might still work.');
+    }
+
+    $files = [
+        generateLogFile(randomContent: true),
+        generateLogFile(randomContent: true),
+        generateLogFile(randomContent: true),
+    ];
+
+    $filesFound = LogViewer::getFiles();
+    expect($filesFound->count())->toBe(3);
+
+    chmod($files[1]->path, 0333); // prevent reading
+
+    try {
+        $filesFound->logs()->scan();
+
+        $this->assertTrue(true);
+    } catch (\Exception $exception) {
+        $this->fail('Exception thrown: '.$exception->getMessage());
+    }
+});