session-samurai/src/MongoDbSessionHandler.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
<?php

namespace Detain\SessionSamurai;

use MongoDB\Collection;
use MongoDB\BSON\UTCDateTime;

class MongoDbSessionHandler implements \SessionHandlerInterface, \SessionIdInterface, \SessionUpdateTimestampHandlerInterface
{
    protected Collection $sessionCollection;

    public function __construct(Collection $sessionCollection)
    {
        $this->sessionCollection = $sessionCollection;
    }

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

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

    /**
     * {@inheritdoc}
     */
    public function read(string $id): string
    {
        $document = $this->sessionCollection->findOne(['_id' => $id]);

        if ($document === null) {
            return '';
        }
        $docArray = (array) $document;
        return isset($docArray['data']) && is_string($docArray['data']) ? $docArray['data'] : '';
    }

    /**
     * {@inheritdoc}
     */
    public function write(string $id, string $data): bool
    {
        $options = ['upsert' => true];
        $query = ['_id' => $id];
        $update = [
            '$set' => [
                'data' => $data,
                'updated_at' => new UTCDateTime(),
            ]
        ];
        $result = $this->sessionCollection->updateOne($query, $update, $options);
        return $result->getModifiedCount() > 0 || $result->getUpsertedCount() > 0;
    }

    /**
     * {@inheritdoc}
     */
    public function destroy(string $id): bool
    {
        $result = $this->sessionCollection->deleteOne(['_id' => $id]);
        return $result->getDeletedCount() > 0;
    }

    /**
     * {@inheritdoc}
     */
    public function gc(int $maxlifetime): int|false
    {
        $expiry = new UTCDateTime((time() - $maxlifetime) * 1000);
        $result = $this->sessionCollection->deleteMany(['updated_at' => ['$lt' => $expiry]]);
        return (int) $result->getDeletedCount();
    }

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

    /**
     * {@inheritdoc}
     */
    public function validateId(string $id): bool
    {
        return $this->sessionCollection->countDocuments(['_id' => $id]) > 0;
    }

    /**
     * {@inheritdoc}
     */
    public function updateTimestamp(string $id, string $data): bool
    {
        $options = ['upsert' => false];
        $query = ['_id' => $id];
        $update = ['$set' => ['updated_at' => new UTCDateTime()]];
        $result = $this->sessionCollection->updateOne($query, $update, $options);
        return $result->getModifiedCount() > 0;
    }
}