Profiler.php 6.8 KB

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