session-samurai/src/FlySystemSessionHandler.php at master · detain/session-samurai · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
<?php

namespace Detain\SessionSamurai;

use League\Flysystem\FilesystemOperator;

class FlySystemSessionHandler implements \SessionHandlerInterface, \SessionIdInterface, \SessionUpdateTimestampHandlerInterface
{
    protected FilesystemOperator $filesystem;
    protected string $path;

    public function __construct(FilesystemOperator $filesystem, string $path = '/')
    {
        $this->filesystem = $filesystem;
        $this->path = rtrim($path, '/');
    }

    /**
     * {@inheritdoc}
     */
    public function open(string $save_path, string $name): bool
    {
        return true;
    }

    /**
     * {@inheritdoc}
     */
    public function close(): bool
    {
        return true;
    }

    /**
     * {@inheritdoc}
     */
    public function read(string $session_id): string
    {
        $session_path = $this->getSessionPath($session_id);
        try {
            return $this->filesystem->read($session_path);
        } catch (\Throwable $e) {
            return '';
        }
    }

    /**
     * {@inheritdoc}
     */
    public function write(string $session_id, string $session_data): bool
    {
        $session_path = $this->getSessionPath($session_id);
        $this->filesystem->write($session_path, $session_data);
        return true;
    }

    /**
     * {@inheritdoc}
     */
    public function destroy(string $session_id): bool
    {
        $session_path = $this->getSessionPath($session_id);
        try {
            $this->filesystem->delete($session_path);
        } catch (\Throwable $e) {
            // file may not exist
        }
        return true;
    }

    /**
     * {@inheritdoc}
     */
    public function gc(int $maxlifetime): int|false
    {
        $expired_time = time() - $maxlifetime;
        $count = 0;
        foreach ($this->filesystem->listContents($this->path) as $item) {
            if ($item->lastModified() < $expired_time) {
                $this->filesystem->delete($item->path());
                $count++;
            }
        }
        return $count;
    }

    /**
     * {@inheritdoc}
     */
    // phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps
    public function create_sid(): string
    {
        return bin2hex(random_bytes(32));
    }

    /**
     * {@inheritdoc}
     */
    public function validateId(string $session_id): bool
    {
        $session_path = $this->getSessionPath($session_id);
        return $this->filesystem->fileExists($session_path);
    }

    /**
     * {@inheritdoc}
     */
    public function updateTimestamp(string $session_id, string $session_data): bool
    {
        $session_path = $this->getSessionPath($session_id);
        try {
            $existing = $this->filesystem->read($session_path);
            $this->filesystem->write($session_path, $existing);
            return true;
        } catch (\Throwable $e) {
            return false;
        }
    }

    protected function getSessionPath(string $session_id): string
    {
        return $this->path . '/' . $session_id;
    }
}