]> git.lizzy.rs Git - cheatdb.git/blob - app/models.py
5a4cfac1ea77948d7afeda1ffae2230f6a21c621
[cheatdb.git] / app / models.py
1 # Content DB
2 # Copyright (C) 2018  rubenwardy
3 #
4 # This program is free software: you can redistribute it and/or modify
5 # it under the terms of the GNU General Public License as published by
6 # the Free Software Foundation, either version 3 of the License, or
7 # (at your option) any later version.
8 #
9 # This program is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 # GNU General Public License for more details.
13 #
14 # You should have received a copy of the GNU General Public License
15 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
16
17
18 from flask import Flask, url_for
19 from flask_sqlalchemy import SQLAlchemy
20 from flask_migrate import Migrate
21 from urllib.parse import urlparse
22 from app import app
23 from datetime import datetime
24 from sqlalchemy.orm import validates
25 from flask_user import login_required, UserManager, UserMixin, SQLAlchemyAdapter
26 import enum
27
28 # Initialise database
29 db = SQLAlchemy(app)
30 migrate = Migrate(app, db)
31
32
33 class UserRank(enum.Enum):
34         BANNED         = 0
35         NOT_JOINED     = 1
36         NEW_MEMBER     = 2
37         MEMBER         = 3
38         TRUSTED_MEMBER = 4
39         EDITOR         = 5
40         MODERATOR      = 6
41         ADMIN          = 7
42
43         def atLeast(self, min):
44                 return self.value >= min.value
45
46         def getTitle(self):
47                 return self.name.replace("_", " ").title()
48
49         def toName(self):
50                 return self.name.lower()
51
52         def __str__(self):
53                 return self.name
54
55         @classmethod
56         def choices(cls):
57                 return [(choice, choice.getTitle()) for choice in cls]
58
59         @classmethod
60         def coerce(cls, item):
61                 return item if type(item) == UserRank else UserRank[item]
62
63
64 class Permission(enum.Enum):
65         EDIT_PACKAGE       = "EDIT_PACKAGE"
66         APPROVE_CHANGES    = "APPROVE_CHANGES"
67         DELETE_PACKAGE     = "DELETE_PACKAGE"
68         CHANGE_AUTHOR      = "CHANGE_AUTHOR"
69         MAKE_RELEASE       = "MAKE_RELEASE"
70         ADD_SCREENSHOTS    = "ADD_SCREENSHOTS"
71         APPROVE_SCREENSHOT = "APPROVE_SCREENSHOT"
72         APPROVE_RELEASE    = "APPROVE_RELEASE"
73         APPROVE_NEW        = "APPROVE_NEW"
74         CHANGE_RELEASE_URL = "CHANGE_RELEASE_URL"
75         CHANGE_DNAME       = "CHANGE_DNAME"
76         CHANGE_RANK        = "CHANGE_RANK"
77         CHANGE_EMAIL       = "CHANGE_EMAIL"
78         EDIT_EDITREQUEST   = "EDIT_EDITREQUEST"
79
80         # Only return true if the permission is valid for *all* contexts
81         # See Package.checkPerm for package-specific contexts
82         def check(self, user):
83                 if not user.is_authenticated:
84                         return False
85
86                 if self == Permission.APPROVE_NEW or \
87                                 self == Permission.APPROVE_CHANGES or \
88                                 self == Permission.APPROVE_RELEASE or \
89                                 self == Permission.APPROVE_SCREENSHOT:
90                         return user.rank.atLeast(UserRank.EDITOR)
91                 else:
92                         raise Exception("Non-global permission checked globally. Use Package.checkPerm or User.checkPerm instead.")
93
94
95 class User(db.Model, UserMixin):
96         id = db.Column(db.Integer, primary_key=True)
97
98         # User authentication information
99         username = db.Column(db.String(50), nullable=False, unique=True)
100         password = db.Column(db.String(255), nullable=True)
101         reset_password_token = db.Column(db.String(100), nullable=False, server_default="")
102
103         rank = db.Column(db.Enum(UserRank))
104
105         # Account linking
106         github_username = db.Column(db.String(50), nullable=True, unique=True)
107         forums_username = db.Column(db.String(50), nullable=True, unique=True)
108
109         # User email information
110         email = db.Column(db.String(255), nullable=True, unique=True)
111         confirmed_at = db.Column(db.DateTime())
112
113         # User information
114         active = db.Column("is_active", db.Boolean, nullable=False, server_default="0")
115         display_name = db.Column(db.String(100), nullable=False, server_default="")
116
117         # Content
118         notifications = db.relationship("Notification", primaryjoin="User.id==Notification.user_id")
119
120         # causednotifs  = db.relationship("Notification", backref="causer", lazy="dynamic")
121         packages      = db.relationship("Package", backref="author", lazy="dynamic")
122         requests      = db.relationship("EditRequest", backref="author", lazy="dynamic")
123
124         def __init__(self, username, active=False, email=None, password=None):
125                 import datetime
126
127                 self.username = username
128                 self.confirmed_at = datetime.datetime.now() - datetime.timedelta(days=6000)
129                 self.display_name = username
130                 self.active = active
131                 self.email = email
132                 self.password = password
133                 self.rank = UserRank.NOT_JOINED
134
135         def canAccessTodoList(self):
136                 return Permission.APPROVE_NEW.check(self) or \
137                                 Permission.APPROVE_RELEASE.check(self) or \
138                                 Permission.APPROVE_CHANGES.check(self)
139
140         def isClaimed(self):
141                 return self.rank.atLeast(UserRank.NEW_MEMBER)
142
143         def checkPerm(self, user, perm):
144                 if not user.is_authenticated:
145                         return False
146
147                 if type(perm) == str:
148                         perm = Permission[perm]
149                 elif type(perm) != Permission:
150                         raise Exception("Unknown permission given to User.checkPerm()")
151
152                 # Members can edit their own packages, and editors can edit any packages
153                 if perm == Permission.CHANGE_AUTHOR:
154                         return user.rank.atLeast(UserRank.EDITOR)
155                 elif perm == Permission.CHANGE_RANK or perm == Permission.CHANGE_DNAME:
156                         return user.rank.atLeast(UserRank.MODERATOR)
157                 elif perm == Permission.CHANGE_EMAIL:
158                         return user == self or (user.rank.atLeast(UserRank.MODERATOR) and user.rank.atLeast(self.rank))
159                 else:
160                         raise Exception("Permission {} is not related to users".format(perm.name))
161
162 class UserEmailVerification(db.Model):
163         id      = db.Column(db.Integer, primary_key=True)
164         user_id = db.Column(db.Integer, db.ForeignKey("user.id"))
165         email   = db.Column(db.String(100))
166         token   = db.Column(db.String(32))
167         user    = db.relationship("User", foreign_keys=[user_id])
168
169 class Notification(db.Model):
170         id        = db.Column(db.Integer, primary_key=True)
171         user_id   = db.Column(db.Integer, db.ForeignKey("user.id"))
172         causer_id = db.Column(db.Integer, db.ForeignKey("user.id"))
173         user      = db.relationship("User", foreign_keys=[user_id])
174         causer    = db.relationship("User", foreign_keys=[causer_id])
175
176         title     = db.Column(db.String(100), nullable=False)
177         url       = db.Column(db.String(200), nullable=True)
178
179         def __init__(self, us, cau, titl, ur):
180                 self.user   = us
181                 self.causer = cau
182                 self.title  = titl
183                 self.url    = ur
184
185
186 class License(db.Model):
187         id = db.Column(db.Integer, primary_key=True)
188         name = db.Column(db.String(50), nullable=False, unique=True)
189         packages = db.relationship("Package", backref="license", lazy="dynamic")
190
191         def __init__(self, v):
192                 self.name = v
193
194         def __str__(self):
195                 return self.name
196
197
198 class PackageType(enum.Enum):
199         MOD  = "Mod"
200         GAME = "Game"
201         TXP  = "Texture Pack"
202
203         def toName(self):
204                 return self.name.lower()
205
206         def __str__(self):
207                 return self.name
208
209         @classmethod
210         def choices(cls):
211                 return [(choice, choice.value) for choice in cls]
212
213         @classmethod
214         def coerce(cls, item):
215                 return item if type(item) == PackageType else PackageType[item]
216
217
218 class PackagePropertyKey(enum.Enum):
219         name         = "Name"
220         title        = "Title"
221         shortDesc    = "Short Description"
222         desc         = "Description"
223         type         = "Type"
224         license      = "License"
225         tags         = "Tags"
226         provides     = "Provides"
227         repo         = "Repository"
228         website      = "Website"
229         issueTracker = "Issue Tracker"
230         forums       = "Forum Topic ID"
231
232         def convert(self, value):
233                 if self == PackagePropertyKey.tags:
234                         return ",".join([t.title for t in value])
235                 elif self == PackagePropertyKey.provides:
236                         return ",".join([t.name for t in value])
237                 else:
238                         return str(value)
239
240 provides = db.Table("provides",
241         db.Column("package_id",    db.Integer, db.ForeignKey("package.id"), primary_key=True),
242     db.Column("metapackage_id", db.Integer, db.ForeignKey("meta_package.id"), primary_key=True)
243 )
244
245 tags = db.Table("tags",
246     db.Column("tag_id", db.Integer, db.ForeignKey("tag.id"), primary_key=True),
247     db.Column("package_id", db.Integer, db.ForeignKey("package.id"), primary_key=True)
248 )
249
250 class Dependency(db.Model):
251         id              = db.Column(db.Integer, primary_key=True)
252         depender_id     = db.Column(db.Integer, db.ForeignKey("package.id"),     nullable=True)
253         package_id      = db.Column(db.Integer, db.ForeignKey("package.id"),     nullable=True)
254         package         = db.relationship("Package", foreign_keys=[package_id])
255         meta_package_id = db.Column(db.Integer, db.ForeignKey("meta_package.id"), nullable=True)
256         optional        = db.Column(db.Boolean, nullable=False, default=False)
257         __table_args__  = (db.UniqueConstraint('depender_id', 'package_id', 'meta_package_id', name='_dependency_uc'), )
258
259         def __init__(self, depender=None, package=None, meta=None):
260                 if depender is None:
261                         return
262
263                 self.depender = depender
264
265                 packageProvided = package is not None
266                 metaProvided = meta is not None
267
268                 if packageProvided and not metaProvided:
269                         self.package = package
270                 elif metaProvided and not packageProvided:
271                         self.meta_package = meta
272                 else:
273                         raise Exception("Either meta or package must be given, but not both!")
274
275         def __str__(self):
276                 if self.package is not None:
277                         return self.package.author.username + "/" + self.package.name
278                 elif self.meta_package is not None:
279                         return self.meta_package.name
280                 else:
281                         raise Exception("Meta and package are both none!")
282
283         @staticmethod
284         def SpecToList(depender, spec, cache={}):
285                 retval = []
286                 arr = spec.split(",")
287
288                 import re
289                 pattern1 = re.compile("^([a-z0-9_]+)$")
290                 pattern2 = re.compile("^([A-Za-z0-9_]+)/([a-z0-9_]+)$")
291
292                 for x in arr:
293                         x = x.strip()
294                         if x == "":
295                                 continue
296
297                         if pattern1.match(x):
298                                 meta = MetaPackage.GetOrCreate(x, cache)
299                                 retval.append(Dependency(depender, meta=meta))
300                         else:
301                                 m = pattern2.match(x)
302                                 username = m.group(1)
303                                 name     = m.group(2)
304                                 user = User.query.filter_by(username=username).first()
305                                 if user is None:
306                                         raise Exception("Unable to find user " + username)
307
308                                 package = Package.query.filter_by(author=user, name=name).first()
309                                 if package is None:
310                                         raise Exception("Unable to find package " + name + " by " + username)
311
312                                 retval.append(Dependency(depender, package=package))
313
314                 return retval
315
316
317
318 class Package(db.Model):
319         id           = db.Column(db.Integer, primary_key=True)
320
321         # Basic details
322         author_id    = db.Column(db.Integer, db.ForeignKey("user.id"))
323         name         = db.Column(db.String(100), nullable=False)
324         title        = db.Column(db.String(100), nullable=False)
325         shortDesc    = db.Column(db.String(200), nullable=False)
326         desc         = db.Column(db.Text, nullable=True)
327         type         = db.Column(db.Enum(PackageType))
328         created_at   = db.Column(db.DateTime, nullable=False, default=datetime.utcnow)
329
330         license_id   = db.Column(db.Integer, db.ForeignKey("license.id"))
331
332         approved     = db.Column(db.Boolean, nullable=False, default=False)
333         soft_deleted = db.Column(db.Boolean, nullable=False, default=False)
334
335         # Downloads
336         repo         = db.Column(db.String(200), nullable=True)
337         website      = db.Column(db.String(200), nullable=True)
338         issueTracker = db.Column(db.String(200), nullable=True)
339         forums       = db.Column(db.Integer,     nullable=True)
340
341         provides = db.relationship("MetaPackage", secondary=provides, lazy="subquery",
342                         backref=db.backref("packages", lazy="dynamic"))
343
344         dependencies = db.relationship("Dependency", backref="depender", lazy="dynamic", foreign_keys=[Dependency.depender_id])
345
346         tags = db.relationship("Tag", secondary=tags, lazy="subquery",
347                         backref=db.backref("packages", lazy=True))
348
349         releases = db.relationship("PackageRelease", backref="package",
350                         lazy="dynamic", order_by=db.desc("package_release_releaseDate"))
351
352         screenshots = db.relationship("PackageScreenshot", backref="package",
353                         lazy="dynamic")
354
355         requests = db.relationship("EditRequest", backref="package",
356                         lazy="dynamic")
357
358         def __init__(self, package=None):
359                 if package is None:
360                         return
361
362                 self.author_id = package.author_id
363                 self.created_at = package.created_at
364                 self.approved = package.approved
365
366                 for e in PackagePropertyKey:
367                         setattr(self, e.name, getattr(package, e.name))
368
369         def getAsDictionary(self, base_url):
370                 return {
371                         "name": self.name,
372                         "title": self.title,
373                         "author": self.author.display_name,
374                         "shortDesc": self.shortDesc,
375                         "type": self.type.toName(),
376                         "license": self.license.name,
377                         "repo": self.repo,
378                         "url": base_url + self.getDownloadURL(),
379                         "release": self.getDownloadRelease().id if self.getDownloadRelease() is not None else None,
380                         "screenshots": [base_url + ss.url for ss in self.screenshots],
381                         "thumbnail": base_url + self.getThumbnailURL()
382                 }
383
384         def getThumbnailURL(self):
385                 screenshot = self.screenshots.filter_by(approved=True).first()
386                 return screenshot.getThumbnailURL() if screenshot is not None else None
387
388         def getMainScreenshotURL(self):
389                 screenshot = self.screenshots.filter_by(approved=True).first()
390                 return screenshot.url if screenshot is not None else None
391
392         def getDetailsURL(self):
393                 return url_for("package_page",
394                                 author=self.author.username, name=self.name)
395
396         def getEditURL(self):
397                 return url_for("create_edit_package_page",
398                                 author=self.author.username, name=self.name)
399
400         def getApproveURL(self):
401                 return url_for("approve_package_page",
402                                 author=self.author.username, name=self.name)
403
404         def getDeleteURL(self):
405                 return url_for("delete_package_page",
406                                 author=self.author.username, name=self.name)
407
408         def getNewScreenshotURL(self):
409                 return url_for("create_screenshot_page",
410                                 author=self.author.username, name=self.name)
411
412         def getCreateReleaseURL(self):
413                 return url_for("create_release_page",
414                                 author=self.author.username, name=self.name)
415
416         def getCreateEditRequestURL(self):
417                 return url_for("create_edit_editrequest_page",
418                                 author=self.author.username, name=self.name)
419
420         def getDownloadURL(self):
421                 return url_for("package_download_page",
422                                 author=self.author.username, name=self.name)
423
424         def getDownloadRelease(self):
425                 for rel in self.releases:
426                         if rel.approved:
427                                 return rel
428
429                 return None
430
431         def canImportScreenshot(self):
432                 if self.repo is None:
433                         return False
434
435                 url = urlparse(self.repo)
436                 if url.netloc == "github.com":
437                         return True
438
439                 return False
440
441         def canMakeReleaseFromVCS(self):
442                 if self.repo is None:
443                         return False
444
445                 url = urlparse(self.repo)
446                 if url.netloc == "github.com":
447                         return True
448
449                 return False
450
451         def checkPerm(self, user, perm):
452                 if not user.is_authenticated:
453                         return False
454
455                 if type(perm) == str:
456                         perm = Permission[perm]
457                 elif type(perm) != Permission:
458                         raise Exception("Unknown permission given to Package.checkPerm()")
459
460                 isOwner = user == self.author
461
462                 # Members can edit their own packages, and editors can edit any packages
463                 if perm == Permission.MAKE_RELEASE or perm == Permission.ADD_SCREENSHOTS:
464                         return isOwner or user.rank.atLeast(UserRank.EDITOR)
465
466                 if perm == Permission.EDIT_PACKAGE or perm == Permission.APPROVE_CHANGES:
467                         if isOwner:
468                                 return user.rank.atLeast(UserRank.MEMBER if self.approved else UserRank.NEW_MEMBER)
469                         else:
470                                 return user.rank.atLeast(UserRank.EDITOR)
471
472                 # Editors can change authors
473                 elif perm == Permission.CHANGE_AUTHOR:
474                         return user.rank.atLeast(UserRank.EDITOR)
475
476                 elif perm == Permission.APPROVE_NEW or perm == Permission.APPROVE_RELEASE \
477                                 or perm == Permission.APPROVE_SCREENSHOT:
478                         return user.rank.atLeast(UserRank.TRUSTED_MEMBER if isOwner else UserRank.EDITOR)
479
480                 # Moderators can delete packages
481                 elif perm == Permission.DELETE_PACKAGE or perm == Permission.CHANGE_RELEASE_URL:
482                         return user.rank.atLeast(UserRank.MODERATOR)
483
484                 else:
485                         raise Exception("Permission {} is not related to packages".format(perm.name))
486
487 class MetaPackage(db.Model):
488         id           = db.Column(db.Integer, primary_key=True)
489         name         = db.Column(db.String(100), unique=True, nullable=False)
490         dependencies = db.relationship("Dependency", backref="meta_package", lazy="dynamic")
491
492         def __init__(self, name=None):
493                 self.name = name
494
495         def __str__(self):
496                 return self.name
497
498         @staticmethod
499         def ListToSpec(list):
500                 return ",".join([str(x) for x in list])
501
502         @staticmethod
503         def GetOrCreate(name, cache={}):
504                 mp = cache.get(name)
505                 if mp is None:
506                         mp = MetaPackage.query.filter_by(name=name).first()
507
508                 if mp is None:
509                         mp = MetaPackage(name)
510                         db.session.add(mp)
511
512                 cache[name] = mp
513                 return mp
514
515         @staticmethod
516         def SpecToList(spec, cache={}):
517                 retval = []
518                 arr = spec.split(",")
519
520                 import re
521                 pattern = re.compile("^([a-z0-9_]+)$")
522
523                 for x in arr:
524                         x = x.strip()
525                         if x == "":
526                                 continue
527
528                         if not pattern.match(x):
529                                 continue
530
531                         retval.append(MetaPackage.GetOrCreate(x, cache))
532
533                 return retval
534
535 class Tag(db.Model):
536         id              = db.Column(db.Integer,    primary_key=True)
537         name            = db.Column(db.String(100), unique=True, nullable=False)
538         title           = db.Column(db.String(100), nullable=False)
539         backgroundColor = db.Column(db.String(6),   nullable=False)
540         textColor       = db.Column(db.String(6),   nullable=False)
541
542         def __init__(self, title, backgroundColor="000000", textColor="ffffff"):
543                 self.title           = title
544                 self.backgroundColor = backgroundColor
545                 self.textColor       = textColor
546
547                 import re
548                 regex = re.compile("[^a-z_]")
549                 self.name = regex.sub("", self.title.lower().replace(" ", "_"))
550
551 class PackageRelease(db.Model):
552         id           = db.Column(db.Integer, primary_key=True)
553
554         package_id   = db.Column(db.Integer, db.ForeignKey("package.id"))
555         title        = db.Column(db.String(100), nullable=False)
556         releaseDate  = db.Column(db.DateTime,        nullable=False)
557         url          = db.Column(db.String(200), nullable=False)
558         approved     = db.Column(db.Boolean, nullable=False, default=False)
559         task_id      = db.Column(db.String(37), nullable=True)
560
561
562         def getEditURL(self):
563                 return url_for("edit_release_page",
564                                 author=self.package.author.username,
565                                 name=self.package.name,
566                                 id=self.id)
567
568         def __init__(self):
569                 self.releaseDate = datetime.now()
570
571 class PackageScreenshot(db.Model):
572         id         = db.Column(db.Integer, primary_key=True)
573         package_id = db.Column(db.Integer, db.ForeignKey("package.id"))
574         title      = db.Column(db.String(100), nullable=False)
575         url        = db.Column(db.String(100), nullable=False)
576         approved   = db.Column(db.Boolean, nullable=False, default=False)
577
578
579         def getEditURL(self):
580                 return url_for("edit_screenshot_page",
581                                 author=self.package.author.username,
582                                 name=self.package.name,
583                                 id=self.id)
584
585         def getThumbnailURL(self):
586                 return self.url.replace("/uploads/", "/thumbnails/350x233/")
587
588 class EditRequest(db.Model):
589         id           = db.Column(db.Integer, primary_key=True)
590
591         package_id   = db.Column(db.Integer, db.ForeignKey("package.id"))
592         author_id    = db.Column(db.Integer, db.ForeignKey("user.id"))
593
594         title        = db.Column(db.String(100), nullable=False)
595         desc         = db.Column(db.String(1000), nullable=True)
596
597         # 0 - open
598         # 1 - merged
599         # 2 - rejected
600         status       = db.Column(db.Integer, nullable=False, default=0)
601
602         changes = db.relationship("EditRequestChange", backref="request",
603                         lazy="dynamic")
604
605         def getURL(self):
606                 return url_for("view_editrequest_page",
607                                 author=self.package.author.username,
608                                 name=self.package.name,
609                                 id=self.id)
610
611         def getApproveURL(self):
612                 return url_for("approve_editrequest_page",
613                                 author=self.package.author.username,
614                                 name=self.package.name,
615                                 id=self.id)
616
617         def getRejectURL(self):
618                 return url_for("reject_editrequest_page",
619                                 author=self.package.author.username,
620                                 name=self.package.name,
621                                 id=self.id)
622
623         def getEditURL(self):
624                 return url_for("create_edit_editrequest_page",
625                                 author=self.package.author.username,
626                                 name=self.package.name,
627                                 id=self.id)
628
629         def applyAll(self, package):
630                 for change in self.changes:
631                         change.apply(package)
632
633
634         def checkPerm(self, user, perm):
635                 if not user.is_authenticated:
636                         return False
637
638                 if type(perm) == str:
639                         perm = Permission[perm]
640                 elif type(perm) != Permission:
641                         raise Exception("Unknown permission given to EditRequest.checkPerm()")
642
643                 isOwner = user == self.author
644
645                 # Members can edit their own packages, and editors can edit any packages
646                 if perm == Permission.EDIT_EDITREQUEST:
647                         return isOwner or user.rank.atLeast(UserRank.EDITOR)
648
649                 else:
650                         raise Exception("Permission {} is not related to packages".format(perm.name))
651
652
653
654
655 class EditRequestChange(db.Model):
656         id           = db.Column(db.Integer, primary_key=True)
657
658         request_id   = db.Column(db.Integer, db.ForeignKey("edit_request.id"))
659         key          = db.Column(db.Enum(PackagePropertyKey), nullable=False)
660
661         # TODO: make diff instead
662         oldValue     = db.Column(db.Text, nullable=True)
663         newValue     = db.Column(db.Text, nullable=True)
664
665         def apply(self, package):
666                 if self.key == PackagePropertyKey.tags:
667                         package.tags.clear()
668                         for tagTitle in self.newValue.split(","):
669                                 tag = Tag.query.filter_by(title=tagTitle.strip()).first()
670                                 package.tags.append(tag)
671
672                 else:
673                         setattr(package, self.key.name, self.newValue)
674
675 # Setup Flask-User
676 db_adapter = SQLAlchemyAdapter(db, User)        # Register the User model
677 user_manager = UserManager(db_adapter, app)     # Initialize Flask-User