forked from quay/quay
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdatabase.py
More file actions
2010 lines (1545 loc) · 62.1 KB
/
database.py
File metadata and controls
2010 lines (1545 loc) · 62.1 KB
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
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# pylint: disable=old-style-class,no-init
import inspect
import logging
import string
import sys
import time
import uuid
import os
from contextlib import contextmanager
from collections import defaultdict, namedtuple
from datetime import datetime
from random import SystemRandom
import toposort
from enum import IntEnum, Enum, unique
from peewee import *
from peewee import __exception_wrapper__, Function
from playhouse.pool import PooledMySQLDatabase, PooledPostgresqlDatabase, PooledSqliteDatabase
from sqlalchemy.engine.url import make_url
import resumablehashlib
from cachetools.func import lru_cache
from data.fields import (
ResumableSHA256Field,
ResumableSHA1Field,
JSONField,
Base64BinaryField,
FullIndexedTextField,
FullIndexedCharField,
EnumField as ClientEnumField,
EncryptedTextField,
EncryptedCharField,
CredentialField,
)
from data.decorators import deprecated_model
from data.text import match_mysql, match_like
from data.encryption import FieldEncrypter
from data.readreplica import ReadReplicaSupportedModel, ReadOnlyConfig, disallow_replica_use
from data.estimate import mysql_estimate_row_count, normal_row_count
from util.names import urn_generator
from util.validation import validate_postgres_precondition
logger = logging.getLogger(__name__)
DEFAULT_DB_CONNECT_TIMEOUT = 10 # seconds
# IMAGE_NOT_SCANNED_ENGINE_VERSION is the version found in security_indexed_engine when the
# image has not yet been scanned.
IMAGE_NOT_SCANNED_ENGINE_VERSION = -1
schemedriver = namedtuple("schemedriver", ["driver", "pooled_driver"])
_SCHEME_DRIVERS = {
"mysql": schemedriver(MySQLDatabase, PooledMySQLDatabase),
"mysql+pymysql": schemedriver(MySQLDatabase, PooledMySQLDatabase),
"sqlite": schemedriver(SqliteDatabase, PooledSqliteDatabase),
"postgresql": schemedriver(PostgresqlDatabase, PooledPostgresqlDatabase),
"postgresql+psycopg2": schemedriver(PostgresqlDatabase, PooledPostgresqlDatabase),
}
SCHEME_MATCH_FUNCTION = {
"mysql": match_mysql,
"mysql+pymysql": match_mysql,
"sqlite": match_like,
"postgresql": match_like,
"postgresql+psycopg2": match_like,
}
SCHEME_RANDOM_FUNCTION = {
"mysql": fn.Rand,
"mysql+pymysql": fn.Rand,
"sqlite": fn.Random,
"postgresql": fn.Random,
"postgresql+psycopg2": fn.Random,
}
SCHEME_ESTIMATOR_FUNCTION = {
"mysql": mysql_estimate_row_count,
"mysql+pymysql": mysql_estimate_row_count,
"sqlite": normal_row_count,
"postgresql": normal_row_count,
"postgresql+psycopg2": normal_row_count,
}
PRECONDITION_VALIDATION = {
"postgresql": validate_postgres_precondition,
"postgresql+psycopg2": validate_postgres_precondition,
}
_EXTRA_ARGS = {
"mysql": dict(charset="utf8mb4"),
"mysql+pymysql": dict(charset="utf8mb4"),
}
def pipes_concat(arg1, arg2, *extra_args):
"""
Concat function for sqlite, since it doesn't support fn.Concat.
Concatenates clauses with || characters.
"""
reduced = arg1.concat(arg2)
for arg in extra_args:
reduced = reduced.concat(arg)
return reduced
def function_concat(arg1, arg2, *extra_args):
"""
Default implementation of concat which uses fn.Concat().
Used by all database engines except sqlite.
"""
return fn.Concat(arg1, arg2, *extra_args)
SCHEME_SPECIALIZED_CONCAT = {
"sqlite": pipes_concat,
}
def real_for_update(query):
return query.for_update()
def null_for_update(query):
return query
def delete_instance_filtered(instance, model_class, delete_nullable, skip_transitive_deletes):
"""
Deletes the DB instance recursively, skipping any models in the skip_transitive_deletes set.
Callers *must* ensure that any models listed in the skip_transitive_deletes must be capable
of being directly deleted when the instance is deleted (with automatic sorting handling
dependency order) - for example, the Manifest and ManifestBlob tables for Repository will
always refer to the *same* repository when Manifest references ManifestBlob, so we can safely
skip transitive deletion for the Manifest table.
Callers *must* catch IntegrityError's raised, as this method will *not* delete the instance
under a transaction, to avoid locking the database.
"""
# We need to sort the ops so that models get cleaned in order of their dependencies
ops = reversed(list(instance.dependencies(delete_nullable)))
filtered_ops = []
dependencies = defaultdict(set)
for query, fk in ops:
# We only want to skip transitive deletes, which are done using subqueries in the form of
# DELETE FROM <table> in <subquery>. If an op is not using a subquery, we allow it to be
# applied directly.
if fk.model not in skip_transitive_deletes or query.op.lower() != "in":
filtered_ops.append((query, fk))
if query.op.lower() == "in":
dependencies[fk.model.__name__].add(query.rhs.model.__name__)
elif query.op == "=":
dependencies[fk.model.__name__].add(model_class.__name__)
else:
raise RuntimeError("Unknown operator in recursive repository delete query")
sorted_models = list(reversed(toposort.toposort_flatten(dependencies)))
def sorted_model_key(query_fk_tuple):
cmp_query, cmp_fk = query_fk_tuple
if cmp_query.op.lower() == "in":
return -1
return sorted_models.index(cmp_fk.model.__name__)
filtered_ops.sort(key=sorted_model_key)
# NOTE: We do not use a transaction here, as it can be a VERY long transaction, potentially
# locking up the database. Instead, we expect cleanup code to have run before this point, and
# if this fails with an IntegrityError, callers are expected to catch and retry.
for query, fk in filtered_ops:
_model = fk.model
if fk.null and not delete_nullable:
_model.update(**{fk.name: None}).where(query).execute()
else:
_model.delete().where(query).execute()
return instance.delete().where(instance._pk_expr()).execute()
SCHEME_SPECIALIZED_FOR_UPDATE = {
"sqlite": null_for_update,
}
class CallableProxy(Proxy):
def __call__(self, *args, **kwargs):
if self.obj is None:
raise AttributeError("Cannot use uninitialized Proxy.")
return self.obj(*args, **kwargs)
class RetryOperationalError(object):
def execute_sql(self, sql, params=None, commit=True):
try:
cursor = super(RetryOperationalError, self).execute_sql(sql, params, commit)
except OperationalError:
if not self.is_closed():
self.close()
with __exception_wrapper__:
cursor = self.cursor()
cursor.execute(sql, params or ())
if commit and not self.in_transaction():
self.commit()
return cursor
class CloseForLongOperation(object):
"""
Helper object which disconnects the database then reconnects after the nested operation
completes.
"""
def __init__(self, config_object):
self.config_object = config_object
def __enter__(self):
if self.config_object.get("TESTING") is True:
return
close_db_filter(None)
def __exit__(self, typ, value, traceback):
# Note: Nothing to do. The next SQL call will reconnect automatically.
pass
class UseThenDisconnect(object):
"""
Helper object for conducting work with a database and then tearing it down.
"""
def __init__(self, config_object):
self.config_object = config_object
def __enter__(self):
pass
def __exit__(self, typ, value, traceback):
if self.config_object.get("TESTING") is True:
return
close_db_filter(None)
class TupleSelector(object):
"""
Helper class for selecting tuples from a peewee query and easily accessing them as if they were
objects.
"""
class _TupleWrapper(object):
def __init__(self, data, fields):
self._data = data
self._fields = fields
def get(self, field):
return self._data[self._fields.index(TupleSelector.tuple_reference_key(field))]
@classmethod
def tuple_reference_key(cls, field):
"""
Returns a string key for referencing a field in a TupleSelector.
"""
if isinstance(field, Function):
return field.name + ",".join([cls.tuple_reference_key(arg) for arg in field.arguments])
if isinstance(field, Field):
return field.name + ":" + field.model.__name__
raise Exception("Unknown field type %s in TupleSelector" % field._node_type)
def __init__(self, query, fields):
self._query = query.select(*fields).tuples()
self._fields = [TupleSelector.tuple_reference_key(field) for field in fields]
def __iter__(self):
return self._build_iterator()
def _build_iterator(self):
for tuple_data in self._query:
yield TupleSelector._TupleWrapper(tuple_data, self._fields)
db = Proxy()
read_only_config = Proxy()
db_random_func = CallableProxy()
db_match_func = CallableProxy()
db_for_update = CallableProxy()
db_transaction = CallableProxy()
db_disallow_replica_use = CallableProxy()
db_concat_func = CallableProxy()
db_encrypter = Proxy()
db_count_estimator = CallableProxy()
ensure_under_transaction = CallableProxy()
def validate_database_url(url, db_kwargs, connect_timeout=5):
"""
Validates that we can connect to the given database URL, with the given kwargs.
Raises an exception if the validation fails.
"""
db_kwargs = db_kwargs.copy()
try:
driver = _db_from_url(
url, db_kwargs, connect_timeout=connect_timeout, allow_retry=False, allow_pooling=False
)
driver.connect()
finally:
try:
driver.close()
except:
pass
def validate_database_precondition(url, db_kwargs, connect_timeout=5):
"""
Validates that we can connect to the given database URL and the database meets our precondition.
Raises an exception if the validation fails.
"""
db_kwargs = db_kwargs.copy()
try:
driver = _db_from_url(
url, db_kwargs, connect_timeout=connect_timeout, allow_retry=False, allow_pooling=False
)
driver.connect()
pre_condition_check = PRECONDITION_VALIDATION.get(make_url(url).drivername)
if pre_condition_check:
pre_condition_check(driver)
finally:
try:
driver.close()
except:
pass
def _wrap_for_retry(driver):
return type("Retrying" + driver.__name__, (RetryOperationalError, driver), {})
def _db_from_url(
url,
db_kwargs,
connect_timeout=DEFAULT_DB_CONNECT_TIMEOUT,
allow_pooling=True,
allow_retry=True,
is_read_replica=False,
):
parsed_url = make_url(url)
if parsed_url.host:
db_kwargs["host"] = parsed_url.host
if parsed_url.port:
db_kwargs["port"] = parsed_url.port
if parsed_url.username:
db_kwargs["user"] = parsed_url.username
if parsed_url.password:
db_kwargs["password"] = parsed_url.password
# Remove threadlocals. It used to be required.
db_kwargs.pop("threadlocals", None)
# Note: sqlite does not support connect_timeout.
if parsed_url.drivername != "sqlite":
db_kwargs["connect_timeout"] = db_kwargs.get("connect_timeout", connect_timeout)
drivers = _SCHEME_DRIVERS[parsed_url.drivername]
driver = drivers.driver
if allow_pooling and os.getenv("DB_CONNECTION_POOLING", "false").lower() == "true":
driver = drivers.pooled_driver
db_kwargs["stale_timeout"] = db_kwargs.get("stale_timeout", None)
db_kwargs["max_connections"] = db_kwargs.get("max_connections", None)
logger.info(
"Connection pooling enabled for %s; stale timeout: %s; max connection count: %s",
parsed_url.drivername,
db_kwargs["stale_timeout"],
db_kwargs["max_connections"],
)
else:
logger.info("Connection pooling disabled for %s", parsed_url.drivername)
db_kwargs.pop("stale_timeout", None)
db_kwargs.pop("timeout", None)
db_kwargs.pop("max_connections", None)
for key, value in _EXTRA_ARGS.get(parsed_url.drivername, {}).iteritems():
if key not in db_kwargs:
db_kwargs[key] = value
if allow_retry:
driver = _wrap_for_retry(driver)
driver_autocommit = False
if db_kwargs.get("_driver_autocommit"):
assert is_read_replica, "_driver_autocommit can only be set for a read replica"
driver_autocommit = db_kwargs["_driver_autocommit"]
db_kwargs.pop("_driver_autocommit", None)
created = driver(parsed_url.database, **db_kwargs)
if driver_autocommit:
created.connect_params["autocommit"] = driver_autocommit
# Revert the behavior "fixed" in:
# https://github.com/coleifer/peewee/commit/36bd887ac07647c60dfebe610b34efabec675706
if parsed_url.drivername.find("mysql") >= 0:
created.compound_select_parentheses = 0
return created
def configure(config_object, testing=False):
logger.debug("Configuring database")
db_kwargs = dict(config_object["DB_CONNECTION_ARGS"])
write_db_uri = config_object["DB_URI"]
db.initialize(_db_from_url(write_db_uri, db_kwargs))
parsed_write_uri = make_url(write_db_uri)
db_random_func.initialize(SCHEME_RANDOM_FUNCTION[parsed_write_uri.drivername])
db_match_func.initialize(SCHEME_MATCH_FUNCTION[parsed_write_uri.drivername])
db_for_update.initialize(
SCHEME_SPECIALIZED_FOR_UPDATE.get(parsed_write_uri.drivername, real_for_update)
)
db_concat_func.initialize(
SCHEME_SPECIALIZED_CONCAT.get(parsed_write_uri.drivername, function_concat)
)
db_encrypter.initialize(FieldEncrypter(config_object.get("DATABASE_SECRET_KEY")))
db_count_estimator.initialize(SCHEME_ESTIMATOR_FUNCTION[parsed_write_uri.drivername])
read_replicas = config_object.get("DB_READ_REPLICAS", None)
is_read_only = config_object.get("REGISTRY_STATE", "normal") == "readonly"
read_replica_dbs = []
if read_replicas:
read_replica_dbs = [
_db_from_url(
ro_config["DB_URI"],
ro_config.get("DB_CONNECTION_ARGS", db_kwargs),
is_read_replica=True,
)
for ro_config in read_replicas
]
read_only_config.initialize(ReadOnlyConfig(is_read_only, read_replica_dbs))
def _db_transaction():
return config_object["DB_TRANSACTION_FACTORY"](db)
def _db_disallow_replica_use():
return disallow_replica_use(db)
@contextmanager
def _ensure_under_transaction():
if not testing and not config_object["TESTING"]:
if db.transaction_depth() == 0:
raise Exception("Expected to be under a transaction")
yield
db_transaction.initialize(_db_transaction)
db_disallow_replica_use.initialize(_db_disallow_replica_use)
ensure_under_transaction.initialize(_ensure_under_transaction)
def random_string_generator(length=16):
def random_string():
random = SystemRandom()
return "".join(
[random.choice(string.ascii_uppercase + string.digits) for _ in range(length)]
)
return random_string
def uuid_generator():
return str(uuid.uuid4())
get_epoch_timestamp = lambda: int(time.time())
get_epoch_timestamp_ms = lambda: int(time.time() * 1000)
def close_db_filter(_):
if db.obj is not None and not db.is_closed():
logger.debug("Disconnecting from database.")
db.close()
if read_only_config.obj is not None:
for read_replica in read_only_config.obj.read_replicas:
if not read_replica.is_closed():
logger.debug("Disconnecting from read replica.")
read_replica.close()
class QuayUserField(ForeignKeyField):
def __init__(self, allows_robots=False, robot_null_delete=False, *args, **kwargs):
self.allows_robots = allows_robots
self.robot_null_delete = robot_null_delete
if "model" not in kwargs:
kwargs["model"] = User
super(QuayUserField, self).__init__(*args, **kwargs)
@lru_cache(maxsize=16)
def _get_enum_field_values(enum_field):
values = []
for row in enum_field.rel_model.select():
key = getattr(row, enum_field.enum_key_field)
value = getattr(row, "id")
values.append((key, value))
return Enum(enum_field.rel_model.__name__, values)
class EnumField(ForeignKeyField):
"""
Create a cached python Enum from an EnumTable.
"""
def __init__(self, model, enum_key_field="name", *args, **kwargs):
"""
model is the EnumTable model-class (see ForeignKeyField) enum_key_field is the field from
the EnumTable to use as the enum name.
"""
self.enum_key_field = enum_key_field
super(EnumField, self).__init__(model, *args, **kwargs)
@property
def enum(self):
"""
Returns a python enun.Enum generated from the associated EnumTable.
"""
return _get_enum_field_values(self)
def get_id(self, name):
""" Returns the ForeignKeyId from the name field
Example:
>>> Repository.repo_kind.get_id("application")
2
"""
try:
return self.enum[name].value
except KeyError:
raise self.rel_model.DoesNotExist
def get_name(self, value):
""" Returns the name value from the ForeignKeyId
Example:
>>> Repository.repo_kind.get_name(2)
"application"
"""
try:
return self.enum(value).name
except ValueError:
raise self.rel_model.DoesNotExist
def deprecated_field(field, flag):
"""
Marks a field as deprecated and removes it from the peewee model if the flag is not set.
A flag is defined in the active_migration module and will be associated with one or more
migration phases.
"""
if ActiveDataMigration.has_flag(flag):
return field
return None
class BaseModel(ReadReplicaSupportedModel):
class Meta:
database = db
encrypter = db_encrypter
read_only_config = read_only_config
def __getattribute__(self, name):
"""
Adds _id accessors so that foreign key field IDs can be looked up without making a database
roundtrip.
"""
if name.endswith("_id"):
field_name = name[0 : len(name) - 3]
if field_name in self._meta.fields:
return self.__data__.get(field_name)
return super(BaseModel, self).__getattribute__(name)
class User(BaseModel):
uuid = CharField(default=uuid_generator, max_length=36, null=True, index=True)
username = CharField(unique=True, index=True)
password_hash = CharField(null=True)
email = CharField(unique=True, index=True, default=random_string_generator(length=64))
verified = BooleanField(default=False)
stripe_id = CharField(index=True, null=True)
organization = BooleanField(default=False, index=True)
robot = BooleanField(default=False, index=True)
invoice_email = BooleanField(default=False)
invalid_login_attempts = IntegerField(default=0)
last_invalid_login = DateTimeField(default=datetime.utcnow)
removed_tag_expiration_s = IntegerField(default=1209600) # Two weeks
enabled = BooleanField(default=True)
invoice_email_address = CharField(null=True, index=True)
given_name = CharField(null=True)
family_name = CharField(null=True)
company = CharField(null=True)
location = CharField(null=True)
maximum_queued_builds_count = IntegerField(null=True)
creation_date = DateTimeField(default=datetime.utcnow, null=True)
last_accessed = DateTimeField(null=True, index=True)
def delete_instance(self, recursive=False, delete_nullable=False):
# If we are deleting a robot account, only execute the subset of queries necessary.
if self.robot:
# For all the model dependencies, only delete those that allow robots.
for query, fk in reversed(list(self.dependencies(search_nullable=True))):
if isinstance(fk, QuayUserField) and fk.allows_robots:
_model = fk.model
if fk.robot_null_delete:
_model.update(**{fk.name: None}).where(query).execute()
else:
_model.delete().where(query).execute()
# Delete the instance itself.
super(User, self).delete_instance(recursive=False, delete_nullable=False)
else:
if not recursive:
raise RuntimeError("Non-recursive delete on user.")
# These models don't need to use transitive deletes, because the referenced objects
# are cleaned up directly in the model.
skip_transitive_deletes = (
{
Image,
Repository,
Team,
RepositoryBuild,
ServiceKeyApproval,
RepositoryBuildTrigger,
ServiceKey,
RepositoryPermission,
TeamMemberInvite,
Star,
RepositoryAuthorizedEmail,
TeamMember,
RepositoryTag,
PermissionPrototype,
DerivedStorageForImage,
TagManifest,
AccessToken,
OAuthAccessToken,
BlobUpload,
RepositoryNotification,
OAuthAuthorizationCode,
RepositoryActionCount,
TagManifestLabel,
TeamSync,
RepositorySearchScore,
DeletedNamespace,
DeletedRepository,
RepoMirrorRule,
NamespaceGeoRestriction,
ManifestSecurityStatus,
RepoMirrorConfig,
}
| appr_classes
| v22_classes
| transition_classes
)
delete_instance_filtered(self, User, delete_nullable, skip_transitive_deletes)
Namespace = User.alias()
class RobotAccountMetadata(BaseModel):
robot_account = QuayUserField(index=True, allows_robots=True, unique=True)
description = CharField()
unstructured_json = JSONField()
class RobotAccountToken(BaseModel):
robot_account = QuayUserField(index=True, allows_robots=True, unique=True)
token = EncryptedCharField(default_token_length=64)
fully_migrated = BooleanField(default=False)
class DeletedNamespace(BaseModel):
namespace = QuayUserField(index=True, allows_robots=False, unique=True)
marked = DateTimeField(default=datetime.now)
original_username = CharField(index=True)
original_email = CharField(index=True)
queue_id = CharField(null=True, index=True)
class NamespaceGeoRestriction(BaseModel):
namespace = QuayUserField(index=True, allows_robots=False)
added = DateTimeField(default=datetime.utcnow)
description = CharField()
unstructured_json = JSONField()
restricted_region_iso_code = CharField(index=True)
class Meta:
database = db
read_only_config = read_only_config
indexes = ((("namespace", "restricted_region_iso_code"), True),)
class UserPromptTypes(object):
CONFIRM_USERNAME = "confirm_username"
ENTER_NAME = "enter_name"
ENTER_COMPANY = "enter_company"
class UserPromptKind(BaseModel):
name = CharField(index=True)
class UserPrompt(BaseModel):
user = QuayUserField(allows_robots=False, index=True)
kind = ForeignKeyField(UserPromptKind)
class Meta:
database = db
read_only_config = read_only_config
indexes = ((("user", "kind"), True),)
class TeamRole(BaseModel):
name = CharField(index=True)
class Team(BaseModel):
name = CharField(index=True)
organization = QuayUserField(index=True)
role = EnumField(TeamRole)
description = TextField(default="")
class Meta:
database = db
read_only_config = read_only_config
indexes = (
# A team name must be unique within an organization
(("name", "organization"), True),
)
class TeamMember(BaseModel):
user = QuayUserField(allows_robots=True, index=True)
team = ForeignKeyField(Team)
class Meta:
database = db
read_only_config = read_only_config
indexes = (
# A user may belong to a team only once
(("user", "team"), True),
)
class TeamMemberInvite(BaseModel):
# Note: Either user OR email will be filled in, but not both.
user = QuayUserField(index=True, null=True)
email = CharField(null=True)
team = ForeignKeyField(Team)
inviter = ForeignKeyField(User, backref="inviter")
invite_token = CharField(default=urn_generator(["teaminvite"]))
class LoginService(BaseModel):
name = CharField(unique=True, index=True)
class TeamSync(BaseModel):
team = ForeignKeyField(Team, unique=True)
transaction_id = CharField()
last_updated = DateTimeField(null=True, index=True)
service = ForeignKeyField(LoginService)
config = JSONField()
class FederatedLogin(BaseModel):
user = QuayUserField(allows_robots=True, index=True)
service = ForeignKeyField(LoginService)
service_ident = CharField()
metadata_json = TextField(default="{}")
class Meta:
database = db
read_only_config = read_only_config
indexes = (
# create a unique index on service and the local service id
(("service", "service_ident"), True),
# a user may only have one federated login per service
(("service", "user"), True),
)
class Visibility(BaseModel):
name = CharField(index=True, unique=True)
class RepositoryKind(BaseModel):
name = CharField(index=True, unique=True)
@unique
class RepositoryState(IntEnum):
"""
Possible states of a repository.
NORMAL: Regular repo where all actions are possible
READ_ONLY: Only read actions, such as pull, are allowed regardless of specific user permissions
MIRROR: Equivalent to READ_ONLY except that mirror robot has write permission
MARKED_FOR_DELETION: Indicates the repository has been marked for deletion and should be hidden
and un-usable.
"""
NORMAL = 0
READ_ONLY = 1
MIRROR = 2
MARKED_FOR_DELETION = 3
class Repository(BaseModel):
namespace_user = QuayUserField(null=True)
name = FullIndexedCharField(match_function=db_match_func)
visibility = EnumField(Visibility)
description = FullIndexedTextField(match_function=db_match_func, null=True)
badge_token = CharField(default=uuid_generator)
kind = EnumField(RepositoryKind)
trust_enabled = BooleanField(default=False)
state = ClientEnumField(RepositoryState, default=RepositoryState.NORMAL)
class Meta:
database = db
read_only_config = read_only_config
indexes = (
# create a unique index on namespace and name
(("namespace_user", "name"), True),
)
def delete_instance(self, recursive=False, delete_nullable=False, force=False):
if not recursive:
raise RuntimeError("Non-recursive delete on repository.")
assert force or self.state == RepositoryState.MARKED_FOR_DELETION
# These models don't need to use transitive deletes, because the referenced objects
# are cleaned up directly
skip_transitive_deletes = (
{
RepositoryTag,
RepositoryBuild,
RepositoryBuildTrigger,
BlobUpload,
Image,
TagManifest,
TagManifestLabel,
Label,
DerivedStorageForImage,
RepositorySearchScore,
RepoMirrorConfig,
RepoMirrorRule,
DeletedRepository,
ManifestSecurityStatus,
}
| appr_classes
| v22_classes
| transition_classes
)
delete_instance_filtered(self, Repository, delete_nullable, skip_transitive_deletes)
class RepositorySearchScore(BaseModel):
repository = ForeignKeyField(Repository, unique=True)
score = BigIntegerField(index=True, default=0)
last_updated = DateTimeField(null=True)
class DeletedRepository(BaseModel):
repository = ForeignKeyField(Repository, unique=True)
marked = DateTimeField(default=datetime.now)
original_name = CharField(index=True)
queue_id = CharField(null=True, index=True)
class Star(BaseModel):
user = ForeignKeyField(User)
repository = ForeignKeyField(Repository)
created = DateTimeField(default=datetime.now)
class Meta:
database = db
read_only_config = read_only_config
indexes = (
# create a unique index on user and repository
(("user", "repository"), True),
)
class Role(BaseModel):
name = CharField(index=True, unique=True)
class RepositoryPermission(BaseModel):
team = ForeignKeyField(Team, null=True)
user = QuayUserField(allows_robots=True, null=True)
repository = ForeignKeyField(Repository)
role = ForeignKeyField(Role)
class Meta:
database = db
read_only_config = read_only_config
indexes = (
(("team", "repository"), True),
(("user", "repository"), True),
)
class PermissionPrototype(BaseModel):
org = QuayUserField(index=True, backref="orgpermissionproto")
uuid = CharField(default=uuid_generator, index=True)
activating_user = QuayUserField(
allows_robots=True, index=True, null=True, backref="userpermissionproto"
)
delegate_user = QuayUserField(allows_robots=True, backref="receivingpermission", null=True)
delegate_team = ForeignKeyField(Team, backref="receivingpermission", null=True)
role = ForeignKeyField(Role)
class Meta:
database = db
read_only_config = read_only_config
indexes = ((("org", "activating_user"), False),)
class AccessTokenKind(BaseModel):
name = CharField(unique=True, index=True)
class AccessToken(BaseModel):
friendly_name = CharField(null=True)
token_name = CharField(default=random_string_generator(length=32), unique=True, index=True)
token_code = EncryptedCharField(default_token_length=32)
repository = ForeignKeyField(Repository)
created = DateTimeField(default=datetime.now)
role = ForeignKeyField(Role)
temporary = BooleanField(default=True)
kind = ForeignKeyField(AccessTokenKind, null=True)
def get_code(self):
return self.token_name + self.token_code.decrypt()
class BuildTriggerService(BaseModel):
name = CharField(index=True, unique=True)
class DisableReason(BaseModel):
name = CharField(index=True, unique=True)
class RepositoryBuildTrigger(BaseModel):
uuid = CharField(default=uuid_generator, index=True)
service = ForeignKeyField(BuildTriggerService)
repository = ForeignKeyField(Repository)
connected_user = QuayUserField()
secure_auth_token = EncryptedCharField(null=True)
secure_private_key = EncryptedTextField(null=True)
fully_migrated = BooleanField(default=False)
config = TextField(default="{}")