aboutsummaryrefslogtreecommitdiff
path: root/src/hydrilla/proxy/state_impl/repos.py
blob: 85117c86b1c8bf6ba15bbdb6b38a5f808b13166a (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
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
# SPDX-License-Identifier: GPL-3.0-or-later

# Haketilo proxy data and configuration (RepoRef and RepoStore subtypes).
#
# 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 of this
# code in a proprietary program, I am not going to enforce this in
# court.

"""
This module provides an interface to interact with repositories configured
inside Haketilo.
"""

# Enable using with Python 3.7.
from __future__ import annotations

import re
import json
import tempfile
import sqlite3
import typing as t
import dataclasses as dc

from urllib.parse import urlparse, urljoin
from datetime import datetime
from pathlib import Path

import requests

from ... import json_instances
from ... import item_infos
from ... import versions
from .. import state as st
from .. import simple_dependency_satisfying as sds
from . import base


repo_name_regex = re.compile(r'''
^
(?:
  []a-zA-Z0-9()<>^&$.!,?@#|;:%"'*{}[/_=+-]+ # allowed non-whitespace characters

  (?: # optional additional words separated by single spaces
    [ ]
    []a-zA-Z0-9()<>^&$.!,?@#|;:%"'*{}[/_=+-]+
  )*
)
$
''', re.VERBOSE)

def sanitize_repo_name(name: str) -> str:
    name = name.strip()

    if repo_name_regex.match(name) is None:
        raise st.RepoNameInvalid()

    return name


def sanitize_repo_url(url: str) -> str:
    try:
        parsed = urlparse(url)
    except:
        raise st.RepoUrlInvalid()

    if parsed.scheme not in ('http', 'https'):
        raise st.RepoUrlInvalid()

    if url[-1] != '/':
        url = url + '/'

    return url


def ensure_repo_not_deleted(cursor: sqlite3.Cursor, repo_id: str) -> None:
    cursor.execute(
        'SELECT deleted FROM repos WHERE repo_id = ?;',
        (repo_id,)
    )

    rows = cursor.fetchall()

    if rows == []:
        raise st.MissingItemError()

    (deleted,), = rows

    if deleted:
        raise st.MissingItemError()


def sync_remote_repo_definitions(repo_url: str, dest: Path) -> None:
    try:
        list_all_response = requests.get(urljoin(repo_url, 'list_all'))
        assert list_all_response.ok

        list_instance = list_all_response.json()
    except:
        raise st.RepoCommunicationError()

    try:
        json_instances.validate_instance(
            list_instance,
            'api_package_list-{}.schema.json'
        )
    except json_instances.UnknownSchemaError:
        raise st.RepoApiVersionUnsupported()
    except:
        raise st.RepoCommunicationError()

    ref: dict[str, t.Any]

    for item_type_name in ('resource', 'mapping'):
        for ref in list_instance[item_type_name + 's']:
            ver = versions.version_string(versions.normalize(ref['version']))
            item_rel_path = f'{item_type_name}/{ref["identifier"]}/{ver}'

            try:
                item_response = requests.get(urljoin(repo_url, item_rel_path))
                assert item_response.ok
            except:
                raise st.RepoCommunicationError()

            item_path = dest / item_rel_path
            item_path.parent.mkdir(parents=True, exist_ok=True)
            item_path.write_bytes(item_response.content)


def make_repo_display_info(
        ref:            st.RepoRef,
        name:           str,
        url:            str,
        deleted:        bool,
        last_refreshed: t.Optional[int],
        resource_count: int,
        mapping_count:  int
) -> st.RepoDisplayInfo:
        last_refreshed_converted: t.Optional[datetime] = None
        if last_refreshed is not None:
            last_refreshed_converted = datetime.fromtimestamp(last_refreshed)

        return st.RepoDisplayInfo(
            ref               = ref,
            is_local_semirepo = ref.id == '1',
            name              = name,
            url               = url,
            deleted           = deleted,
            last_refreshed    = last_refreshed_converted,
            resource_count    = resource_count,
            mapping_count     = mapping_count
        )


@dc.dataclass(frozen=True, unsafe_hash=True)
class ConcreteRepoRef(st.RepoRef):
    """...."""
    state: base.HaketiloStateWithFields = dc.field(hash=False, compare=False)

    def remove(self) -> None:
        with self.state.cursor(transaction=True) as cursor:
            ensure_repo_not_deleted(cursor, self.id)

            cursor.execute(
                '''
                UPDATE
                        repos
                SET
                        deleted             = TRUE,
                        url                 = '',
                        active_iteration_id = NULL,
                        last_refreshed      = NULL
                WHERE
                        repo_id = ?;
                ''',
                (self.id,)
            )

            self.state.soft_prune_orphan_items()
            self.state.recompute_dependencies()

    def update(
            self,
            *,
            name: t.Optional[str] = None,
            url:  t.Optional[str] = None
    ) -> None:
        if name is not None:
            if name.isspace():
                raise st.RepoNameInvalid()

            name = sanitize_repo_name(name)

        if url is not None:
            if url.isspace():
                raise st.RepoUrlInvalid()

            url = sanitize_repo_url(url)

        if name is None and url is None:
            return

        with self.state.cursor(transaction=True) as cursor:
            ensure_repo_not_deleted(cursor, self.id)

            if url is not None:
                cursor.execute(
                    'UPDATE repos SET url = ? WHERE repo_id = ?;',
                    (url, self.id)
                )

            if name is not None:
                try:
                    cursor.execute(
                        'UPDATE repos SET name = ? WHERE repo_id = ?;',
                        (name, self.id)
                    )
                except sqlite3.IntegrityError:
                    raise st.RepoNameTaken()

                self.state.rebuild_structures(rules=False)

    def refresh(self) -> None:
        with self.state.cursor(transaction=True) as cursor:
            ensure_repo_not_deleted(cursor, self.id)

            cursor.execute(
                'SELECT url FROM repos WHERE repo_id = ?;',
                (self.id,)
            )

            (repo_url,), = cursor.fetchall()

            with tempfile.TemporaryDirectory() as tmpdir_str:
                tmpdir = Path(tmpdir_str)
                sync_remote_repo_definitions(repo_url, tmpdir)
                self.state.import_items(tmpdir, int(self.id))

    def get_display_info(self) -> st.RepoDisplayInfo:
        with self.state.cursor() as cursor:
            cursor.execute(
                '''
                SELECT
                        name, url, deleted, last_refreshed,
                        resource_count, mapping_count
                FROM
                        repo_display_infos
                WHERE
                        repo_id = ?;
                ''',
                (self.id,)
            )

            rows = cursor.fetchall()

        if rows == []:
            raise st.MissingItemError()

        row, = rows

        return make_repo_display_info(self, *row)


@dc.dataclass(frozen=True)
class ConcreteRepoStore(st.RepoStore):
    state: base.HaketiloStateWithFields

    def get(self, id: str) -> st.RepoRef:
        return ConcreteRepoRef(str(int(id)), self.state)

    def add(self, name: str, url: str) -> st.RepoRef:
        name = name.strip()
        if repo_name_regex.match(name) is None:
            raise st.RepoNameInvalid()

        url = sanitize_repo_url(url)

        with self.state.cursor(transaction=True) as cursor:
            cursor.execute(
                '''
                SELECT
                        COUNT(repo_id)
                FROM
                        repos
                WHERE
                        NOT deleted AND name = ?;
                ''',
                (name,)
            )
            (name_taken,), = cursor.fetchall()

            if name_taken:
                raise st.RepoNameTaken()

            cursor.execute(
                '''
                INSERT INTO repos(name, url)
                VALUES (?, ?)
                ON CONFLICT (name)
                DO UPDATE SET
                        name           = excluded.name,
                        url            = excluded.url,
                        deleted        = FALSE,
                        last_refreshed = NULL;
                ''',
                (name, url)
            )

            cursor.execute('SELECT repo_id FROM repos WHERE name = ?;', (name,))

            (repo_id,), = cursor.fetchall()

            return ConcreteRepoRef(str(repo_id), self.state)

    def get_display_infos(self, include_deleted: bool = False) \
        -> t.Sequence[st.RepoDisplayInfo]:
        with self.state.cursor() as cursor:
            condition: str = 'TRUE'
            if include_deleted:
                condition = 'COALESCE(deleted = FALSE, TRUE)'

            cursor.execute(
                f'''
                SELECT
                        repo_id, name, url, deleted, last_refreshed,
                        resource_count, mapping_count
                FROM
                        repo_display_infos
                WHERE
                        {condition}
                ORDER BY
                        repo_id != 1, name;
                '''
            )

            all_rows = cursor.fetchall()

        assert len(all_rows) > 0 and all_rows[0][0] == 1

        result = []
        for row in all_rows:
            repo_id, *rest = row

            ref = ConcreteRepoRef(str(repo_id), self.state)

            result.append(make_repo_display_info(ref, *rest))

        return result