aboutsummaryrefslogtreecommitdiff
path: root/src/hydrilla/proxy/state_impl/base.py
blob: 78a50c02f04dc048028b8d77ba2fbc9a34e14b55 (plain)
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
# SPDX-License-Identifier: GPL-3.0-or-later

# Haketilo proxy data and configuration (definition of fields of a class that
# will implement HaketiloState).
#
# This file is part of Hydrilla&Haketilo.
#
# Copyright (C) 2022 Wojtek Kosior
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.
#
#
# I, Wojtek Kosior, thereby promise not to sue for violation of this
# file's license. Although I request that you do not make use this code
# in a proprietary program, I am not going to enforce this in court.

"""
This module defines fields that will later be part of a concrete HaketiloState
subtype.
"""

# Enable using with Python 3.7.
from __future__ import annotations

import sqlite3
import threading
import dataclasses as dc
import typing as t

from pathlib import Path
from contextlib import contextmanager

import sqlite3

from immutables import Map

from ... import pattern_tree
from .. import state
from .. import policies


PolicyTree = pattern_tree.PatternTree[policies.PolicyFactory]

#PayloadsDataMap = Map[state.PayloadRef, state.PayloadData]
DataById = t.Mapping[str, state.PayloadData]

# mypy needs to be corrected:
# https://stackoverflow.com/questions/70999513/conflict-between-mix-ins-for-abstract-dataclasses/70999704#70999704
@dc.dataclass # type: ignore[misc]
class HaketiloStateWithFields(state.HaketiloState):
    """...."""
    store_dir:      Path
    connection:     sqlite3.Connection
    current_cursor: t.Optional[sqlite3.Cursor] = None
    #settings:       state.HaketiloGlobalSettings

    policy_tree:   PolicyTree      = PolicyTree()
    #payloads_data: PayloadsDataMap = Map()
    payloads_data: DataById   = dc.field(default_factory=dict)

    lock: threading.RLock = dc.field(default_factory=threading.RLock)

    @contextmanager
    def cursor(self, lock: bool = False, transaction: bool = False) \
        -> t.Iterator[sqlite3.Cursor]:
        """...."""
        start_transaction = transaction and not self.connection.in_transaction

        assert lock or not start_transaction

        try:
            if lock:
                self.lock.acquire()

            if self.current_cursor is not None:
                yield self.current_cursor
                return

            self.current_cursor = self.connection.cursor()

            if start_transaction:
                self.current_cursor.execute('BEGIN TRANSACTION;')

            try:
                yield self.current_cursor

                if start_transaction:
                    self.current_cursor.execute('COMMIT TRANSACTION;')
            except:
                if start_transaction:
                    self.current_cursor.execute('ROLLBACK TRANSACTION;')
                raise
        finally:
            self.current_cursor = None

            if lock:
                self.lock.release()

    def rebuild_structures(self, cursor: sqlite3.Cursor) -> None:
        """...."""
        ...