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

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Monolog package.
  5.  *
  6.  * (c) Jordi Boggiano <j.boggiano@seld.be>
  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\Logger;
  16. /**
  17.  * Stores to any stream resource
  18.  *
  19.  * Can be used to store into php://stderr, remote and local files, etc.
  20.  *
  21.  * @author Jordi Boggiano <j.boggiano@seld.be>
  22.  */
  23. class StreamHandler extends AbstractProcessingHandler
  24. {
  25.     protected $stream;
  26.     protected $url;
  27.     private $errorMessage;
  28.     protected $filePermission;
  29.     protected $useLocking;
  30.     private $dirCreated;
  32.     /**
  33.      * @param resource|string $stream
  34.      * @param int             $level          The minimum logging level at which this handler will be triggered
  35.      * @param bool            $bubble         Whether the messages that are handled can bubble up the stack or not
  36.      * @param int|null        $filePermission Optional file permissions (default (0644) are only for owner read/write)
  37.      * @param bool            $useLocking     Try to lock log file before doing any writes
  38.      *
  39.      * @throws \Exception                If a missing directory is not buildable
  40.      * @throws \InvalidArgumentException If stream is not a resource or string
  41.      */
  42.     public function __construct($stream, $level = Logger::DEBUG, $bubble = true, $filePermission = null, $useLocking = false)
  43.     {
  44.         parent::__construct($level, $bubble);
  45.         if (is_resource($stream)) {
  46.             $this->stream = $stream;
  47.         } elseif (is_string($stream)) {
  48.             $this->url = $stream;
  49.         } else {
  50.             throw new \InvalidArgumentException('A stream must either be a resource or a string.');
  51.         }
  53.         $this->filePermission = $filePermission;
  54.         $this->useLocking = $useLocking;
  55.     }
  57.     /**
  58.      * {@inheritdoc}
  59.      */
  60.     public function close()
  61.     {
  62.         if ($this->url && is_resource($this->stream)) {
  63.             fclose($this->stream);
  64.         }
  65.         $this->stream = null;
  66.         $this->dirCreated = null;
  67.     }
  69.     /**
  70.      * Return the currently active stream if it is open
  71.      *
  72.      * @return resource|null
  73.      */
  74.     public function getStream()
  75.     {
  76.         return $this->stream;
  77.     }
  79.     /**
  80.      * Return the stream URL if it was configured with a URL and not an active resource
  81.      *
  82.      * @return string|null
  83.      */
  84.     public function getUrl()
  85.     {
  86.         return $this->url;
  87.     }
  89.     /**
  90.      * {@inheritdoc}
  91.      */
  92.     protected function write(array $record)
  93.     {
  94.         if (!is_resource($this->stream)) {
  95.             if (null === $this->url || '' === $this->url) {
  96.                 throw new \LogicException('Missing stream url, the stream can not be opened. This may be caused by a premature call to close().');
  97.             }
  98.             $this->createDir();
  99.             $this->errorMessage = null;
  100.             set_error_handler(array($this, 'customErrorHandler'));
  101.             $this->stream = fopen($this->url, 'a');
  102.             if ($this->filePermission !== null) {
  103.                 @chmod($this->url, $this->filePermission);
  104.             }
  105.             restore_error_handler();
  106.             if (!is_resource($this->stream)) {
  107.                 $this->stream = null;
  108.                 throw new \UnexpectedValueException(sprintf('The stream or file "%s" could not be opened: '.$this->errorMessage, $this->url));
  109.             }
  110.         }
  112.         if ($this->useLocking) {
  113.             // ignoring errors here, there's not much we can do about them
  114.             flock($this->stream, LOCK_EX);
  115.         }
  117.         $this->streamWrite($this->stream, $record);
  119.         if ($this->useLocking) {
  120.             flock($this->stream, LOCK_UN);
  121.         }
  122.     }
  124.     /**
  125.      * Write to stream
  126.      * @param resource $stream
  127.      * @param array $record
  128.      */
  129.     protected function streamWrite($stream, array $record)
  130.     {
  131.         fwrite($stream, (string) $record['formatted']);
  132.     }
  134.     private function customErrorHandler($code, $msg)
  135.     {
  136.         $this->errorMessage = preg_replace('{^(fopen|mkdir)\(.*?\): }', '', $msg);
  137.     }
  139.     /**
  140.      * @param string $stream
  141.      *
  142.      * @return null|string
  143.      */
  144.     private function getDirFromStream($stream)
  145.     {
  146.         $pos = strpos($stream, '://');
  147.         if ($pos === false) {
  148.             return dirname($stream);
  149.         }
  151.         if ('file://' === substr($stream, 0, 7)) {
  152.             return dirname(substr($stream, 7));
  153.         }
  155.         return;
  156.     }
  158.     private function createDir()
  159.     {
  160.         // Do not try to create dir if it has already been tried.
  161.         if ($this->dirCreated) {
  162.             return;
  163.         }
  165.         $dir = $this->getDirFromStream($this->url);
  166.         if (null !== $dir && !is_dir($dir)) {
  167.             $this->errorMessage = null;
  168.             set_error_handler(array($this, 'customErrorHandler'));
  169.             $status = mkdir($dir, 0777, true);
  170.             restore_error_handler();
  171.             if (false === $status && !is_dir($dir)) {
  172.                 throw new \UnexpectedValueException(sprintf('There is no existing directory at "%s" and its not buildable: '.$this->errorMessage, $dir));
  173.             }
  174.         }
  175.         $this->dirCreated = true;
  176.     }
  177. }