www.aleph1.co.uk Git - yaffs-website/blob - vendor/symfony/http-kernel/Profiler/FileProfilerStorage.php

   1 <?php
   2
   3 /*
   4  * This file is part of the Symfony package.
   5  *
   6  * (c) Fabien Potencier <fabien@symfony.com>
   7  *
   8  * For the full copyright and license information, please view the LICENSE
   9  * file that was distributed with this source code.
  10  */
  11
  12 namespace Symfony\Component\HttpKernel\Profiler;
  13
  14 /**
  15  * Storage for profiler using files.
  16  *
  17  * @author Alexandre Salomé <alexandre.salome@gmail.com>
  18  */
  19 class FileProfilerStorage implements ProfilerStorageInterface
  20 {
  21     /**
  22      * Folder where profiler data are stored.
  23      *
  24      * @var string
  25      */
  26     private $folder;
  27
  28     /**
  29      * Constructs the file storage using a "dsn-like" path.
  30      *
  31      * Example : "file:/path/to/the/storage/folder"
  32      *
  33      * @param string $dsn The DSN
  34      *
  35      * @throws \RuntimeException
  36      */
  37     public function __construct($dsn)
  38     {
  39         if (0 !== strpos($dsn, 'file:')) {
  40             throw new \RuntimeException(sprintf('Please check your configuration. You are trying to use FileStorage with an invalid dsn "%s". The expected format is "file:/path/to/the/storage/folder".', $dsn));
  41         }
  42         $this->folder = substr($dsn, 5);
  43
  44         if (!is_dir($this->folder) && false === @mkdir($this->folder, 0777, true) && !is_dir($this->folder)) {
  45             throw new \RuntimeException(sprintf('Unable to create the storage directory (%s).', $this->folder));
  46         }
  47     }
  48
  49     /**
  50      * {@inheritdoc}
  51      */
  52     public function find($ip, $url, $limit, $method, $start = null, $end = null)
  53     {
  54         $file = $this->getIndexFilename();
  55
  56         if (!file_exists($file)) {
  57             return array();
  58         }
  59
  60         $file = fopen($file, 'r');
  61         fseek($file, 0, SEEK_END);
  62
  63         $result = array();
  64         while (count($result) < $limit && $line = $this->readLineFromFile($file)) {
  65             $values = str_getcsv($line);
  66             list($csvToken, $csvIp, $csvMethod, $csvUrl, $csvTime, $csvParent) = $values;
  67             $csvStatusCode = isset($values[6]) ? $values[6] : null;
  68
  69             $csvTime = (int) $csvTime;
  70
  71             if ($ip && false === strpos($csvIp, $ip) || $url && false === strpos($csvUrl, $url) || $method && false === strpos($csvMethod, $method)) {
  72                 continue;
  73             }
  74
  75             if (!empty($start) && $csvTime < $start) {
  76                 continue;
  77             }
  78
  79             if (!empty($end) && $csvTime > $end) {
  80                 continue;
  81             }
  82
  83             $result[$csvToken] = array(
  84                 'token' => $csvToken,
  85                 'ip' => $csvIp,
  86                 'method' => $csvMethod,
  87                 'url' => $csvUrl,
  88                 'time' => $csvTime,
  89                 'parent' => $csvParent,
  90                 'status_code' => $csvStatusCode,
  91             );
  92         }
  93
  94         fclose($file);
  95
  96         return array_values($result);
  97     }
  98
  99     /**
 100      * {@inheritdoc}
 101      */
 102     public function purge()
 103     {
 104         $flags = \FilesystemIterator::SKIP_DOTS;
 105         $iterator = new \RecursiveDirectoryIterator($this->folder, $flags);
 106         $iterator = new \RecursiveIteratorIterator($iterator, \RecursiveIteratorIterator::CHILD_FIRST);
 107
 108         foreach ($iterator as $file) {
 109             if (is_file($file)) {
 110                 unlink($file);
 111             } else {
 112                 rmdir($file);
 113             }
 114         }
 115     }
 116
 117     /**
 118      * {@inheritdoc}
 119      */
 120     public function read($token)
 121     {
 122         if (!$token || !file_exists($file = $this->getFilename($token))) {
 123             return;
 124         }
 125
 126         return $this->createProfileFromData($token, unserialize(file_get_contents($file)));
 127     }
 128
 129     /**
 130      * {@inheritdoc}
 131      *
 132      * @throws \RuntimeException
 133      */
 134     public function write(Profile $profile)
 135     {
 136         $file = $this->getFilename($profile->getToken());
 137
 138         $profileIndexed = is_file($file);
 139         if (!$profileIndexed) {
 140             // Create directory
 141             $dir = dirname($file);
 142             if (!is_dir($dir) && false === @mkdir($dir, 0777, true) && !is_dir($dir)) {
 143                 throw new \RuntimeException(sprintf('Unable to create the storage directory (%s).', $dir));
 144             }
 145         }
 146
 147         // Store profile
 148         $data = array(
 149             'token' => $profile->getToken(),
 150             'parent' => $profile->getParentToken(),
 151             'children' => array_map(function ($p) { return $p->getToken(); }, $profile->getChildren()),
 152             'data' => $profile->getCollectors(),
 153             'ip' => $profile->getIp(),
 154             'method' => $profile->getMethod(),
 155             'url' => $profile->getUrl(),
 156             'time' => $profile->getTime(),
 157         );
 158
 159         if (false === file_put_contents($file, serialize($data))) {
 160             return false;
 161         }
 162
 163         if (!$profileIndexed) {
 164             // Add to index
 165             if (false === $file = fopen($this->getIndexFilename(), 'a')) {
 166                 return false;
 167             }
 168
 169             fputcsv($file, array(
 170                 $profile->getToken(),
 171                 $profile->getIp(),
 172                 $profile->getMethod(),
 173                 $profile->getUrl(),
 174                 $profile->getTime(),
 175                 $profile->getParentToken(),
 176                 $profile->getStatusCode(),
 177             ));
 178             fclose($file);
 179         }
 180
 181         return true;
 182     }
 183
 184     /**
 185      * Gets filename to store data, associated to the token.
 186      *
 187      * @param string $token
 188      *
 189      * @return string The profile filename
 190      */
 191     protected function getFilename($token)
 192     {
 193         // Uses 4 last characters, because first are mostly the same.
 194         $folderA = substr($token, -2, 2);
 195         $folderB = substr($token, -4, 2);
 196
 197         return $this->folder.'/'.$folderA.'/'.$folderB.'/'.$token;
 198     }
 199
 200     /**
 201      * Gets the index filename.
 202      *
 203      * @return string The index filename
 204      */
 205     protected function getIndexFilename()
 206     {
 207         return $this->folder.'/index.csv';
 208     }
 209
 210     /**
 211      * Reads a line in the file, backward.
 212      *
 213      * This function automatically skips the empty lines and do not include the line return in result value.
 214      *
 215      * @param resource $file The file resource, with the pointer placed at the end of the line to read
 216      *
 217      * @return mixed A string representing the line or null if beginning of file is reached
 218      */
 219     protected function readLineFromFile($file)
 220     {
 221         $line = '';
 222         $position = ftell($file);
 223
 224         if (0 === $position) {
 225             return;
 226         }
 227
 228         while (true) {
 229             $chunkSize = min($position, 1024);
 230             $position -= $chunkSize;
 231             fseek($file, $position);
 232
 233             if (0 === $chunkSize) {
 234                 // bof reached
 235                 break;
 236             }
 237
 238             $buffer = fread($file, $chunkSize);
 239
 240             if (false === ($upTo = strrpos($buffer, "\n"))) {
 241                 $line = $buffer.$line;
 242                 continue;
 243             }
 244
 245             $position += $upTo;
 246             $line = substr($buffer, $upTo + 1).$line;
 247             fseek($file, max(0, $position), SEEK_SET);
 248
 249             if ('' !== $line) {
 250                 break;
 251             }
 252         }
 253
 254         return '' === $line ? null : $line;
 255     }
 256
 257     protected function createProfileFromData($token, $data, $parent = null)
 258     {
 259         $profile = new Profile($token);
 260         $profile->setIp($data['ip']);
 261         $profile->setMethod($data['method']);
 262         $profile->setUrl($data['url']);
 263         $profile->setTime($data['time']);
 264         $profile->setCollectors($data['data']);
 265
 266         if (!$parent && $data['parent']) {
 267             $parent = $this->read($data['parent']);
 268         }
 269
 270         if ($parent) {
 271             $profile->setParent($parent);
 272         }
 273
 274         foreach ($data['children'] as $token) {
 275             if (!$token || !file_exists($file = $this->getFilename($token))) {
 276                 continue;
 277             }
 278
 279             $profile->addChild($this->createProfileFromData($token, unserialize(file_get_contents($file)), $profile));
 280         }
 281
 282         return $profile;
 283     }
 284 }