2 # Copyright (C) 2018 rubenwardy
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.
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.
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/>.
20 from app import app, gravatar
21 from urllib.parse import urlparse
23 from flask import Flask, url_for
24 from flask_sqlalchemy import SQLAlchemy, BaseQuery
25 from flask_migrate import Migrate
26 from flask_user import login_required, UserManager, UserMixin
27 from sqlalchemy import func, CheckConstraint
28 from sqlalchemy_searchable import SearchQueryMixin
29 from sqlalchemy_utils.types import TSVectorType
30 from sqlalchemy_searchable import make_searchable
35 migrate = Migrate(app, db)
36 make_searchable(db.metadata)
39 class ArticleQuery(BaseQuery, SearchQueryMixin):
43 class UserRank(enum.Enum):
53 def atLeast(self, min):
54 return self.value >= min.value
57 return self.name.replace("_", " ").title()
60 return self.name.lower()
67 return [(choice, choice.getTitle()) for choice in cls]
70 def coerce(cls, item):
71 return item if type(item) == UserRank else UserRank[item]
74 class Permission(enum.Enum):
75 EDIT_PACKAGE = "EDIT_PACKAGE"
76 APPROVE_CHANGES = "APPROVE_CHANGES"
77 DELETE_PACKAGE = "DELETE_PACKAGE"
78 CHANGE_AUTHOR = "CHANGE_AUTHOR"
79 CHANGE_NAME = "CHANGE_NAME"
80 MAKE_RELEASE = "MAKE_RELEASE"
81 DELETE_RELEASE = "DELETE_RELEASE"
82 ADD_SCREENSHOTS = "ADD_SCREENSHOTS"
83 APPROVE_SCREENSHOT = "APPROVE_SCREENSHOT"
84 APPROVE_RELEASE = "APPROVE_RELEASE"
85 APPROVE_NEW = "APPROVE_NEW"
86 CHANGE_RELEASE_URL = "CHANGE_RELEASE_URL"
87 CHANGE_USERNAMES = "CHANGE_USERNAMES"
88 CHANGE_RANK = "CHANGE_RANK"
89 CHANGE_EMAIL = "CHANGE_EMAIL"
90 EDIT_EDITREQUEST = "EDIT_EDITREQUEST"
91 SEE_THREAD = "SEE_THREAD"
92 CREATE_THREAD = "CREATE_THREAD"
93 COMMENT_THREAD = "COMMENT_THREAD"
94 LOCK_THREAD = "LOCK_THREAD"
95 DELETE_REPLY = "DELETE_REPLY"
96 EDIT_REPLY = "EDIT_REPLY"
97 UNAPPROVE_PACKAGE = "UNAPPROVE_PACKAGE"
98 TOPIC_DISCARD = "TOPIC_DISCARD"
99 CREATE_TOKEN = "CREATE_TOKEN"
100 EDIT_MAINTAINERS = "EDIT_MAINTAINERS"
101 CHANGE_PROFILE_URLS = "CHANGE_PROFILE_URLS"
103 # Only return true if the permission is valid for *all* contexts
104 # See Package.checkPerm for package-specific contexts
105 def check(self, user):
106 if not user.is_authenticated:
109 if self == Permission.APPROVE_NEW or \
110 self == Permission.APPROVE_CHANGES or \
111 self == Permission.APPROVE_RELEASE or \
112 self == Permission.APPROVE_SCREENSHOT or \
113 self == Permission.SEE_THREAD:
114 return user.rank.atLeast(UserRank.EDITOR)
116 raise Exception("Non-global permission checked globally. Use Package.checkPerm or User.checkPerm instead.")
118 def display_name_default(context):
119 return context.get_current_parameters()["username"]
121 class User(db.Model, UserMixin):
122 id = db.Column(db.Integer, primary_key=True)
124 # User authentication information
125 username = db.Column(db.String(50, collation="NOCASE"), nullable=False, unique=True, index=True)
126 password = db.Column(db.String(255), nullable=False, server_default="")
127 reset_password_token = db.Column(db.String(100), nullable=False, server_default="")
129 rank = db.Column(db.Enum(UserRank))
132 github_username = db.Column(db.String(50, collation="NOCASE"), nullable=True, unique=True)
133 forums_username = db.Column(db.String(50, collation="NOCASE"), nullable=True, unique=True)
135 # Access token for webhook setup
136 github_access_token = db.Column(db.String(50), nullable=True, server_default=None)
138 # User email information
139 email = db.Column(db.String(255), nullable=True, unique=True)
140 email_confirmed_at = db.Column(db.DateTime())
143 profile_pic = db.Column(db.String(255), nullable=True, server_default=None)
144 active = db.Column("is_active", db.Boolean, nullable=False, server_default="0")
145 display_name = db.Column(db.String(100), nullable=False, default=display_name_default)
148 website_url = db.Column(db.String(255), nullable=True, default=None)
149 donate_url = db.Column(db.String(255), nullable=True, default=None)
152 notifications = db.relationship("Notification", primaryjoin="User.id==Notification.user_id")
154 # causednotifs = db.relationship("Notification", backref="causer", lazy="dynamic")
155 packages = db.relationship("Package", backref=db.backref("author", lazy="joined"), lazy="dynamic")
156 requests = db.relationship("EditRequest", backref="author", lazy="dynamic")
157 threads = db.relationship("Thread", backref="author", lazy="dynamic")
158 tokens = db.relationship("APIToken", backref="owner", lazy="dynamic")
159 replies = db.relationship("ThreadReply", backref="author", lazy="dynamic")
161 def __init__(self, username=None, active=False, email=None, password=""):
162 self.username = username
163 self.email_confirmed_at = datetime.datetime.now() - datetime.timedelta(days=6000)
164 self.display_name = username
167 self.password = password
168 self.rank = UserRank.NOT_JOINED
170 def hasPassword(self):
171 return self.password != ""
173 def canAccessTodoList(self):
174 return Permission.APPROVE_NEW.check(self) or \
175 Permission.APPROVE_RELEASE.check(self) or \
176 Permission.APPROVE_CHANGES.check(self)
179 return self.rank.atLeast(UserRank.NEW_MEMBER)
181 def getProfilePicURL(self):
183 return self.profile_pic
185 return gravatar(self.email or "")
187 def checkPerm(self, user, perm):
188 if not user.is_authenticated:
191 if type(perm) == str:
192 perm = Permission[perm]
193 elif type(perm) != Permission:
194 raise Exception("Unknown permission given to User.checkPerm()")
196 # Members can edit their own packages, and editors can edit any packages
197 if perm == Permission.CHANGE_AUTHOR:
198 return user.rank.atLeast(UserRank.EDITOR)
199 elif perm == Permission.CHANGE_RANK or perm == Permission.CHANGE_USERNAMES:
200 return user.rank.atLeast(UserRank.MODERATOR)
201 elif perm == Permission.CHANGE_EMAIL or perm == Permission.CHANGE_PROFILE_URLS:
202 return user == self or (user.rank.atLeast(UserRank.MODERATOR) and user.rank.atLeast(self.rank))
203 elif perm == Permission.CREATE_TOKEN:
205 return user.rank.atLeast(UserRank.MEMBER)
207 return user.rank.atLeast(UserRank.MODERATOR) and user.rank.atLeast(self.rank)
209 raise Exception("Permission {} is not related to users".format(perm.name))
211 def canCommentRL(self):
212 one_min_ago = datetime.datetime.utcnow() - datetime.timedelta(minutes=1)
213 if ThreadReply.query.filter_by(author=self) \
214 .filter(ThreadReply.created_at > one_min_ago).count() >= 3:
217 hour_ago = datetime.datetime.utcnow() - datetime.timedelta(hours=1)
218 if ThreadReply.query.filter_by(author=self) \
219 .filter(ThreadReply.created_at > hour_ago).count() >= 20:
224 def canOpenThreadRL(self):
225 hour_ago = datetime.datetime.utcnow() - datetime.timedelta(hours=1)
226 return Thread.query.filter_by(author=self) \
227 .filter(Thread.created_at > hour_ago).count() < 2
229 def __eq__(self, other):
233 if not self.is_authenticated or not other.is_authenticated:
237 return self.id == other.id
239 class UserEmailVerification(db.Model):
240 id = db.Column(db.Integer, primary_key=True)
241 user_id = db.Column(db.Integer, db.ForeignKey("user.id"))
242 email = db.Column(db.String(100))
243 token = db.Column(db.String(32))
244 user = db.relationship("User", foreign_keys=[user_id])
246 class Notification(db.Model):
247 id = db.Column(db.Integer, primary_key=True)
249 user_id = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
250 user = db.relationship("User", foreign_keys=[user_id])
252 causer_id = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
253 causer = db.relationship("User", foreign_keys=[causer_id])
255 title = db.Column(db.String(100), nullable=False)
256 url = db.Column(db.String(200), nullable=True)
258 package_id = db.Column(db.Integer, db.ForeignKey("package.id"), nullable=True)
259 package = db.relationship("Package", foreign_keys=[package_id])
261 created_at = db.Column(db.DateTime, nullable=True, default=datetime.datetime.utcnow)
263 def __init__(self, user, causer, title, url, package=None):
265 title = title[:99] + "…"
271 self.package = package
274 class License(db.Model):
275 id = db.Column(db.Integer, primary_key=True)
276 name = db.Column(db.String(50), nullable=False, unique=True)
277 is_foss = db.Column(db.Boolean, nullable=False, default=True)
279 def __init__(self, v, is_foss=True):
281 self.is_foss = is_foss
287 class PackageType(enum.Enum):
293 return self.name.lower()
301 return PackageType[name.upper()]
307 return [(choice, choice.value) for choice in cls]
310 def coerce(cls, item):
311 return item if type(item) == PackageType else PackageType[item]
314 class PackagePropertyKey(enum.Enum):
317 short_desc = "Short Description"
321 media_license = "Media License"
323 provides = "Provides"
326 issueTracker = "Issue Tracker"
327 forums = "Forum Topic ID"
329 def convert(self, value):
330 if self == PackagePropertyKey.tags:
331 return ",".join([t.title for t in value])
332 elif self == PackagePropertyKey.provides:
333 return ",".join([t.name for t in value])
337 provides = db.Table("provides",
338 db.Column("package_id", db.Integer, db.ForeignKey("package.id"), primary_key=True),
339 db.Column("metapackage_id", db.Integer, db.ForeignKey("meta_package.id"), primary_key=True)
342 tags = db.Table("tags",
343 db.Column("tag_id", db.Integer, db.ForeignKey("tag.id"), primary_key=True),
344 db.Column("package_id", db.Integer, db.ForeignKey("package.id"), primary_key=True)
347 maintainers = db.Table("maintainers",
348 db.Column("user_id", db.Integer, db.ForeignKey("user.id"), primary_key=True),
349 db.Column("package_id", db.Integer, db.ForeignKey("package.id"), primary_key=True)
352 class Dependency(db.Model):
353 id = db.Column(db.Integer, primary_key=True)
354 depender_id = db.Column(db.Integer, db.ForeignKey("package.id"), nullable=True)
355 package_id = db.Column(db.Integer, db.ForeignKey("package.id"), nullable=True)
356 package = db.relationship("Package", foreign_keys=[package_id])
357 meta_package_id = db.Column(db.Integer, db.ForeignKey("meta_package.id"), nullable=True)
358 optional = db.Column(db.Boolean, nullable=False, default=False)
359 __table_args__ = (db.UniqueConstraint("depender_id", "package_id", "meta_package_id", name="_dependency_uc"), )
361 def __init__(self, depender=None, package=None, meta=None):
365 self.depender = depender
367 packageProvided = package is not None
368 metaProvided = meta is not None
370 if packageProvided and not metaProvided:
371 self.package = package
372 elif metaProvided and not packageProvided:
373 self.meta_package = meta
375 raise Exception("Either meta or package must be given, but not both!")
378 if self.meta_package:
379 return self.meta_package.name
381 return self.package.name
386 if self.package is not None:
387 return self.package.author.username + "/" + self.package.name
388 elif self.meta_package is not None:
389 return self.meta_package.name
391 raise Exception("Meta and package are both none!")
394 def SpecToList(depender, spec, cache={}):
396 arr = spec.split(",")
399 pattern1 = re.compile("^([a-z0-9_]+)$")
400 pattern2 = re.compile("^([A-Za-z0-9_]+)/([a-z0-9_]+)$")
407 if pattern1.match(x):
408 meta = MetaPackage.GetOrCreate(x, cache)
409 retval.append(Dependency(depender, meta=meta))
411 m = pattern2.match(x)
412 username = m.group(1)
414 user = User.query.filter_by(username=username).first()
416 raise Exception("Unable to find user " + username)
418 package = Package.query.filter_by(author=user, name=name).first()
420 raise Exception("Unable to find package " + name + " by " + username)
422 retval.append(Dependency(depender, package=package))
427 class Package(db.Model):
428 query_class = ArticleQuery
430 id = db.Column(db.Integer, primary_key=True)
433 author_id = db.Column(db.Integer, db.ForeignKey("user.id"))
434 name = db.Column(db.Unicode(100), nullable=False)
435 title = db.Column(db.Unicode(100), nullable=False)
436 short_desc = db.Column(db.Unicode(200), nullable=False)
437 desc = db.Column(db.UnicodeText, nullable=True)
438 type = db.Column(db.Enum(PackageType))
439 created_at = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
441 name_valid = db.CheckConstraint("name ~* '^[a-z0-9_]+$'")
443 search_vector = db.Column(TSVectorType("name", "title", "short_desc", "desc", \
444 weights={ "name": "A", "title": "B", "short_desc": "C", "desc": "D" }))
446 license_id = db.Column(db.Integer, db.ForeignKey("license.id"), nullable=False, default=1)
447 license = db.relationship("License", foreign_keys=[license_id])
448 media_license_id = db.Column(db.Integer, db.ForeignKey("license.id"), nullable=False, default=1)
449 media_license = db.relationship("License", foreign_keys=[media_license_id])
451 approved = db.Column(db.Boolean, nullable=False, default=False)
452 soft_deleted = db.Column(db.Boolean, nullable=False, default=False)
454 score = db.Column(db.Float, nullable=False, default=0)
455 score_downloads = db.Column(db.Float, nullable=False, default=0)
456 downloads = db.Column(db.Integer, nullable=False, default=0)
458 review_thread_id = db.Column(db.Integer, db.ForeignKey("thread.id"), nullable=True, default=None)
459 review_thread = db.relationship("Thread", foreign_keys=[review_thread_id])
462 repo = db.Column(db.String(200), nullable=True)
463 website = db.Column(db.String(200), nullable=True)
464 issueTracker = db.Column(db.String(200), nullable=True)
465 forums = db.Column(db.Integer, nullable=True)
467 provides = db.relationship("MetaPackage", \
468 secondary=provides, lazy="select", order_by=db.asc("name"), \
469 backref=db.backref("packages", lazy="dynamic", order_by=db.desc("score")))
471 dependencies = db.relationship("Dependency", backref="depender", lazy="dynamic", foreign_keys=[Dependency.depender_id])
473 tags = db.relationship("Tag", secondary=tags, lazy="select",
474 backref=db.backref("packages", lazy=True))
476 releases = db.relationship("PackageRelease", backref="package",
477 lazy="dynamic", order_by=db.desc("package_release_releaseDate"))
479 screenshots = db.relationship("PackageScreenshot", backref="package",
480 lazy="dynamic", order_by=db.asc("package_screenshot_id"))
482 requests = db.relationship("EditRequest", backref="package",
485 maintainers = db.relationship("User", secondary=maintainers, lazy="subquery")
487 def __init__(self, package=None):
491 self.author_id = package.author_id
492 self.created_at = package.created_at
493 self.approved = package.approved
495 for e in PackagePropertyKey:
496 setattr(self, e.name, getattr(package, e.name))
499 return "{}/{}".format(self.author.username, self.name)
502 return self.license.is_foss and self.media_license.is_foss
504 def getIsOnGitHub(self):
505 if self.repo is None:
508 url = urlparse(self.repo)
509 return url.netloc == "github.com"
511 def getGitHubFullName(self):
512 if self.repo is None:
515 url = urlparse(self.repo)
516 if url.netloc != "github.com":
520 m = re.search(r"^\/([^\/]+)\/([^\/]+)\/?$", url.path)
525 repo = m.group(2).replace(".git", "")
529 def getSortedDependencies(self, is_hard=None):
530 query = self.dependencies
531 if is_hard is not None:
532 query = query.filter_by(optional=not is_hard)
535 deps.sort(key = lambda x: x.getName())
538 def getSortedHardDependencies(self):
539 return self.getSortedDependencies(True)
541 def getSortedOptionalDependencies(self):
542 return self.getSortedDependencies(False)
547 elif self.review_thread_id:
549 elif (self.type == PackageType.GAME or \
550 self.type == PackageType.TXP) and \
551 self.screenshots.count() == 0:
553 elif not self.getDownloadRelease():
555 elif "Other" in self.license.name or "Other" in self.media_license.name:
560 def getAsDictionaryKey(self):
563 "author": self.author.display_name,
564 "type": self.type.toName(),
567 def getAsDictionaryShort(self, base_url, version=None):
568 tnurl = self.getThumbnailURL(1)
569 release = self.getDownloadRelease(version=version)
573 "author": self.author.username,
574 "short_description": self.short_desc,
575 "type": self.type.toName(),
576 "release": release and release.id,
577 "thumbnail": (base_url + tnurl) if tnurl is not None else None
580 def getAsDictionary(self, base_url, version=None):
581 tnurl = self.getThumbnailURL(1)
582 release = self.getDownloadRelease(version=version)
584 "author": self.author.username,
587 "short_description": self.short_desc,
589 "type": self.type.toName(),
590 "created_at": self.created_at.isoformat(),
592 "license": self.license.name,
593 "media_license": self.media_license.name,
596 "website": self.website,
597 "issue_tracker": self.issueTracker,
598 "forums": self.forums,
600 "provides": [x.name for x in self.provides],
601 "thumbnail": (base_url + tnurl) if tnurl is not None else None,
602 "screenshots": [base_url + ss.url for ss in self.screenshots],
604 "url": base_url + self.getDownloadURL(),
605 "release": release and release.id,
607 "score": round(self.score * 10) / 10
610 def getThumbnailURL(self, level=2):
611 screenshot = self.screenshots.filter_by(approved=True).order_by(db.asc(PackageScreenshot.id)).first()
612 return screenshot.getThumbnailURL(level) if screenshot is not None else None
614 def getMainScreenshotURL(self, absolute=False):
615 screenshot = self.screenshots.filter_by(approved=True).order_by(db.asc(PackageScreenshot.id)).first()
616 if screenshot is None:
620 from app.utils import abs_url
621 return abs_url(screenshot.url)
623 return screenshot.url
625 def getDetailsURL(self, absolute=False):
627 from app.utils import abs_url_for
628 return abs_url_for("packages.view",
629 author=self.author.username, name=self.name)
631 return url_for("packages.view",
632 author=self.author.username, name=self.name)
634 def getEditURL(self):
635 return url_for("packages.create_edit",
636 author=self.author.username, name=self.name)
638 def getApproveURL(self):
639 return url_for("packages.approve",
640 author=self.author.username, name=self.name)
642 def getRemoveURL(self):
643 return url_for("packages.remove",
644 author=self.author.username, name=self.name)
646 def getNewScreenshotURL(self):
647 return url_for("packages.create_screenshot",
648 author=self.author.username, name=self.name)
650 def getCreateReleaseURL(self):
651 return url_for("packages.create_release",
652 author=self.author.username, name=self.name)
654 def getCreateEditRequestURL(self):
655 return url_for("create_edit_editrequest_page",
656 author=self.author.username, name=self.name)
658 def getBulkReleaseURL(self):
659 return url_for("packages.bulk_change_release",
660 author=self.author.username, name=self.name)
662 def getDownloadURL(self):
663 return url_for("packages.download",
664 author=self.author.username, name=self.name)
666 def getEditMaintainersURL(self):
667 return url_for("packages.edit_maintainers",
668 author=self.author.username, name=self.name)
670 def getRemoveSelfMaintainerURL(self):
671 return url_for("packages.remove_self_maintainers",
672 author=self.author.username, name=self.name)
674 def getReviewURL(self):
675 return url_for('packages.review',
676 author=self.author.username, name=self.name)
678 def getDownloadRelease(self, version=None):
679 for rel in self.releases:
680 if rel.approved and (version is None or
681 ((rel.min_rel is None or rel.min_rel_id <= version.id) and \
682 (rel.max_rel is None or rel.max_rel_id >= version.id))):
687 def checkPerm(self, user, perm):
688 if not user.is_authenticated:
691 if type(perm) == str:
692 perm = Permission[perm]
693 elif type(perm) != Permission:
694 raise Exception("Unknown permission given to Package.checkPerm()")
696 isOwner = user == self.author
697 isMaintainer = isOwner or user.rank.atLeast(UserRank.EDITOR) or user in self.maintainers
699 if perm == Permission.CREATE_THREAD:
700 return user.rank.atLeast(UserRank.MEMBER)
702 # Members can edit their own packages, and editors can edit any packages
703 elif perm == Permission.MAKE_RELEASE or perm == Permission.ADD_SCREENSHOTS:
706 elif perm == Permission.EDIT_PACKAGE or perm == Permission.APPROVE_CHANGES or perm == Permission.APPROVE_RELEASE:
707 return isMaintainer and user.rank.atLeast(UserRank.MEMBER if self.approved else UserRank.NEW_MEMBER)
709 # Anyone can change the package name when not approved, but only editors when approved
710 elif perm == Permission.CHANGE_NAME:
711 return not self.approved or user.rank.atLeast(UserRank.EDITOR)
713 # Editors can change authors and approve new packages
714 elif perm == Permission.APPROVE_NEW or perm == Permission.CHANGE_AUTHOR:
715 return user.rank.atLeast(UserRank.EDITOR)
717 elif perm == Permission.APPROVE_SCREENSHOT:
718 return isMaintainer and user.rank.atLeast(UserRank.TRUSTED_MEMBER if self.approved else UserRank.NEW_MEMBER)
720 elif perm == Permission.EDIT_MAINTAINERS:
721 return isOwner or user.rank.atLeast(UserRank.MODERATOR)
723 elif perm == Permission.UNAPPROVE_PACKAGE or perm == Permission.DELETE_PACKAGE:
724 return user.rank.atLeast(UserRank.EDITOR)
726 elif perm == Permission.CHANGE_RELEASE_URL:
727 return user.rank.atLeast(UserRank.MODERATOR)
730 raise Exception("Permission {} is not related to packages".format(perm.name))
732 def getScoreDict(self):
734 "author": self.author.username,
737 "score_downloads": self.score_downloads,
738 "score_reviews": self.score - self.score_downloads,
739 "downloads": self.downloads
742 def recalcScore(self):
743 review_scores = [ 100 * r.asSign() for r in self.reviews ]
744 self.score = self.score_downloads + sum(review_scores)
747 class MetaPackage(db.Model):
748 id = db.Column(db.Integer, primary_key=True)
749 name = db.Column(db.String(100), unique=True, nullable=False)
750 dependencies = db.relationship("Dependency", backref="meta_package", lazy="dynamic")
752 def __init__(self, name=None):
759 def ListToSpec(list):
760 return ",".join([str(x) for x in list])
763 def GetOrCreate(name, cache={}):
766 mp = MetaPackage.query.filter_by(name=name).first()
769 mp = MetaPackage(name)
776 def SpecToList(spec, cache={}):
778 arr = spec.split(",")
781 pattern = re.compile("^([a-z0-9_]+)$")
788 if not pattern.match(x):
791 retval.append(MetaPackage.GetOrCreate(x, cache))
796 id = db.Column(db.Integer, primary_key=True)
797 name = db.Column(db.String(100), unique=True, nullable=False)
798 title = db.Column(db.String(100), nullable=False)
799 backgroundColor = db.Column(db.String(6), nullable=False)
800 textColor = db.Column(db.String(6), nullable=False)
802 def __init__(self, title, backgroundColor="000000", textColor="ffffff"):
804 self.backgroundColor = backgroundColor
805 self.textColor = textColor
808 regex = re.compile("[^a-z_]")
809 self.name = regex.sub("", self.title.lower().replace(" ", "_"))
812 class MinetestRelease(db.Model):
813 id = db.Column(db.Integer, primary_key=True)
814 name = db.Column(db.String(100), unique=True, nullable=False)
815 protocol = db.Column(db.Integer, nullable=False, default=0)
817 def __init__(self, name=None, protocol=0):
819 self.protocol = protocol
822 return None if self.name == "None" else self
825 def get(cls, version, protocol_num):
827 parts = version.strip().split(".")
829 major_minor = parts[0] + "." + parts[1]
830 query = MinetestRelease.query.filter(MinetestRelease.name.like("{}%".format(major_minor)))
832 query = query.filter_by(protocol=protocol_num)
834 release = query.one_or_none()
839 return MinetestRelease.query.filter_by(protocol=protocol_num).first()
844 class PackageRelease(db.Model):
845 id = db.Column(db.Integer, primary_key=True)
847 package_id = db.Column(db.Integer, db.ForeignKey("package.id"))
848 title = db.Column(db.String(100), nullable=False)
849 releaseDate = db.Column(db.DateTime, nullable=False)
850 url = db.Column(db.String(200), nullable=False)
851 approved = db.Column(db.Boolean, nullable=False, default=False)
852 task_id = db.Column(db.String(37), nullable=True)
853 commit_hash = db.Column(db.String(41), nullable=True, default=None)
854 downloads = db.Column(db.Integer, nullable=False, default=0)
856 min_rel_id = db.Column(db.Integer, db.ForeignKey("minetest_release.id"), nullable=True, server_default=None)
857 min_rel = db.relationship("MinetestRelease", foreign_keys=[min_rel_id])
859 max_rel_id = db.Column(db.Integer, db.ForeignKey("minetest_release.id"), nullable=True, server_default=None)
860 max_rel = db.relationship("MinetestRelease", foreign_keys=[max_rel_id])
862 # If the release is approved, then the task_id must be null and the url must be present
863 CK_approval_valid = db.CheckConstraint("not approved OR (task_id IS NULL AND (url = '') IS NOT FALSE)")
865 def getAsDictionary(self):
869 "url": self.url if self.url != "" else None,
870 "release_date": self.releaseDate.isoformat(),
871 "commit": self.commit_hash,
872 "downloads": self.downloads,
873 "min_protocol": self.min_rel and self.min_rel.protocol,
874 "max_protocol": self.max_rel and self.max_rel.protocol
877 def getEditURL(self):
878 return url_for("packages.edit_release",
879 author=self.package.author.username,
880 name=self.package.name,
883 def getDeleteURL(self):
884 return url_for("packages.delete_release",
885 author=self.package.author.username,
886 name=self.package.name,
889 def getDownloadURL(self):
890 return url_for("packages.download_release",
891 author=self.package.author.username,
892 name=self.package.name,
896 self.releaseDate = datetime.datetime.now()
898 def approve(self, user):
899 if not self.package.checkPerm(user, Permission.APPROVE_RELEASE):
902 assert self.task_id is None and self.url is not None and self.url != ""
907 def checkPerm(self, user, perm):
908 if not user.is_authenticated:
911 if type(perm) == str:
912 perm = Permission[perm]
913 elif type(perm) != Permission:
914 raise Exception("Unknown permission given to PackageRelease.checkPerm()")
916 isOwner = user == self.package.author
918 if perm == Permission.DELETE_RELEASE:
919 if user.rank.atLeast(UserRank.ADMIN):
922 if not (isOwner or user.rank.atLeast(UserRank.EDITOR)):
925 if not self.package.approved or self.task_id is not None:
928 count = PackageRelease.query \
929 .filter_by(package_id=self.package_id) \
930 .filter(PackageRelease.id > self.id) \
935 raise Exception("Permission {} is not related to releases".format(perm.name))
938 # class PackageReview(db.Model):
939 # id = db.Column(db.Integer, primary_key=True)
940 # package_id = db.Column(db.Integer, db.ForeignKey("package.id"))
941 # thread_id = db.Column(db.Integer, db.ForeignKey("thread.id"), nullable=False)
942 # recommend = db.Column(db.Boolean, nullable=False, default=True)
945 class PackageScreenshot(db.Model):
946 id = db.Column(db.Integer, primary_key=True)
947 package_id = db.Column(db.Integer, db.ForeignKey("package.id"))
948 title = db.Column(db.String(100), nullable=False)
949 url = db.Column(db.String(100), nullable=False)
950 approved = db.Column(db.Boolean, nullable=False, default=False)
953 def getEditURL(self):
954 return url_for("packages.edit_screenshot",
955 author=self.package.author.username,
956 name=self.package.name,
959 def getThumbnailURL(self, level=2):
960 return self.url.replace("/uploads/", ("/thumbnails/{:d}/").format(level))
963 class APIToken(db.Model):
964 id = db.Column(db.Integer, primary_key=True)
965 access_token = db.Column(db.String(34), unique=True)
967 name = db.Column(db.String(100), nullable=False)
968 owner_id = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
969 # owner is created using backref
971 created_at = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
973 package_id = db.Column(db.Integer, db.ForeignKey("package.id"), nullable=True)
974 package = db.relationship("Package", foreign_keys=[package_id])
976 def canOperateOnPackage(self, package):
977 if self.package and self.package != package:
980 return package.author == self.owner
983 class EditRequest(db.Model):
984 id = db.Column(db.Integer, primary_key=True)
986 package_id = db.Column(db.Integer, db.ForeignKey("package.id"))
987 author_id = db.Column(db.Integer, db.ForeignKey("user.id"))
989 title = db.Column(db.String(100), nullable=False)
990 desc = db.Column(db.String(1000), nullable=True)
995 status = db.Column(db.Integer, nullable=False, default=0)
997 changes = db.relationship("EditRequestChange", backref="request",
1001 return url_for("view_editrequest_page",
1002 author=self.package.author.username,
1003 name=self.package.name,
1006 def getApproveURL(self):
1007 return url_for("approve_editrequest_page",
1008 author=self.package.author.username,
1009 name=self.package.name,
1012 def getRejectURL(self):
1013 return url_for("reject_editrequest_page",
1014 author=self.package.author.username,
1015 name=self.package.name,
1018 def getEditURL(self):
1019 return url_for("create_edit_editrequest_page",
1020 author=self.package.author.username,
1021 name=self.package.name,
1024 def applyAll(self, package):
1025 for change in self.changes:
1026 change.apply(package)
1029 def checkPerm(self, user, perm):
1030 if not user.is_authenticated:
1033 if type(perm) == str:
1034 perm = Permission[perm]
1035 elif type(perm) != Permission:
1036 raise Exception("Unknown permission given to EditRequest.checkPerm()")
1038 isOwner = user == self.author
1040 # Members can edit their own packages, and editors can edit any packages
1041 if perm == Permission.EDIT_EDITREQUEST:
1042 return isOwner or user.rank.atLeast(UserRank.EDITOR)
1045 raise Exception("Permission {} is not related to packages".format(perm.name))
1050 class EditRequestChange(db.Model):
1051 id = db.Column(db.Integer, primary_key=True)
1053 request_id = db.Column(db.Integer, db.ForeignKey("edit_request.id"))
1054 key = db.Column(db.Enum(PackagePropertyKey), nullable=False)
1056 # TODO: make diff instead
1057 oldValue = db.Column(db.Text, nullable=True)
1058 newValue = db.Column(db.Text, nullable=True)
1060 def apply(self, package):
1061 if self.key == PackagePropertyKey.tags:
1062 package.tags.clear()
1063 for tagTitle in self.newValue.split(","):
1064 tag = Tag.query.filter_by(title=tagTitle.strip()).first()
1065 package.tags.append(tag)
1068 setattr(package, self.key.name, self.newValue)
1071 watchers = db.Table("watchers",
1072 db.Column("user_id", db.Integer, db.ForeignKey("user.id"), primary_key=True),
1073 db.Column("thread_id", db.Integer, db.ForeignKey("thread.id"), primary_key=True)
1076 class Thread(db.Model):
1077 id = db.Column(db.Integer, primary_key=True)
1079 package_id = db.Column(db.Integer, db.ForeignKey("package.id"), nullable=True)
1080 package = db.relationship("Package", foreign_keys=[package_id])
1082 review_id = db.Column(db.Integer, db.ForeignKey("package_review.id"), nullable=True)
1083 review = db.relationship("PackageReview", foreign_keys=[review_id])
1085 author_id = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
1086 title = db.Column(db.String(100), nullable=False)
1087 private = db.Column(db.Boolean, server_default="0", nullable=False)
1089 locked = db.Column(db.Boolean, server_default="0", nullable=False)
1091 created_at = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
1093 replies = db.relationship("ThreadReply", backref="thread", lazy="dynamic")
1095 watchers = db.relationship("User", secondary=watchers, lazy="subquery", \
1096 backref=db.backref("watching", lazy=True))
1098 def getViewURL(self):
1099 return url_for("threads.view", id=self.id)
1101 def getSubscribeURL(self):
1102 return url_for("threads.subscribe", id=self.id)
1104 def getUnsubscribeURL(self):
1105 return url_for("threads.unsubscribe", id=self.id)
1107 def checkPerm(self, user, perm):
1108 if not user.is_authenticated:
1109 return perm == Permission.SEE_THREAD and not self.private
1111 if type(perm) == str:
1112 perm = Permission[perm]
1113 elif type(perm) != Permission:
1114 raise Exception("Unknown permission given to Thread.checkPerm()")
1116 isMaintainer = user == self.author or (self.package is not None and self.package.author == user)
1118 isMaintainer = isMaintainer or user in self.package.maintainers
1120 canSee = not self.private or isMaintainer or user.rank.atLeast(UserRank.EDITOR)
1122 if perm == Permission.SEE_THREAD:
1125 elif perm == Permission.COMMENT_THREAD:
1126 return canSee and (not self.locked or user.rank.atLeast(UserRank.MODERATOR))
1128 elif perm == Permission.LOCK_THREAD:
1129 return user.rank.atLeast(UserRank.MODERATOR)
1132 raise Exception("Permission {} is not related to threads".format(perm.name))
1134 class ThreadReply(db.Model):
1135 id = db.Column(db.Integer, primary_key=True)
1136 thread_id = db.Column(db.Integer, db.ForeignKey("thread.id"), nullable=False)
1137 comment = db.Column(db.String(500), nullable=False)
1138 author_id = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
1139 created_at = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
1141 def checkPerm(self, user, perm):
1142 if not user.is_authenticated:
1145 if type(perm) == str:
1146 perm = Permission[perm]
1147 elif type(perm) != Permission:
1148 raise Exception("Unknown permission given to ThreadReply.checkPerm()")
1150 if perm == Permission.EDIT_REPLY:
1151 return user == self.author and user.rank.atLeast(UserRank.MEMBER) and not self.thread.locked
1153 elif perm == Permission.DELETE_REPLY:
1154 return user.rank.atLeast(UserRank.MODERATOR) and self.thread.replies[0] != self
1157 raise Exception("Permission {} is not related to threads".format(perm.name))
1160 class PackageReview(db.Model):
1161 id = db.Column(db.Integer, primary_key=True)
1163 package_id = db.Column(db.Integer, db.ForeignKey("package.id"), nullable=True)
1164 package = db.relationship("Package", foreign_keys=[package_id], backref=db.backref("reviews", lazy=True))
1166 created_at = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
1168 author_id = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
1169 author = db.relationship("User", foreign_keys=[author_id], backref=db.backref("reviews", lazy=True))
1171 recommends = db.Column(db.Boolean, nullable=False)
1173 thread = db.relationship("Thread", uselist=False, back_populates="review")
1176 return 1 if self.recommends else -1
1178 def getEditURL(self):
1179 return self.package.getReviewURL()
1181 def getDeleteURL(self):
1182 return url_for("packages.delete_review",
1183 author=self.package.author.username,
1184 name=self.package.name)
1187 class AuditSeverity(enum.Enum):
1188 NORMAL = 0 # Normal user changes
1189 EDITOR = 1 # Editor changes
1190 MODERATION = 2 # Destructive / moderator changes
1196 return self.name.replace("_", " ").title()
1200 return [(choice, choice.getTitle()) for choice in cls]
1203 def coerce(cls, item):
1204 return item if type(item) == AuditSeverity else AuditSeverity[item]
1208 class AuditLogEntry(db.Model):
1209 id = db.Column(db.Integer, primary_key=True)
1211 created_at = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
1213 causer_id = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
1214 causer = db.relationship("User", foreign_keys=[causer_id])
1216 severity = db.Column(db.Enum(AuditSeverity), nullable=False)
1218 title = db.Column(db.String(100), nullable=False)
1219 url = db.Column(db.String(200), nullable=True)
1221 package_id = db.Column(db.Integer, db.ForeignKey("package.id"), nullable=True)
1222 package = db.relationship("Package", foreign_keys=[package_id])
1224 description = db.Column(db.Text, nullable=True, default=None)
1226 def __init__(self, causer, severity, title, url, package=None, description=None):
1227 if len(title) > 100:
1228 title = title[:99] + "…"
1230 self.causer = causer
1231 self.severity = severity
1234 self.package = package
1235 self.description = description
1240 REPO_BLACKLIST = [".zip", "mediafire.com", "dropbox.com", "weebly.com", \
1241 "minetest.net", "dropboxusercontent.com", "4shared.com", \
1242 "digitalaudioconcepts.com", "hg.intevation.org", "www.wtfpl.net", \
1243 "imageshack.com", "imgur.com"]
1245 class ForumTopic(db.Model):
1246 topic_id = db.Column(db.Integer, primary_key=True, autoincrement=False)
1247 author_id = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
1248 author = db.relationship("User")
1250 wip = db.Column(db.Boolean, server_default="0")
1251 discarded = db.Column(db.Boolean, server_default="0")
1253 type = db.Column(db.Enum(PackageType), nullable=False)
1254 title = db.Column(db.String(200), nullable=False)
1255 name = db.Column(db.String(30), nullable=True)
1256 link = db.Column(db.String(200), nullable=True)
1258 posts = db.Column(db.Integer, nullable=False)
1259 views = db.Column(db.Integer, nullable=False)
1261 created_at = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
1263 def getRepoURL(self):
1264 if self.link is None:
1267 for item in REPO_BLACKLIST:
1268 if item in self.link:
1271 return self.link.replace("repo.or.cz/w/", "repo.or.cz/")
1273 def getAsDictionary(self):
1275 "author": self.author.username,
1277 "type": self.type.toName(),
1278 "title": self.title,
1279 "id": self.topic_id,
1281 "posts": self.posts,
1282 "views": self.views,
1284 "discarded": self.discarded,
1285 "created_at": self.created_at.isoformat(),
1288 def checkPerm(self, user, perm):
1289 if not user.is_authenticated:
1292 if type(perm) == str:
1293 perm = Permission[perm]
1294 elif type(perm) != Permission:
1295 raise Exception("Unknown permission given to ForumTopic.checkPerm()")
1297 if perm == Permission.TOPIC_DISCARD:
1298 return self.author == user or user.rank.atLeast(UserRank.EDITOR)
1301 raise Exception("Permission {} is not related to topics".format(perm.name))
1305 user_manager = UserManager(app, db, User)
1307 if app.config.get("LOG_SQL"):
1309 logging.basicConfig()
1310 logging.getLogger('sqlalchemy.engine').setLevel(logging.INFO)