Passed
Pull Request — master (#91)
by Rustam
02:42
created

FileStorage::clear()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 2

Importance

Changes 0
Metric Value
eloc 1
c 0
b 0
f 0
dl 0
loc 3
ccs 0
cts 2
cp 0
rs 10
cc 1
nc 1
nop 0
crap 2
1
<?php
2
3
declare(strict_types=1);
4
5
namespace Yiisoft\Yii\Debug\Storage;
6
7
use League\Flysystem\FilesystemException;
8
use Yiisoft\Aliases\Aliases;
9
use Yiisoft\Json\Json;
10
use Yiisoft\Yii\Debug\Collector\CollectorInterface;
11
use Yiisoft\Yii\Debug\Collector\IndexCollectorInterface;
12
use Yiisoft\Yii\Debug\DebuggerIdGenerator;
13
use Yiisoft\Yii\Debug\Dumper;
14
use Yiisoft\Yii\Filesystem\FilesystemInterface;
15
16
use function array_merge;
17
use function array_slice;
18
use function count;
19
use function dirname;
20
use function filemtime;
21
use function get_class;
22
use function glob;
23
use function strlen;
24
use function substr;
25
use function uasort;
26
27
final class FileStorage implements StorageInterface
28
{
29
    /**
30
     * @var CollectorInterface[]
31
     */
32
    private array $collectors = [];
33
34
    private string $path;
35
36
    private int $historySize = 50;
37
38
    private DebuggerIdGenerator $idGenerator;
39
40
    private FilesystemInterface $filesystem;
41
42
    private Aliases $aliases;
43
44 32
    public function __construct(
45
        string $path,
46
        FilesystemInterface $filesystem,
47
        DebuggerIdGenerator $idGenerator,
48
        Aliases $aliases
49
    ) {
50 32
        $this->path = $path;
51 32
        $this->filesystem = $filesystem;
52 32
        $this->idGenerator = $idGenerator;
53 32
        $this->aliases = $aliases;
54 32
    }
55
56 32
    public function addCollector(CollectorInterface $collector): void
57
    {
58 32
        $this->collectors[get_class($collector)] = $collector;
59 32
    }
60
61 8
    public function setHistorySize(int $historySize): void
62
    {
63 8
        $this->historySize = $historySize;
64 8
    }
65
66 16
    public function read($type = self::TYPE_INDEX): array
67
    {
68 16
        clearstatcache();
69 16
        $data = [];
70 16
        $path = $this->aliases->get($this->path);
71 16
        $dataFiles = glob($path . '/**/**/' . $type . '.json', GLOB_NOSORT);
72 16
        foreach ($dataFiles as $file) {
73
            $dir = dirname($file);
74
            $id = substr($dir, strlen(dirname($file, 2)) + 1);
75
            $data[$id] = Json::decode(file_get_contents($file));
76
        }
77
78 16
        return $data;
79
    }
80
81 24
    public function flush(): void
82
    {
83 24
        $basePath = $this->path . '/' . date('Y-m-d') . '/' . $this->idGenerator->getId() . '/';
84
        try {
85 24
            $dumper = Dumper::create($this->getData());
86 24
            $jsonData = $dumper->asJson();
87 24
            $this->filesystem->write($basePath . self::TYPE_DATA . '.json', $jsonData);
88
89 24
            $jsonObjects = json_decode($dumper->asJsonObjectsMap(), true);
90 24
            $jsonObjects = $this->reindexObjects($jsonObjects);
91 24
            $this->filesystem->write($basePath . self::TYPE_OBJECTS . '.json', Dumper::create($jsonObjects)->asJson());
92
93 24
            $indexData = Dumper::create($this->collectIndexData())->asJson();
94 24
            $this->filesystem->write($basePath . self::TYPE_INDEX . '.json', $indexData);
95
96 24
            $this->gc();
97 24
        } finally {
98 24
            $this->collectors = [];
99
        }
100 24
    }
101
102 32
    public function getData(): array
103
    {
104 32
        $data = [];
105 32
        foreach ($this->collectors as $collector) {
106 32
            $data[get_class($collector)] = $collector->getCollected();
107
        }
108
109 32
        return $data;
110
    }
111
112
    public function clear(): void
113
    {
114
        $this->filesystem->deleteDirectory($this->path);
115
    }
116
117
    /**
118
     * Collects summary data of current request.
119
     *
120
     * @return array
121
     */
122 24
    private function collectIndexData(): array
123
    {
124 24
        $indexData = ['id' => $this->idGenerator->getId()];
125
126 24
        foreach ($this->collectors as $collector) {
127 24
            if ($collector instanceof IndexCollectorInterface) {
128
                $indexData = array_merge($indexData, $collector->getIndexData());
129
            }
130
        }
131
132 24
        return $indexData;
133
    }
134
135
    /**
136
     * Removes obsolete data files
137
     *
138
     * @throws FilesystemException
139
     */
140 24
    private function gc(): void
141
    {
142 24
        $indexFiles = glob($this->aliases->get($this->path) . '/**/**/index.json', GLOB_NOSORT);
143 24
        if (count($indexFiles) >= $this->historySize + 1) {
144
            uasort($indexFiles, static fn ($a, $b) => filemtime($b) <=> filemtime($a));
145
            $excessFiles = array_slice($indexFiles, $this->historySize);
146
            foreach ($excessFiles as $file) {
147
                $path1 = dirname($file);
148
                $path2 = dirname($file, 2);
149
                $path3 = dirname($file, 3);
150
                $resource = substr($path1, strlen($path3));
151
                $this->filesystem->deleteDirectory($this->path . $resource);
152
153
                // Clean empty group directories
154
                $group = substr($path2, strlen($path3));
155
                $list = $this->filesystem->listContents($this->path . $group);
156
                if (empty($list->toArray())) {
157
                    $this->filesystem->deleteDirectory($this->path . $group);
158
                }
159
            }
160
        }
161 24
    }
162
163 24
    private function reindexObjects(array $objectsAsArraysCollection): array
164
    {
165 24
        $result = [];
166 24
        foreach ($objectsAsArraysCollection as $objectAsArray) {
167 3
            $result = array_merge($result, $objectAsArray);
168
        }
169
170 24
        return $result;
171
    }
172
}
173