vendor/monolog/monolog/src/Monolog/Handler/StreamHandler.php line 25

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. /*
  4.  * This file is part of the Monolog package.
  5.  *
  6.  * (c) Jordi Boggiano <[email protected]>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Monolog\Handler;
  14. use Monolog\Level;
  15. use Monolog\Utils;
  16. use Monolog\LogRecord;
  18. /**
  19.  * Stores to any stream resource
  20.  *
  21.  * Can be used to store into php://stderr, remote and local files, etc.
  22.  *
  23.  * @author Jordi Boggiano <[email protected]>
  24.  */
  25. class StreamHandler extends AbstractProcessingHandler
  26. {
  27.     protected const MAX_CHUNK_SIZE = 2147483647;
  28.     /** 10MB */
  29.     protected const DEFAULT_CHUNK_SIZE = 10 * 1024 * 1024;
  30.     protected int $streamChunkSize;
  31.     /** @var resource|null */
  32.     protected $stream;
  33.     protected string|null $url = null;
  34.     private string|null $errorMessage = null;
  35.     protected int|null $filePermission;
  36.     protected bool $useLocking;
  37.     protected string $fileOpenMode;
  38.     /** @var true|null */
  39.     private bool|null $dirCreated = null;
  40.     private bool $retrying = false;
  42.     /**
  43.      * @param resource|string $stream         If a missing path can't be created, an UnexpectedValueException will be thrown on first write
  44.      * @param int|null        $filePermission Optional file permissions (default (0644) are only for owner read/write)
  45.      * @param bool            $useLocking     Try to lock log file before doing any writes
  46.      * @param string          $fileOpenMode   The fopen() mode used when opening a file, if $stream is a file path
  47.      *
  48.      * @throws \InvalidArgumentException If stream is not a resource or string
  49.      */
  50.     public function __construct($stream, int|string|Level $level = Level::Debug, bool $bubble = true, ?int $filePermission = null, bool $useLocking = false, string $fileOpenMode = 'a')
  51.     {
  52.         parent::__construct($level, $bubble);
  54.         if (($phpMemoryLimit = Utils::expandIniShorthandBytes(\ini_get('memory_limit'))) !== false) {
  55.             if ($phpMemoryLimit > 0) {
  56.                 // use max 10% of allowed memory for the chunk size, and at least 100KB
  57.                 $this->streamChunkSize = min(static::MAX_CHUNK_SIZE, max((int) ($phpMemoryLimit / 10), 100 * 1024));
  58.             } else {
  59.                 // memory is unlimited, set to the default 10MB
  60.                 $this->streamChunkSize = static::DEFAULT_CHUNK_SIZE;
  61.             }
  62.         } else {
  63.             // no memory limit information, set to the default 10MB
  64.             $this->streamChunkSize = static::DEFAULT_CHUNK_SIZE;
  65.         }
  67.         if (\is_resource($stream)) {
  68.             $this->stream = $stream;
  70.             stream_set_chunk_size($this->stream, $this->streamChunkSize);
  71.         } elseif (\is_string($stream)) {
  72.             $this->url = Utils::canonicalizePath($stream);
  73.         } else {
  74.             throw new \InvalidArgumentException('A stream must either be a resource or a string.');
  75.         }
  77.         $this->fileOpenMode = $fileOpenMode;
  78.         $this->filePermission = $filePermission;
  79.         $this->useLocking = $useLocking;
  80.     }
  82.     /**
  83.      * @inheritDoc
  84.      */
  85.     public function reset(): void
  86.     {
  87.         parent::reset();
  89.         // auto-close on reset to make sure we periodically close the file in long running processes
  90.         // as long as they correctly call reset() between jobs
  91.         if ($this->url !== null && $this->url !== 'php://memory') {
  92.             $this->close();
  93.         }
  94.     }
  96.     /**
  97.      * @inheritDoc
  98.      */
  99.     public function close(): void
  100.     {
  101.         if (null !== $this->url && \is_resource($this->stream)) {
  102.             fclose($this->stream);
  103.         }
  104.         $this->stream = null;
  105.         $this->dirCreated = null;
  106.     }
  108.     /**
  109.      * Return the currently active stream if it is open
  110.      *
  111.      * @return resource|null
  112.      */
  113.     public function getStream()
  114.     {
  115.         return $this->stream;
  116.     }
  118.     /**
  119.      * Return the stream URL if it was configured with a URL and not an active resource
  120.      */
  121.     public function getUrl(): ?string
  122.     {
  123.         return $this->url;
  124.     }
  126.     public function getStreamChunkSize(): int
  127.     {
  128.         return $this->streamChunkSize;
  129.     }
  131.     /**
  132.      * @inheritDoc
  133.      */
  134.     protected function write(LogRecord $record): void
  135.     {
  136.         if (!\is_resource($this->stream)) {
  137.             $url = $this->url;
  138.             if (null === $url || '' === $url) {
  139.                 throw new \LogicException('Missing stream url, the stream can not be opened. This may be caused by a premature call to close().' . Utils::getRecordMessageForException($record));
  140.             }
  141.             $this->createDir($url);
  142.             $this->errorMessage = null;
  143.             set_error_handler($this->customErrorHandler(...));
  145.             try {
  146.                 $stream = fopen($url, $this->fileOpenMode);
  147.                 if ($this->filePermission !== null) {
  148.                     @chmod($url, $this->filePermission);
  149.                 }
  150.             } finally {
  151.                 restore_error_handler();
  152.             }
  153.             if (!\is_resource($stream)) {
  154.                 $this->stream = null;
  156.                 throw new \UnexpectedValueException(sprintf('The stream or file "%s" could not be opened in append mode: '.$this->errorMessage, $url) . Utils::getRecordMessageForException($record));
  157.             }
  158.             stream_set_chunk_size($stream, $this->streamChunkSize);
  159.             $this->stream = $stream;
  160.         }
  162.         $stream = $this->stream;
  163.         if ($this->useLocking) {
  164.             // ignoring errors here, there's not much we can do about them
  165.             flock($stream, LOCK_EX);
  166.         }
  168.         $this->errorMessage = null;
  169.         set_error_handler($this->customErrorHandler(...));
  170.         try {
  171.             $this->streamWrite($stream, $record);
  172.         } finally {
  173.             restore_error_handler();
  174.         }
  175.         if ($this->errorMessage !== null) {
  176.             $error = $this->errorMessage;
  177.             // close the resource if possible to reopen it, and retry the failed write
  178.             if (!$this->retrying && $this->url !== null && $this->url !== 'php://memory') {
  179.                 $this->retrying = true;
  180.                 $this->close();
  181.                 $this->write($record);
  183.                 return;
  184.             }
  186.             throw new \UnexpectedValueException('Writing to the log file failed: '.$error . Utils::getRecordMessageForException($record));
  187.         }
  189.         $this->retrying = false;
  190.         if ($this->useLocking) {
  191.             flock($stream, LOCK_UN);
  192.         }
  193.     }
  195.     /**
  196.      * Write to stream
  197.      * @param resource $stream
  198.      */
  199.     protected function streamWrite($stream, LogRecord $record): void
  200.     {
  201.         fwrite($stream, (string) $record->formatted);
  202.     }
  204.     private function customErrorHandler(int $code, string $msg): bool
  205.     {
  206.         $this->errorMessage = preg_replace('{^(fopen|mkdir|fwrite)\(.*?\): }', '', $msg);
  208.         return true;
  209.     }
  211.     private function getDirFromStream(string $stream): ?string
  212.     {
  213.         $pos = strpos($stream, '://');
  214.         if ($pos === false) {
  215.             return \dirname($stream);
  216.         }
  218.         if ('file://' === substr($stream, 0, 7)) {
  219.             return \dirname(substr($stream, 7));
  220.         }
  222.         return null;
  223.     }
  225.     private function createDir(string $url): void
  226.     {
  227.         // Do not try to create dir if it has already been tried.
  228.         if (true === $this->dirCreated) {
  229.             return;
  230.         }
  232.         $dir = $this->getDirFromStream($url);
  233.         if (null !== $dir && !is_dir($dir)) {
  234.             $this->errorMessage = null;
  235.             set_error_handler(function (...$args) {
  236.                 return $this->customErrorHandler(...$args);
  237.             });
  238.             $status = mkdir($dir, 0777, true);
  239.             restore_error_handler();
  240.             if (false === $status && !is_dir($dir) && strpos((string) $this->errorMessage, 'File exists') === false) {
  241.                 throw new \UnexpectedValueException(sprintf('There is no existing directory at "%s" and it could not be created: '.$this->errorMessage, $dir));
  242.             }
  243.         }
  244.         $this->dirCreated = true;
  245.     }
  246. }