aboutsummaryrefslogtreecommitdiff
path: root/src/hydrilla/proxy/state_impl/concrete_state.py
blob: 0de67e0f910929a88f23188ecd459610dd077df8 (about) (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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
# SPDX-License-Identifier: GPL-3.0-or-later

# Haketilo proxy data and configuration (instantiatable HaketiloState subtype).
#
# 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 contains logic for keeping track of all settings, rules, mappings
and resources.
"""

# Enable using with Python 3.7.
from __future__ import annotations

import sqlite3
import secrets
import typing as t
import dataclasses as dc

from pathlib import Path

from ...exceptions import HaketiloException
from ...translations import smart_gettext as _
from ... import url_patterns
from ... import item_infos
from .. import state as st
from .. import policies
from .. import simple_dependency_satisfying as sds
from . import base
from . import mappings
from . import repos
from . import payloads
from . import _operations


here = Path(__file__).resolve().parent


@dc.dataclass(frozen=True, unsafe_hash=True)
class ConcreteRepoIterationRef(st.RepoIterationRef):
    pass


@dc.dataclass(frozen=True, unsafe_hash=True)
class ConcreteResourceRef(st.ResourceRef):
    pass


@dc.dataclass(frozen=True, unsafe_hash=True)
class ConcreteResourceVersionRef(st.ResourceVersionRef):
    pass

@dc.dataclass
class ConcreteHaketiloState(base.HaketiloStateWithFields):
    def __post_init__(self) -> None:
        sqlite3.enable_callback_tracebacks(True)

        self._prepare_database()

        self.rebuild_structures()

    def _prepare_database(self) -> None:
        """...."""
        cursor = self.connection.cursor()

        try:
            cursor.execute(
                '''
                SELECT
                        COUNT(name)
                FROM
                        sqlite_master
                WHERE
                        name = 'general' AND type = 'table';
                '''
            )

            (db_initialized,), = cursor.fetchall()

            if not db_initialized:
                cursor.executescript((here.parent / 'tables.sql').read_text())

            else:
                cursor.execute(
                    '''
                    SELECT
                            haketilo_version
                    FROM
                            general;
                    '''
                )

                (db_haketilo_version,) = cursor.fetchone()
                if db_haketilo_version != '3.0b1':
                    raise HaketiloException(_('err.proxy.unknown_db_schema'))

            cursor.execute('PRAGMA FOREIGN_KEYS;')
            if cursor.fetchall() == []:
                raise HaketiloException(_('err.proxy.no_sqlite_foreign_keys'))

            cursor.execute('PRAGMA FOREIGN_KEYS=ON;')
        finally:
            cursor.close()

    def import_items(self, malcontent_path: Path, repo_id: int = 1) -> None:
        with self.cursor(transaction=(repo_id == 1)) as cursor:
            # This method without the repo_id argument exposed is part of the
            # state API. As such, calls with repo_id = 1 (imports of local
            # semirepo packages) create a new transaction. Calls with different
            # values of repo_id are assumed to originate from within the state
            # implementation code and expect an existing transaction. Here, we
            # verify the transaction is indeed present.
            assert self.connection.in_transaction

            _operations._load_packages_no_state_update(
                cursor          = cursor,
                malcontent_path = malcontent_path,
                repo_id         = repo_id
            )

            self.rebuild_structures()

    def recompute_dependencies(
            self,
            extra_requirements: t.Iterable[sds.MappingRequirement] = [],
            prune_orphans:      bool                               = False,
    ) -> None:
        with self.cursor() as cursor:
            assert self.connection.in_transaction

            if prune_orphans:
                _operations.prune_packages(cursor)

            _operations._recompute_dependencies_no_state_update(
                cursor             = cursor,
                extra_requirements = extra_requirements
            )

            self.rebuild_structures()

    def pull_missing_files(self) -> None:
        with self.cursor() as cursor:
            assert self.connection.in_transaction

            _operations.pull_missing_files(cursor)

    def rebuild_structures(self) -> None:
        with self.cursor(transaction=True) as cursor:
            cursor.execute(
                '''
                SELECT
                        p.payload_id, p.pattern, p.eval_allowed,
                                p.cors_bypass_allowed,
                        ms.enabled,
                        i.identifier
                FROM
                             payloads         AS p
                        JOIN item_versions    AS iv
                                ON p.mapping_item_id = iv.item_version_id
                        JOIN items            AS i  USING (item_id)
                        JOIN mapping_statuses AS ms USING (item_id);
                '''
            )

        rows = cursor.fetchall()

        new_policy_tree = base.PolicyTree()

        ui_factory = policies.WebUIPolicyFactory(builtin=True)
        web_ui_pattern = 'http*://hkt.mitm.it/***'
        for parsed_pattern in url_patterns.parse_pattern(web_ui_pattern):
            new_policy_tree = new_policy_tree.register(
                parsed_pattern,
                ui_factory
            )

        new_payloads_data: dict[st.PayloadRef, st.PayloadData] = {}

        for row in rows:
            (payload_id_int, pattern, eval_allowed, cors_bypass_allowed,
             enabled_status,
             identifier) = row

            payload_ref = payloads.ConcretePayloadRef(str(payload_id_int), self)

            previous_data = self.payloads_data.get(payload_ref)
            if previous_data is not None:
                token = previous_data.unique_token
            else:
                token = secrets.token_urlsafe(8)

            payload_key = st.PayloadKey(payload_ref, identifier)

            for parsed_pattern in url_patterns.parse_pattern(pattern):
                new_policy_tree = new_policy_tree.register_payload(
                    parsed_pattern,
                    payload_key,
                    token
                )

                pattern_path_segments = parsed_pattern.path_segments

            payload_data = st.PayloadData(
                payload_ref           = payload_ref,
                explicitly_enabled    = enabled_status == 'E',
                unique_token          = token,
                pattern_path_segments = pattern_path_segments,
                eval_allowed          = eval_allowed,
                cors_bypass_allowed   = cors_bypass_allowed
            )

            new_payloads_data[payload_ref] = payload_data

        self.policy_tree   = new_policy_tree
        self.payloads_data = new_payloads_data

    def repo_store(self) -> st.RepoStore:
        return repos.ConcreteRepoStore(self)

    def get_repo_iteration(self, repo_iteration_id: str) -> st.RepoIterationRef:
        return ConcreteRepoIterationRef(repo_iteration_id)

    def mapping_store(self) -> st.MappingStore:
        return mappings.ConcreteMappingStore(self)

    def mapping_version_store(self) -> st.MappingVersionStore:
        return mappings.ConcreteMappingVersionStore(self)

    def get_resource(self, resource_id: str) -> st.ResourceRef:
        return ConcreteResourceRef(resource_id)

    def get_resource_version(self, resource_version_id: str) \
        -> st.ResourceVersionRef:
        return ConcreteResourceVersionRef(resource_version_id)

    def get_payload(self, payload_id: str) -> st.PayloadRef:
        raise NotImplementedError()

    def get_settings(self) -> st.HaketiloGlobalSettings:
        return st.HaketiloGlobalSettings(
            mapping_use_mode       = st.MappingUseMode.AUTO,
            default_allow_scripts  = True,
            repo_refresh_seconds   = 0
        )

    def update_settings(
            self,
            *,
            mapping_use_mode:      t.Optional[st.MappingUseMode] = None,
            default_allow_scripts: t.Optional[bool]              = None,
            repo_refresh_seconds:  t.Optional[int]               = None
    ) -> None:
        raise NotImplementedError()

    @staticmethod
    def make(store_dir: Path) -> 'ConcreteHaketiloState':
        connection = sqlite3.connect(
            str(store_dir / 'sqlite3.db'),
            isolation_level   = None,
            check_same_thread = False
        )
        return ConcreteHaketiloState(
            store_dir      = store_dir,
            connection     = connection
        )