vendor/symfony/http-kernel/Profiler/Profiler.php line 103

Open in your IDE?
  1. <?php
  2. /*
  3.  * This file is part of the Symfony package.
  4.  *
  5.  * (c) Fabien Potencier <fabien@symfony.com>
  6.  *
  7.  * For the full copyright and license information, please view the LICENSE
  8.  * file that was distributed with this source code.
  9.  */
  10. namespace Symfony\Component\HttpKernel\Profiler;
  11. use Psr\Log\LoggerInterface;
  12. use Symfony\Component\HttpFoundation\Exception\ConflictingHeadersException;
  13. use Symfony\Component\HttpFoundation\Request;
  14. use Symfony\Component\HttpFoundation\Response;
  15. use Symfony\Component\HttpKernel\DataCollector\DataCollectorInterface;
  16. use Symfony\Component\HttpKernel\DataCollector\LateDataCollectorInterface;
  17. use Symfony\Contracts\Service\ResetInterface;
  18. /**
  19.  * Profiler.
  20.  *
  21.  * @author Fabien Potencier <fabien@symfony.com>
  22.  */
  23. class Profiler implements ResetInterface
  24. {
  25.     private $storage;
  26.     /**
  27.      * @var DataCollectorInterface[]
  28.      */
  29.     private $collectors = array();
  30.     private $logger;
  31.     private $initiallyEnabled true;
  32.     private $enabled true;
  33.     public function __construct(ProfilerStorageInterface $storageLoggerInterface $logger nullbool $enable true)
  34.     {
  35.         $this->storage $storage;
  36.         $this->logger $logger;
  37.         $this->initiallyEnabled $this->enabled $enable;
  38.     }
  39.     /**
  40.      * Disables the profiler.
  41.      */
  42.     public function disable()
  43.     {
  44.         $this->enabled false;
  45.     }
  46.     /**
  47.      * Enables the profiler.
  48.      */
  49.     public function enable()
  50.     {
  51.         $this->enabled true;
  52.     }
  53.     /**
  54.      * Loads the Profile for the given Response.
  55.      *
  56.      * @return Profile|false A Profile instance
  57.      */
  58.     public function loadProfileFromResponse(Response $response)
  59.     {
  60.         if (!$token $response->headers->get('X-Debug-Token')) {
  61.             return false;
  62.         }
  63.         return $this->loadProfile($token);
  64.     }
  65.     /**
  66.      * Loads the Profile for the given token.
  67.      *
  68.      * @param string $token A token
  69.      *
  70.      * @return Profile A Profile instance
  71.      */
  72.     public function loadProfile($token)
  73.     {
  74.         return $this->storage->read($token);
  75.     }
  76.     /**
  77.      * Saves a Profile.
  78.      *
  79.      * @return bool
  80.      */
  81.     public function saveProfile(Profile $profile)
  82.     {
  83.         // late collect
  84.         foreach ($profile->getCollectors() as $collector) {
  85.             if ($collector instanceof LateDataCollectorInterface) {
  86.                 $collector->lateCollect();
  87.             }
  88.         }
  89.         if (!($ret $this->storage->write($profile)) && null !== $this->logger) {
  90.             $this->logger->warning('Unable to store the profiler information.', array('configured_storage' => \get_class($this->storage)));
  91.         }
  92.         return $ret;
  93.     }
  94.     /**
  95.      * Purges all data from the storage.
  96.      */
  97.     public function purge()
  98.     {
  99.         $this->storage->purge();
  100.     }
  101.     /**
  102.      * Finds profiler tokens for the given criteria.
  103.      *
  104.      * @param string $ip         The IP
  105.      * @param string $url        The URL
  106.      * @param string $limit      The maximum number of tokens to return
  107.      * @param string $method     The request method
  108.      * @param string $start      The start date to search from
  109.      * @param string $end        The end date to search to
  110.      * @param string $statusCode The request status code
  111.      *
  112.      * @return array An array of tokens
  113.      *
  114.      * @see http://php.net/manual/en/datetime.formats.php for the supported date/time formats
  115.      */
  116.     public function find($ip$url$limit$method$start$end$statusCode null)
  117.     {
  118.         return $this->storage->find($ip$url$limit$method$this->getTimestamp($start), $this->getTimestamp($end), $statusCode);
  119.     }
  120.     /**
  121.      * Collects data for the given Response.
  122.      *
  123.      * @return Profile|null A Profile instance or null if the profiler is disabled
  124.      */
  125.     public function collect(Request $requestResponse $response, \Exception $exception null)
  126.     {
  127.         if (false === $this->enabled) {
  128.             return;
  129.         }
  130.         $profile = new Profile(substr(hash('sha256'uniqid(mt_rand(), true)), 06));
  131.         $profile->setTime(time());
  132.         $profile->setUrl($request->getUri());
  133.         $profile->setMethod($request->getMethod());
  134.         $profile->setStatusCode($response->getStatusCode());
  135.         try {
  136.             $profile->setIp($request->getClientIp());
  137.         } catch (ConflictingHeadersException $e) {
  138.             $profile->setIp('Unknown');
  139.         }
  140.         if ($prevToken $response->headers->get('X-Debug-Token')) {
  141.             $response->headers->set('X-Previous-Debug-Token'$prevToken);
  142.         }
  143.         $response->headers->set('X-Debug-Token'$profile->getToken());
  144.         foreach ($this->collectors as $collector) {
  145.             $collector->collect($request$response$exception);
  146.             // we need to clone for sub-requests
  147.             $profile->addCollector(clone $collector);
  148.         }
  149.         return $profile;
  150.     }
  151.     public function reset()
  152.     {
  153.         foreach ($this->collectors as $collector) {
  154.             $collector->reset();
  155.         }
  156.         $this->enabled $this->initiallyEnabled;
  157.     }
  158.     /**
  159.      * Gets the Collectors associated with this profiler.
  160.      *
  161.      * @return array An array of collectors
  162.      */
  163.     public function all()
  164.     {
  165.         return $this->collectors;
  166.     }
  167.     /**
  168.      * Sets the Collectors associated with this profiler.
  169.      *
  170.      * @param DataCollectorInterface[] $collectors An array of collectors
  171.      */
  172.     public function set(array $collectors = array())
  173.     {
  174.         $this->collectors = array();
  175.         foreach ($collectors as $collector) {
  176.             $this->add($collector);
  177.         }
  178.     }
  179.     /**
  180.      * Adds a Collector.
  181.      */
  182.     public function add(DataCollectorInterface $collector)
  183.     {
  184.         $this->collectors[$collector->getName()] = $collector;
  185.     }
  186.     /**
  187.      * Returns true if a Collector for the given name exists.
  188.      *
  189.      * @param string $name A collector name
  190.      *
  191.      * @return bool
  192.      */
  193.     public function has($name)
  194.     {
  195.         return isset($this->collectors[$name]);
  196.     }
  197.     /**
  198.      * Gets a Collector by name.
  199.      *
  200.      * @param string $name A collector name
  201.      *
  202.      * @return DataCollectorInterface A DataCollectorInterface instance
  203.      *
  204.      * @throws \InvalidArgumentException if the collector does not exist
  205.      */
  206.     public function get($name)
  207.     {
  208.         if (!isset($this->collectors[$name])) {
  209.             throw new \InvalidArgumentException(sprintf('Collector "%s" does not exist.'$name));
  210.         }
  211.         return $this->collectors[$name];
  212.     }
  213.     private function getTimestamp($value)
  214.     {
  215.         if (null === $value || '' == $value) {
  216.             return;
  217.         }
  218.         try {
  219.             $value = new \DateTime(is_numeric($value) ? '@'.$value $value);
  220.         } catch (\Exception $e) {
  221.             return;
  222.         }
  223.         return $value->getTimestamp();
  224.     }
  225. }