]> git.lizzy.rs Git - cheatdb.git/blob - app/models.py
Add separate media license
[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
190         def __init__(self, v):
191                 self.name = v
192
193         def __str__(self):
194                 return self.name
195
196
197 class PackageType(enum.Enum):
198         MOD  = "Mod"
199         GAME = "Game"
200         TXP  = "Texture Pack"
201
202         def toName(self):
203                 return self.name.lower()
204
205         def __str__(self):
206                 return self.name
207
208         @classmethod
209         def choices(cls):
210                 return [(choice, choice.value) for choice in cls]
211
212         @classmethod
213         def coerce(cls, item):
214                 return item if type(item) == PackageType else PackageType[item]
215
216
217 class PackagePropertyKey(enum.Enum):
218         name         = "Name"
219         title        = "Title"
220         shortDesc    = "Short Description"
221         desc         = "Description"
222         type         = "Type"
223         license      = "License"
224         tags         = "Tags"
225         provides     = "Provides"
226         repo         = "Repository"
227         website      = "Website"
228         issueTracker = "Issue Tracker"
229         forums       = "Forum Topic ID"
230
231         def convert(self, value):
232                 if self == PackagePropertyKey.tags:
233                         return ",".join([t.title for t in value])
234                 elif self == PackagePropertyKey.provides:
235                         return ",".join([t.name for t in value])
236                 else:
237                         return str(value)
238
239 provides = db.Table("provides",
240         db.Column("package_id",    db.Integer, db.ForeignKey("package.id"), primary_key=True),
241     db.Column("metapackage_id", db.Integer, db.ForeignKey("meta_package.id"), primary_key=True)
242 )
243
244 tags = db.Table("tags",
245     db.Column("tag_id", db.Integer, db.ForeignKey("tag.id"), primary_key=True),
246     db.Column("package_id", db.Integer, db.ForeignKey("package.id"), primary_key=True)
247 )
248
249 class Dependency(db.Model):
250         id              = db.Column(db.Integer, primary_key=True)
251         depender_id     = db.Column(db.Integer, db.ForeignKey("package.id"),     nullable=True)
252         package_id      = db.Column(db.Integer, db.ForeignKey("package.id"),     nullable=True)
253         package         = db.relationship("Package", foreign_keys=[package_id])
254         meta_package_id = db.Column(db.Integer, db.ForeignKey("meta_package.id"), nullable=True)
255         optional        = db.Column(db.Boolean, nullable=False, default=False)
256         __table_args__  = (db.UniqueConstraint('depender_id', 'package_id', 'meta_package_id', name='_dependency_uc'), )
257
258         def __init__(self, depender=None, package=None, meta=None):
259                 if depender is None:
260                         return
261
262                 self.depender = depender
263
264                 packageProvided = package is not None
265                 metaProvided = meta is not None
266
267                 if packageProvided and not metaProvided:
268                         self.package = package
269                 elif metaProvided and not packageProvided:
270                         self.meta_package = meta
271                 else:
272                         raise Exception("Either meta or package must be given, but not both!")
273
274         def __str__(self):
275                 if self.package is not None:
276                         return self.package.author.username + "/" + self.package.name
277                 elif self.meta_package is not None:
278                         return self.meta_package.name
279                 else:
280                         raise Exception("Meta and package are both none!")
281
282         @staticmethod
283         def SpecToList(depender, spec, cache={}):
284                 retval = []
285                 arr = spec.split(",")
286
287                 import re
288                 pattern1 = re.compile("^([a-z0-9_]+)$")
289                 pattern2 = re.compile("^([A-Za-z0-9_]+)/([a-z0-9_]+)$")
290
291                 for x in arr:
292                         x = x.strip()
293                         if x == "":
294                                 continue
295
296                         if pattern1.match(x):
297                                 meta = MetaPackage.GetOrCreate(x, cache)
298                                 retval.append(Dependency(depender, meta=meta))
299                         else:
300                                 m = pattern2.match(x)
301                                 username = m.group(1)
302                                 name     = m.group(2)
303                                 user = User.query.filter_by(username=username).first()
304                                 if user is None:
305                                         raise Exception("Unable to find user " + username)
306
307                                 package = Package.query.filter_by(author=user, name=name).first()
308                                 if package is None:
309                                         raise Exception("Unable to find package " + name + " by " + username)
310
311                                 retval.append(Dependency(depender, package=package))
312
313                 return retval
314
315
316
317 class Package(db.Model):
318         id           = db.Column(db.Integer, primary_key=True)
319
320         # Basic details
321         author_id    = db.Column(db.Integer, db.ForeignKey("user.id"))
322         name         = db.Column(db.String(100), nullable=False)
323         title        = db.Column(db.String(100), nullable=False)
324         shortDesc    = db.Column(db.String(200), nullable=False)
325         desc         = db.Column(db.Text, nullable=True)
326         type         = db.Column(db.Enum(PackageType))
327         created_at   = db.Column(db.DateTime, nullable=False, default=datetime.utcnow)
328
329         license_id   = db.Column(db.Integer, db.ForeignKey("license.id"), nullable=False, default=1)
330         license      = db.relationship("License", foreign_keys=[license_id])
331         media_license_id = db.Column(db.Integer, db.ForeignKey("license.id"), nullable=False, default=1)
332         media_license    = db.relationship("License", foreign_keys=[media_license_id])
333
334         approved     = db.Column(db.Boolean, nullable=False, default=False)
335         soft_deleted = db.Column(db.Boolean, nullable=False, default=False)
336
337         # Downloads
338         repo         = db.Column(db.String(200), nullable=True)
339         website      = db.Column(db.String(200), nullable=True)
340         issueTracker = db.Column(db.String(200), nullable=True)
341         forums       = db.Column(db.Integer,     nullable=True)
342
343         provides = db.relationship("MetaPackage", secondary=provides, lazy="subquery",
344                         backref=db.backref("packages", lazy="dynamic"))
345
346         dependencies = db.relationship("Dependency", backref="depender", lazy="dynamic", foreign_keys=[Dependency.depender_id])
347
348         tags = db.relationship("Tag", secondary=tags, lazy="subquery",
349                         backref=db.backref("packages", lazy=True))
350
351         releases = db.relationship("PackageRelease", backref="package",
352                         lazy="dynamic", order_by=db.desc("package_release_releaseDate"))
353
354         screenshots = db.relationship("PackageScreenshot", backref="package",
355                         lazy="dynamic")
356
357         requests = db.relationship("EditRequest", backref="package",
358                         lazy="dynamic")
359
360         def __init__(self, package=None):
361                 if package is None:
362                         return
363
364                 self.author_id = package.author_id
365                 self.created_at = package.created_at
366                 self.approved = package.approved
367
368                 for e in PackagePropertyKey:
369                         setattr(self, e.name, getattr(package, e.name))
370
371         def getAsDictionary(self, base_url):
372                 return {
373                         "name": self.name,
374                         "title": self.title,
375                         "author": self.author.display_name,
376                         "shortDesc": self.shortDesc,
377                         "type": self.type.toName(),
378                         "license": self.license.name,
379                         "repo": self.repo,
380                         "url": base_url + self.getDownloadURL(),
381                         "release": self.getDownloadRelease().id if self.getDownloadRelease() is not None else None,
382                         "screenshots": [base_url + ss.url for ss in self.screenshots],
383                         "thumbnail": base_url + self.getThumbnailURL()
384                 }
385
386         def getThumbnailURL(self):
387                 screenshot = self.screenshots.filter_by(approved=True).first()
388                 return screenshot.getThumbnailURL() if screenshot is not None else None
389
390         def getMainScreenshotURL(self):
391                 screenshot = self.screenshots.filter_by(approved=True).first()
392                 return screenshot.url if screenshot is not None else None
393
394         def getDetailsURL(self):
395                 return url_for("package_page",
396                                 author=self.author.username, name=self.name)
397
398         def getEditURL(self):
399                 return url_for("create_edit_package_page",
400                                 author=self.author.username, name=self.name)
401
402         def getApproveURL(self):
403                 return url_for("approve_package_page",
404                                 author=self.author.username, name=self.name)
405
406         def getDeleteURL(self):
407                 return url_for("delete_package_page",
408                                 author=self.author.username, name=self.name)
409
410         def getNewScreenshotURL(self):
411                 return url_for("create_screenshot_page",
412                                 author=self.author.username, name=self.name)
413
414         def getCreateReleaseURL(self):
415                 return url_for("create_release_page",
416                                 author=self.author.username, name=self.name)
417
418         def getCreateEditRequestURL(self):
419                 return url_for("create_edit_editrequest_page",
420                                 author=self.author.username, name=self.name)
421
422         def getDownloadURL(self):
423                 return url_for("package_download_page",
424                                 author=self.author.username, name=self.name)
425
426         def getDownloadRelease(self):
427                 for rel in self.releases:
428                         if rel.approved:
429                                 return rel
430
431                 return None
432
433         def canImportScreenshot(self):
434                 if self.repo is None:
435                         return False
436
437                 url = urlparse(self.repo)
438                 if url.netloc == "github.com":
439                         return True
440
441                 return False
442
443         def canMakeReleaseFromVCS(self):
444                 if self.repo is None:
445                         return False
446
447                 url = urlparse(self.repo)
448                 if url.netloc == "github.com":
449                         return True
450
451                 return False
452
453         def checkPerm(self, user, perm):
454                 if not user.is_authenticated:
455                         return False
456
457                 if type(perm) == str:
458                         perm = Permission[perm]
459                 elif type(perm) != Permission:
460                         raise Exception("Unknown permission given to Package.checkPerm()")
461
462                 isOwner = user == self.author
463
464                 # Members can edit their own packages, and editors can edit any packages
465                 if perm == Permission.MAKE_RELEASE or perm == Permission.ADD_SCREENSHOTS:
466                         return isOwner or user.rank.atLeast(UserRank.EDITOR)
467
468                 if perm == Permission.EDIT_PACKAGE or perm == Permission.APPROVE_CHANGES:
469                         if isOwner:
470                                 return user.rank.atLeast(UserRank.MEMBER if self.approved else UserRank.NEW_MEMBER)
471                         else:
472                                 return user.rank.atLeast(UserRank.EDITOR)
473
474                 # Editors can change authors
475                 elif perm == Permission.CHANGE_AUTHOR:
476                         return user.rank.atLeast(UserRank.EDITOR)
477
478                 elif perm == Permission.APPROVE_NEW or perm == Permission.APPROVE_RELEASE \
479                                 or perm == Permission.APPROVE_SCREENSHOT:
480                         return user.rank.atLeast(UserRank.TRUSTED_MEMBER if isOwner else UserRank.EDITOR)
481
482                 # Moderators can delete packages
483                 elif perm == Permission.DELETE_PACKAGE or perm == Permission.CHANGE_RELEASE_URL:
484                         return user.rank.atLeast(UserRank.MODERATOR)
485
486                 else:
487                         raise Exception("Permission {} is not related to packages".format(perm.name))
488
489 class MetaPackage(db.Model):
490         id           = db.Column(db.Integer, primary_key=True)
491         name         = db.Column(db.String(100), unique=True, nullable=False)
492         dependencies = db.relationship("Dependency", backref="meta_package", lazy="dynamic")
493
494         def __init__(self, name=None):
495                 self.name = name
496
497         def __str__(self):
498                 return self.name
499
500         @staticmethod
501         def ListToSpec(list):
502                 return ",".join([str(x) for x in list])
503
504         @staticmethod
505         def GetOrCreate(name, cache={}):
506                 mp = cache.get(name)
507                 if mp is None:
508                         mp = MetaPackage.query.filter_by(name=name).first()
509
510                 if mp is None:
511                         mp = MetaPackage(name)
512                         db.session.add(mp)
513
514                 cache[name] = mp
515                 return mp
516
517         @staticmethod
518         def SpecToList(spec, cache={}):
519                 retval = []
520                 arr = spec.split(",")
521
522                 import re
523                 pattern = re.compile("^([a-z0-9_]+)$")
524
525                 for x in arr:
526                         x = x.strip()
527                         if x == "":
528                                 continue
529
530                         if not pattern.match(x):
531                                 continue
532
533                         retval.append(MetaPackage.GetOrCreate(x, cache))
534
535                 return retval
536
537 class Tag(db.Model):
538         id              = db.Column(db.Integer,    primary_key=True)
539         name            = db.Column(db.String(100), unique=True, nullable=False)
540         title           = db.Column(db.String(100), nullable=False)
541         backgroundColor = db.Column(db.String(6),   nullable=False)
542         textColor       = db.Column(db.String(6),   nullable=False)
543
544         def __init__(self, title, backgroundColor="000000", textColor="ffffff"):
545                 self.title           = title
546                 self.backgroundColor = backgroundColor
547                 self.textColor       = textColor
548
549                 import re
550                 regex = re.compile("[^a-z_]")
551                 self.name = regex.sub("", self.title.lower().replace(" ", "_"))
552
553 class PackageRelease(db.Model):
554         id           = db.Column(db.Integer, primary_key=True)
555
556         package_id   = db.Column(db.Integer, db.ForeignKey("package.id"))
557         title        = db.Column(db.String(100), nullable=False)
558         releaseDate  = db.Column(db.DateTime,        nullable=False)
559         url          = db.Column(db.String(200), nullable=False)
560         approved     = db.Column(db.Boolean, nullable=False, default=False)
561         task_id      = db.Column(db.String(37), nullable=True)
562
563
564         def getEditURL(self):
565                 return url_for("edit_release_page",
566                                 author=self.package.author.username,
567                                 name=self.package.name,
568                                 id=self.id)
569
570         def __init__(self):
571                 self.releaseDate = datetime.now()
572
573 class PackageScreenshot(db.Model):
574         id         = db.Column(db.Integer, primary_key=True)
575         package_id = db.Column(db.Integer, db.ForeignKey("package.id"))
576         title      = db.Column(db.String(100), nullable=False)
577         url        = db.Column(db.String(100), nullable=False)
578         approved   = db.Column(db.Boolean, nullable=False, default=False)
579
580
581         def getEditURL(self):
582                 return url_for("edit_screenshot_page",
583                                 author=self.package.author.username,
584                                 name=self.package.name,
585                                 id=self.id)
586
587         def getThumbnailURL(self):
588                 return self.url.replace("/uploads/", "/thumbnails/350x233/")
589
590 class EditRequest(db.Model):
591         id           = db.Column(db.Integer, primary_key=True)
592
593         package_id   = db.Column(db.Integer, db.ForeignKey("package.id"))
594         author_id    = db.Column(db.Integer, db.ForeignKey("user.id"))
595
596         title        = db.Column(db.String(100), nullable=False)
597         desc         = db.Column(db.String(1000), nullable=True)
598
599         # 0 - open
600         # 1 - merged
601         # 2 - rejected
602         status       = db.Column(db.Integer, nullable=False, default=0)
603
604         changes = db.relationship("EditRequestChange", backref="request",
605                         lazy="dynamic")
606
607         def getURL(self):
608                 return url_for("view_editrequest_page",
609                                 author=self.package.author.username,
610                                 name=self.package.name,
611                                 id=self.id)
612
613         def getApproveURL(self):
614                 return url_for("approve_editrequest_page",
615                                 author=self.package.author.username,
616                                 name=self.package.name,
617                                 id=self.id)
618
619         def getRejectURL(self):
620                 return url_for("reject_editrequest_page",
621                                 author=self.package.author.username,
622                                 name=self.package.name,
623                                 id=self.id)
624
625         def getEditURL(self):
626                 return url_for("create_edit_editrequest_page",
627                                 author=self.package.author.username,
628                                 name=self.package.name,
629                                 id=self.id)
630
631         def applyAll(self, package):
632                 for change in self.changes:
633                         change.apply(package)
634
635
636         def checkPerm(self, user, perm):
637                 if not user.is_authenticated:
638                         return False
639
640                 if type(perm) == str:
641                         perm = Permission[perm]
642                 elif type(perm) != Permission:
643                         raise Exception("Unknown permission given to EditRequest.checkPerm()")
644
645                 isOwner = user == self.author
646
647                 # Members can edit their own packages, and editors can edit any packages
648                 if perm == Permission.EDIT_EDITREQUEST:
649                         return isOwner or user.rank.atLeast(UserRank.EDITOR)
650
651                 else:
652                         raise Exception("Permission {} is not related to packages".format(perm.name))
653
654
655
656
657 class EditRequestChange(db.Model):
658         id           = db.Column(db.Integer, primary_key=True)
659
660         request_id   = db.Column(db.Integer, db.ForeignKey("edit_request.id"))
661         key          = db.Column(db.Enum(PackagePropertyKey), nullable=False)
662
663         # TODO: make diff instead
664         oldValue     = db.Column(db.Text, nullable=True)
665         newValue     = db.Column(db.Text, nullable=True)
666
667         def apply(self, package):
668                 if self.key == PackagePropertyKey.tags:
669                         package.tags.clear()
670                         for tagTitle in self.newValue.split(","):
671                                 tag = Tag.query.filter_by(title=tagTitle.strip()).first()
672                                 package.tags.append(tag)
673
674                 else:
675                         setattr(package, self.key.name, self.newValue)
676
677 # Setup Flask-User
678 db_adapter = SQLAlchemyAdapter(db, User)        # Register the User model
679 user_manager = UserManager(db_adapter, app)     # Initialize Flask-User