CliHttpCache::getServerKey()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 1
c 0
b 0
f 0
nc 1
nop 1
dl 0
loc 3
rs 10
1
<?php
2
3
declare(strict_types=1);
4
5
namespace BEAR\QueryRepository;
6
7
use BEAR\Sunday\Extension\Transfer\HttpCacheInterface;
0 ignored issues
show
Bug introduced by
This use statement conflicts with another class in this namespace, BEAR\QueryRepository\HttpCacheInterface. Consider defining an alias.

Let?s assume that you have a directory layout like this:

.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php

and let?s assume the following content of Bar.php:

// Bar.php
namespace OtherDir;

use SomeDir\Foo; // This now conflicts the class OtherDir\Foo

If both files OtherDir/Foo.php and SomeDir/Foo.php are loaded in the same runtime, you will see a PHP error such as the following:

PHP Fatal error:  Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php

However, as OtherDir/Foo.php does not necessarily have to be loaded and the error is only triggered if it is loaded before OtherDir/Bar.php, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias:

// Bar.php
namespace OtherDir;

use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore.
Loading history...
8
use Override;
9
10
use function assert;
11
use function is_string;
12
use function parse_str;
13
use function sprintf;
14
use function str_replace;
15
use function strtoupper;
16
17
use const PHP_EOL;
18
19
final class CliHttpCache implements HttpCacheInterface
20
{
21
    public function __construct(
22
        private readonly ResourceStorageInterface $storage,
23
    ) {
24
    }
25
26
    /**
27
     * {@inheritDoc}
28
     */
29
    #[Override]
30
    public function isNotModified(array $server): bool
31
    {
32
        $etag = $this->getEtag($server);
33
        if ($etag === null) {
34
            return false;
35
        }
36
37
        return $this->storage->hasEtag($etag);
38
    }
39
40
    /**
41
     * {@inheritDoc}
42
     *
43
     * @return void
44
     */
45
    #[Override]
46
    public function transfer()
47
    {
48
        echo '304 Not Modified' . PHP_EOL . PHP_EOL;
49
    }
50
51
    /** @return array<string, string> */
52
    private function getServer(string $query): array
53
    {
54
        parse_str($query, $headers);
55
        $server = [];
56
        foreach ($headers as $key => $header) {
57
            assert(is_string($header));
58
            assert(is_string($key));
59
            $server[$this->getServerKey($key)] = $header;
60
        }
61
62
        return $server;
63
    }
64
65
    private function getServerKey(string $key): string
66
    {
67
        return sprintf('HTTP_%s', strtoupper(str_replace('-', '_', $key)));
68
    }
69
70
    /** @param array<string, mixed> $server */
71
    private function getEtag(array $server): string|null
72
    {
73
        /** @psalm-suppress MixedAssignment */
74
        $arg3 = $server['argv'][3] ?? ''; /* @phpstan-ignore-line */
75
        assert(is_string($arg3));
76
        $hasRequestHeaderInCli = isset($server['argc']) && $server['argc'] === 4 && $arg3;
77
        if ($hasRequestHeaderInCli) {
78
            /** @psalm-suppress MixedArrayAccess */
79
            $server = $this->getServer($arg3);
80
        }
81
82
        if (isset($server[Header::HTTP_IF_NONE_MATCH]) && is_string($server[Header::HTTP_IF_NONE_MATCH])) {
83
            return $server[Header::HTTP_IF_NONE_MATCH];
84
        }
85
86
        return null;
87
    }
88
}
89