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 REIMPORT_META = "REIMPORT_META"
84 APPROVE_SCREENSHOT = "APPROVE_SCREENSHOT"
85 APPROVE_RELEASE = "APPROVE_RELEASE"
86 APPROVE_NEW = "APPROVE_NEW"
87 EDIT_TAGS = "EDIT_TAGS"
88 CREATE_TAG = "CREATE_TAG"
89 CHANGE_RELEASE_URL = "CHANGE_RELEASE_URL"
90 CHANGE_USERNAMES = "CHANGE_USERNAMES"
91 CHANGE_RANK = "CHANGE_RANK"
92 CHANGE_EMAIL = "CHANGE_EMAIL"
93 EDIT_EDITREQUEST = "EDIT_EDITREQUEST"
94 SEE_THREAD = "SEE_THREAD"
95 CREATE_THREAD = "CREATE_THREAD"
96 COMMENT_THREAD = "COMMENT_THREAD"
97 LOCK_THREAD = "LOCK_THREAD"
98 DELETE_REPLY = "DELETE_REPLY"
99 EDIT_REPLY = "EDIT_REPLY"
100 UNAPPROVE_PACKAGE = "UNAPPROVE_PACKAGE"
101 TOPIC_DISCARD = "TOPIC_DISCARD"
102 CREATE_TOKEN = "CREATE_TOKEN"
103 EDIT_MAINTAINERS = "EDIT_MAINTAINERS"
104 CHANGE_PROFILE_URLS = "CHANGE_PROFILE_URLS"
106 # Only return true if the permission is valid for *all* contexts
107 # See Package.checkPerm for package-specific contexts
108 def check(self, user):
109 if not user.is_authenticated:
112 if self == Permission.APPROVE_NEW or \
113 self == Permission.APPROVE_CHANGES or \
114 self == Permission.APPROVE_RELEASE or \
115 self == Permission.APPROVE_SCREENSHOT or \
116 self == Permission.EDIT_TAGS or \
117 self == Permission.CREATE_TAG or \
118 self == Permission.SEE_THREAD:
119 return user.rank.atLeast(UserRank.EDITOR)
121 raise Exception("Non-global permission checked globally. Use Package.checkPerm or User.checkPerm instead.")
124 def checkPerm(user, perm):
125 if type(perm) == str:
126 perm = Permission[perm]
127 elif type(perm) != Permission:
128 raise Exception("Unknown permission given to Permission.check")
130 return perm.check(user)
132 def display_name_default(context):
133 return context.get_current_parameters()["username"]
135 class User(db.Model, UserMixin):
136 id = db.Column(db.Integer, primary_key=True)
138 # User authentication information
139 username = db.Column(db.String(50, collation="NOCASE"), nullable=False, unique=True, index=True)
140 password = db.Column(db.String(255), nullable=False, server_default="")
141 reset_password_token = db.Column(db.String(100), nullable=False, server_default="")
143 rank = db.Column(db.Enum(UserRank))
146 github_username = db.Column(db.String(50, collation="NOCASE"), nullable=True, unique=True)
147 forums_username = db.Column(db.String(50, collation="NOCASE"), nullable=True, unique=True)
149 # Access token for webhook setup
150 github_access_token = db.Column(db.String(50), nullable=True, server_default=None)
152 # User email information
153 email = db.Column(db.String(255), nullable=True, unique=True)
154 email_confirmed_at = db.Column(db.DateTime())
157 profile_pic = db.Column(db.String(255), nullable=True, server_default=None)
158 active = db.Column("is_active", db.Boolean, nullable=False, server_default="0")
159 display_name = db.Column(db.String(100), nullable=False, default=display_name_default)
162 website_url = db.Column(db.String(255), nullable=True, default=None)
163 donate_url = db.Column(db.String(255), nullable=True, default=None)
166 notifications = db.relationship("Notification", primaryjoin="User.id==Notification.user_id", \
167 order_by="Notification.created_at")
169 packages = db.relationship("Package", backref=db.backref("author", lazy="joined"), lazy="dynamic")
170 requests = db.relationship("EditRequest", backref="author", lazy="dynamic")
171 threads = db.relationship("Thread", backref="author", lazy="dynamic")
172 tokens = db.relationship("APIToken", backref="owner", lazy="dynamic")
173 replies = db.relationship("ThreadReply", backref="author", lazy="dynamic")
175 def __init__(self, username=None, active=False, email=None, password=""):
176 self.username = username
177 self.email_confirmed_at = datetime.datetime.now() - datetime.timedelta(days=6000)
178 self.display_name = username
181 self.password = password
182 self.rank = UserRank.NOT_JOINED
184 def hasPassword(self):
185 return self.password != ""
187 def canAccessTodoList(self):
188 return Permission.APPROVE_NEW.check(self) or \
189 Permission.APPROVE_RELEASE.check(self) or \
190 Permission.APPROVE_CHANGES.check(self)
193 return self.rank.atLeast(UserRank.NEW_MEMBER)
195 def getProfilePicURL(self):
197 return self.profile_pic
199 return gravatar(self.email or "")
201 def checkPerm(self, user, perm):
202 if not user.is_authenticated:
205 if type(perm) == str:
206 perm = Permission[perm]
207 elif type(perm) != Permission:
208 raise Exception("Unknown permission given to User.checkPerm()")
210 # Members can edit their own packages, and editors can edit any packages
211 if perm == Permission.CHANGE_AUTHOR:
212 return user.rank.atLeast(UserRank.EDITOR)
213 elif perm == Permission.CHANGE_RANK or perm == Permission.CHANGE_USERNAMES:
214 return user.rank.atLeast(UserRank.MODERATOR)
215 elif perm == Permission.CHANGE_EMAIL or perm == Permission.CHANGE_PROFILE_URLS:
216 return user == self or user.rank.atLeast(UserRank.ADMIN)
217 elif perm == Permission.CREATE_TOKEN:
219 return user.rank.atLeast(UserRank.MEMBER)
221 return user.rank.atLeast(UserRank.MODERATOR) and user.rank.atLeast(self.rank)
223 raise Exception("Permission {} is not related to users".format(perm.name))
225 def canCommentRL(self):
227 if self.rank.atLeast(UserRank.ADMIN):
229 elif self.rank.atLeast(UserRank.TRUSTED_MEMBER):
232 one_min_ago = datetime.datetime.utcnow() - datetime.timedelta(minutes=1)
233 if ThreadReply.query.filter_by(author=self) \
234 .filter(ThreadReply.created_at > one_min_ago).count() >= 3 * factor:
237 hour_ago = datetime.datetime.utcnow() - datetime.timedelta(hours=1)
238 if ThreadReply.query.filter_by(author=self) \
239 .filter(ThreadReply.created_at > hour_ago).count() >= 20 * factor:
244 def canOpenThreadRL(self):
246 if self.rank.atLeast(UserRank.ADMIN):
248 elif self.rank.atLeast(UserRank.TRUSTED_MEMBER):
251 hour_ago = datetime.datetime.utcnow() - datetime.timedelta(hours=1)
252 return Thread.query.filter_by(author=self) \
253 .filter(Thread.created_at > hour_ago).count() < 2 * factor
255 def __eq__(self, other):
259 if not self.is_authenticated or not other.is_authenticated:
263 return self.id == other.id
265 class UserEmailVerification(db.Model):
266 id = db.Column(db.Integer, primary_key=True)
267 user_id = db.Column(db.Integer, db.ForeignKey("user.id"))
268 email = db.Column(db.String(100))
269 token = db.Column(db.String(32))
270 user = db.relationship("User", foreign_keys=[user_id])
272 class Notification(db.Model):
273 id = db.Column(db.Integer, primary_key=True)
275 user_id = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
276 user = db.relationship("User", foreign_keys=[user_id])
278 causer_id = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
279 causer = db.relationship("User", foreign_keys=[causer_id])
281 title = db.Column(db.String(100), nullable=False)
282 url = db.Column(db.String(200), nullable=True)
284 package_id = db.Column(db.Integer, db.ForeignKey("package.id"), nullable=True)
285 package = db.relationship("Package", foreign_keys=[package_id])
287 created_at = db.Column(db.DateTime, nullable=True, default=datetime.datetime.utcnow)
289 def __init__(self, user, causer, title, url, package=None):
291 title = title[:99] + "…"
297 self.package = package
300 class License(db.Model):
301 id = db.Column(db.Integer, primary_key=True)
302 name = db.Column(db.String(50), nullable=False, unique=True)
303 is_foss = db.Column(db.Boolean, nullable=False, default=True)
305 def __init__(self, v, is_foss=True):
307 self.is_foss = is_foss
313 class PackageType(enum.Enum):
319 return self.name.lower()
327 return PackageType[name.upper()]
333 return [(choice, choice.value) for choice in cls]
336 def coerce(cls, item):
337 return item if type(item) == PackageType else PackageType[item]
340 class PackageState(enum.Enum):
341 WIP = "Work in Progress"
342 CHANGES_NEEDED = "Changes Needed"
343 READY_FOR_REVIEW = "Ready for Review"
344 APPROVED = "Approved"
348 return self.name.lower()
351 if self == self.READY_FOR_REVIEW:
352 return "Submit for Review"
353 elif self == self.APPROVED:
355 elif self == self.DELETED:
366 return PackageState[name.upper()]
372 return [(choice, choice.value) for choice in cls]
375 def coerce(cls, item):
376 return item if type(item) == PackageState else PackageState[item]
379 PACKAGE_STATE_FLOW = {
380 PackageState.WIP: set([ PackageState.READY_FOR_REVIEW ]),
381 PackageState.CHANGES_NEEDED: set([ PackageState.READY_FOR_REVIEW ]),
382 PackageState.READY_FOR_REVIEW: set([ PackageState.WIP, PackageState.CHANGES_NEEDED, PackageState.APPROVED ]),
383 PackageState.APPROVED: set([ PackageState.CHANGES_NEEDED ]),
384 PackageState.DELETED: set([ PackageState.READY_FOR_REVIEW ]),
388 class PackagePropertyKey(enum.Enum):
391 short_desc = "Short Description"
395 media_license = "Media License"
397 provides = "Provides"
400 issueTracker = "Issue Tracker"
401 forums = "Forum Topic ID"
403 def convert(self, value):
404 if self == PackagePropertyKey.tags:
405 return ",".join([t.title for t in value])
406 elif self == PackagePropertyKey.provides:
407 return ",".join([t.name for t in value])
411 provides = db.Table("provides",
412 db.Column("package_id", db.Integer, db.ForeignKey("package.id"), primary_key=True),
413 db.Column("metapackage_id", db.Integer, db.ForeignKey("meta_package.id"), primary_key=True)
416 Tags = db.Table("tags",
417 db.Column("tag_id", db.Integer, db.ForeignKey("tag.id"), primary_key=True),
418 db.Column("package_id", db.Integer, db.ForeignKey("package.id"), primary_key=True)
421 ContentWarnings = db.Table("content_warnings",
422 db.Column("content_warning_id", db.Integer, db.ForeignKey("content_warning.id"), primary_key=True),
423 db.Column("package_id", db.Integer, db.ForeignKey("package.id"), primary_key=True)
426 maintainers = db.Table("maintainers",
427 db.Column("user_id", db.Integer, db.ForeignKey("user.id"), primary_key=True),
428 db.Column("package_id", db.Integer, db.ForeignKey("package.id"), primary_key=True)
431 class Dependency(db.Model):
432 id = db.Column(db.Integer, primary_key=True)
433 depender_id = db.Column(db.Integer, db.ForeignKey("package.id"), nullable=True)
434 package_id = db.Column(db.Integer, db.ForeignKey("package.id"), nullable=True)
435 package = db.relationship("Package", foreign_keys=[package_id])
436 meta_package_id = db.Column(db.Integer, db.ForeignKey("meta_package.id"), nullable=True)
437 optional = db.Column(db.Boolean, nullable=False, default=False)
438 __table_args__ = (db.UniqueConstraint("depender_id", "package_id", "meta_package_id", name="_dependency_uc"), )
440 def __init__(self, depender=None, package=None, meta=None, optional=False):
444 self.depender = depender
445 self.optional = optional
447 packageProvided = package is not None
448 metaProvided = meta is not None
450 if packageProvided and not metaProvided:
451 self.package = package
452 elif metaProvided and not packageProvided:
453 self.meta_package = meta
455 raise Exception("Either meta or package must be given, but not both!")
458 if self.meta_package:
459 return self.meta_package.name
461 return self.package.name
466 if self.package is not None:
467 return self.package.author.username + "/" + self.package.name
468 elif self.meta_package is not None:
469 return self.meta_package.name
471 raise Exception("Meta and package are both none!")
474 def SpecToList(depender, spec, cache={}):
476 arr = spec.split(",")
479 pattern1 = re.compile("^([a-z0-9_]+)$")
480 pattern2 = re.compile("^([A-Za-z0-9_]+)/([a-z0-9_]+)$")
487 if pattern1.match(x):
488 meta = MetaPackage.GetOrCreate(x, cache)
489 retval.append(Dependency(depender, meta=meta))
491 m = pattern2.match(x)
492 username = m.group(1)
494 user = User.query.filter_by(username=username).first()
496 raise Exception("Unable to find user " + username)
498 package = Package.query.filter_by(author=user, name=name).first()
500 raise Exception("Unable to find package " + name + " by " + username)
502 retval.append(Dependency(depender, package=package))
507 class Package(db.Model):
508 query_class = ArticleQuery
510 id = db.Column(db.Integer, primary_key=True)
513 author_id = db.Column(db.Integer, db.ForeignKey("user.id"))
514 name = db.Column(db.Unicode(100), nullable=False)
515 title = db.Column(db.Unicode(100), nullable=False)
516 short_desc = db.Column(db.Unicode(200), nullable=False)
517 desc = db.Column(db.UnicodeText, nullable=True)
518 type = db.Column(db.Enum(PackageType))
519 created_at = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
520 approved_at = db.Column(db.DateTime, nullable=True, default=None)
522 name_valid = db.CheckConstraint("name ~* '^[a-z0-9_]+$'")
524 search_vector = db.Column(TSVectorType("name", "title", "short_desc", "desc", \
525 weights={ "name": "A", "title": "B", "short_desc": "C", "desc": "D" }))
527 license_id = db.Column(db.Integer, db.ForeignKey("license.id"), nullable=False, default=1)
528 license = db.relationship("License", foreign_keys=[license_id])
529 media_license_id = db.Column(db.Integer, db.ForeignKey("license.id"), nullable=False, default=1)
530 media_license = db.relationship("License", foreign_keys=[media_license_id])
532 state = db.Column(db.Enum(PackageState), default=PackageState.WIP)
536 return self.state == PackageState.APPROVED
538 score = db.Column(db.Float, nullable=False, default=0)
539 score_downloads = db.Column(db.Float, nullable=False, default=0)
540 downloads = db.Column(db.Integer, nullable=False, default=0)
542 review_thread_id = db.Column(db.Integer, db.ForeignKey("thread.id"), nullable=True, default=None)
543 review_thread = db.relationship("Thread", foreign_keys=[review_thread_id])
546 repo = db.Column(db.String(200), nullable=True)
547 website = db.Column(db.String(200), nullable=True)
548 issueTracker = db.Column(db.String(200), nullable=True)
549 forums = db.Column(db.Integer, nullable=True)
551 provides = db.relationship("MetaPackage", \
552 secondary=provides, lazy="select", order_by=db.asc("name"), \
553 backref=db.backref("packages", lazy="dynamic", order_by=db.desc("score")))
555 dependencies = db.relationship("Dependency", backref="depender", lazy="dynamic", foreign_keys=[Dependency.depender_id])
557 tags = db.relationship("Tag", secondary=Tags, lazy="select",
558 backref=db.backref("packages", lazy=True))
560 content_warnings = db.relationship("ContentWarning", secondary=ContentWarnings, lazy="select",
561 backref=db.backref("packages", lazy=True))
563 releases = db.relationship("PackageRelease", backref="package",
564 lazy="dynamic", order_by=db.desc("package_release_releaseDate"))
566 screenshots = db.relationship("PackageScreenshot", backref="package",
567 lazy="dynamic", order_by=db.asc("package_screenshot_id"))
569 requests = db.relationship("EditRequest", backref="package",
572 maintainers = db.relationship("User", secondary=maintainers, lazy="subquery")
574 def __init__(self, package=None):
578 self.author_id = package.author_id
579 self.created_at = package.created_at
580 self.state = package.state
582 self.maintainers.append(self.author)
584 for e in PackagePropertyKey:
585 setattr(self, e.name, getattr(package, e.name))
588 return "{}/{}".format(self.author.username, self.name)
591 return self.license.is_foss and self.media_license.is_foss
593 def getIsOnGitHub(self):
594 if self.repo is None:
597 url = urlparse(self.repo)
598 return url.netloc == "github.com"
600 def getGitHubFullName(self):
601 if self.repo is None:
604 url = urlparse(self.repo)
605 if url.netloc != "github.com":
609 m = re.search(r"^\/([^\/]+)\/([^\/]+)\/?$", url.path)
614 repo = m.group(2).replace(".git", "")
618 def getSortedDependencies(self, is_hard=None):
619 query = self.dependencies
620 if is_hard is not None:
621 query = query.filter_by(optional=not is_hard)
624 deps.sort(key = lambda x: x.getName())
627 def getSortedHardDependencies(self):
628 return self.getSortedDependencies(True)
630 def getSortedOptionalDependencies(self):
631 return self.getSortedDependencies(False)
633 def getAsDictionaryKey(self):
636 "author": self.author.display_name,
637 "type": self.type.toName(),
640 def getAsDictionaryShort(self, base_url, version=None):
641 tnurl = self.getThumbnailURL(1)
642 release = self.getDownloadRelease(version=version)
646 "author": self.author.username,
647 "short_description": self.short_desc,
648 "type": self.type.toName(),
649 "release": release and release.id,
650 "thumbnail": (base_url + tnurl) if tnurl is not None else None
653 def getAsDictionary(self, base_url, version=None):
654 tnurl = self.getThumbnailURL(1)
655 release = self.getDownloadRelease(version=version)
657 "author": self.author.username,
660 "short_description": self.short_desc,
662 "type": self.type.toName(),
663 "created_at": self.created_at.isoformat(),
665 "license": self.license.name,
666 "media_license": self.media_license.name,
669 "website": self.website,
670 "issue_tracker": self.issueTracker,
671 "forums": self.forums,
673 "provides": [x.name for x in self.provides],
674 "thumbnail": (base_url + tnurl) if tnurl is not None else None,
675 "screenshots": [base_url + ss.url for ss in self.screenshots],
677 "url": base_url + self.getDownloadURL(),
678 "release": release and release.id,
680 "score": round(self.score * 10) / 10,
681 "downloads": self.downloads
684 def getThumbnailURL(self, level=2):
685 screenshot = self.screenshots.filter_by(approved=True).order_by(db.asc(PackageScreenshot.id)).first()
686 return screenshot.getThumbnailURL(level) if screenshot is not None else None
688 def getMainScreenshotURL(self, absolute=False):
689 screenshot = self.screenshots.filter_by(approved=True).order_by(db.asc(PackageScreenshot.id)).first()
690 if screenshot is None:
694 from app.utils import abs_url
695 return abs_url(screenshot.url)
697 return screenshot.url
699 def getDetailsURL(self, absolute=False):
701 from app.utils import abs_url_for
702 return abs_url_for("packages.view",
703 author=self.author.username, name=self.name)
705 return url_for("packages.view",
706 author=self.author.username, name=self.name)
708 def getShieldURL(self, type):
709 from app.utils import abs_url_for
710 return abs_url_for("packages.shield",
711 author=self.author.username, name=self.name, type=type)
713 def makeShield(self, type):
714 return "[![ContentDB]({})]({})" \
715 .format(self.getShieldURL(type), self.getDetailsURL(True))
717 def getEditURL(self):
718 return url_for("packages.create_edit",
719 author=self.author.username, name=self.name)
721 def getSetStateURL(self, state):
722 if type(state) == str:
723 state = PackageState[perm]
724 elif type(state) != PackageState:
725 raise Exception("Unknown state given to Package.canMoveToState()")
727 return url_for("packages.move_to_state",
728 author=self.author.username, name=self.name, state=state.name.lower())
730 def getRemoveURL(self):
731 return url_for("packages.remove",
732 author=self.author.username, name=self.name)
734 def getNewScreenshotURL(self):
735 return url_for("packages.create_screenshot",
736 author=self.author.username, name=self.name)
738 def getCreateReleaseURL(self):
739 return url_for("packages.create_release",
740 author=self.author.username, name=self.name)
742 def getCreateEditRequestURL(self):
743 return url_for("create_edit_editrequest_page",
744 author=self.author.username, name=self.name)
746 def getBulkReleaseURL(self):
747 return url_for("packages.bulk_change_release",
748 author=self.author.username, name=self.name)
750 def getDownloadURL(self):
751 return url_for("packages.download",
752 author=self.author.username, name=self.name)
754 def getEditMaintainersURL(self):
755 return url_for("packages.edit_maintainers",
756 author=self.author.username, name=self.name)
758 def getRemoveSelfMaintainerURL(self):
759 return url_for("packages.remove_self_maintainers",
760 author=self.author.username, name=self.name)
762 def getUpdateFromReleaseURL(self):
763 return url_for("packages.update_from_release",
764 author=self.author.username, name=self.name)
766 def getReviewURL(self):
767 return url_for('packages.review',
768 author=self.author.username, name=self.name)
770 def getDownloadRelease(self, version=None):
771 for rel in self.releases:
772 if rel.approved and (version is None or
773 ((rel.min_rel is None or rel.min_rel_id <= version.id) and \
774 (rel.max_rel is None or rel.max_rel_id >= version.id))):
779 def checkPerm(self, user, perm):
780 if not user.is_authenticated:
783 if type(perm) == str:
784 perm = Permission[perm]
785 elif type(perm) != Permission:
786 raise Exception("Unknown permission given to Package.checkPerm()")
788 isOwner = user == self.author
789 isMaintainer = isOwner or user.rank.atLeast(UserRank.EDITOR) or user in self.maintainers
791 if perm == Permission.CREATE_THREAD:
792 return user.rank.atLeast(UserRank.MEMBER)
794 # Members can edit their own packages, and editors can edit any packages
795 elif perm == Permission.MAKE_RELEASE or perm == Permission.ADD_SCREENSHOTS:
798 elif perm == Permission.EDIT_PACKAGE or \
799 perm == Permission.APPROVE_CHANGES or perm == Permission.APPROVE_RELEASE:
800 return isMaintainer and user.rank.atLeast(UserRank.MEMBER if self.approved else UserRank.NEW_MEMBER)
802 # Anyone can change the package name when not approved, but only editors when approved
803 elif perm == Permission.CHANGE_NAME:
804 return not self.approved or user.rank.atLeast(UserRank.EDITOR)
806 # Editors can change authors and approve new packages
807 elif perm == Permission.APPROVE_NEW or perm == Permission.CHANGE_AUTHOR:
808 return user.rank.atLeast(UserRank.EDITOR)
810 elif perm == Permission.APPROVE_SCREENSHOT:
811 return isMaintainer and user.rank.atLeast(UserRank.TRUSTED_MEMBER if self.approved else UserRank.NEW_MEMBER)
813 elif perm == Permission.EDIT_MAINTAINERS:
814 return isOwner or user.rank.atLeast(UserRank.MODERATOR)
816 elif perm == Permission.UNAPPROVE_PACKAGE or perm == Permission.DELETE_PACKAGE:
817 return user.rank.atLeast(UserRank.MEMBER if isOwner else UserRank.EDITOR)
819 elif perm == Permission.CHANGE_RELEASE_URL:
820 return user.rank.atLeast(UserRank.MODERATOR)
822 elif perm == Permission.REIMPORT_META:
823 return user.rank.atLeast(UserRank.ADMIN)
826 raise Exception("Permission {} is not related to packages".format(perm.name))
829 def canMoveToState(self, user, state):
830 if not user.is_authenticated:
833 if type(state) == str:
834 state = PackageState[perm]
835 elif type(state) != PackageState:
836 raise Exception("Unknown state given to Package.canMoveToState()")
838 if state not in PACKAGE_STATE_FLOW[self.state]:
841 if state == PackageState.READY_FOR_REVIEW or state == PackageState.APPROVED:
842 requiredPerm = Permission.APPROVE_NEW if state == PackageState.APPROVED else Permission.EDIT_PACKAGE
844 if not self.checkPerm(user, requiredPerm):
847 if state == PackageState.APPROVED and \
848 ("Other" in self.license.name or "Other" in self.media_license.name):
852 (self.type == self.type.GAME or self.type == self.type.TXP) and \
853 self.screenshots.count() == 0
854 return self.releases.count() > 0 and not needsScreenshot
856 elif state == PackageState.CHANGES_NEEDED:
857 return self.checkPerm(user, Permission.APPROVE_NEW)
859 elif state == PackageState.WIP:
860 return self.checkPerm(user, Permission.EDIT_PACKAGE) and user in self.maintainers
865 def getNextStates(self, user):
868 for state in PackageState:
869 if self.canMoveToState(user, state):
875 def getScoreDict(self):
877 "author": self.author.username,
880 "score_downloads": self.score_downloads,
881 "score_reviews": self.score - self.score_downloads,
882 "downloads": self.downloads
885 def recalcScore(self):
886 review_scores = [ 100 * r.asSign() for r in self.reviews ]
887 self.score = self.score_downloads + sum(review_scores)
890 class MetaPackage(db.Model):
891 id = db.Column(db.Integer, primary_key=True)
892 name = db.Column(db.String(100), unique=True, nullable=False)
893 dependencies = db.relationship("Dependency", backref="meta_package", lazy="dynamic")
895 mp_name_valid = db.CheckConstraint("name ~* '^[a-z0-9_]+$'")
897 def __init__(self, name=None):
904 def ListToSpec(list):
905 return ",".join([str(x) for x in list])
908 def GetOrCreate(name, cache={}):
911 mp = MetaPackage.query.filter_by(name=name).first()
914 mp = MetaPackage(name)
921 def SpecToList(spec, cache={}):
923 arr = spec.split(",")
926 pattern = re.compile("^([a-z0-9_]+)$")
933 if not pattern.match(x):
936 retval.append(MetaPackage.GetOrCreate(x, cache))
941 class ContentWarning(db.Model):
942 id = db.Column(db.Integer, primary_key=True)
943 name = db.Column(db.String(100), unique=True, nullable=False)
944 title = db.Column(db.String(100), nullable=False)
945 description = db.Column(db.String(500), nullable=False)
947 def __init__(self, title, description=""):
949 self.description = description
952 regex = re.compile("[^a-z_]")
953 self.name = regex.sub("", self.title.lower().replace(" ", "_"))
957 id = db.Column(db.Integer, primary_key=True)
958 name = db.Column(db.String(100), unique=True, nullable=False)
959 title = db.Column(db.String(100), nullable=False)
960 description = db.Column(db.String(500), nullable=True, default=None)
961 backgroundColor = db.Column(db.String(6), nullable=False)
962 textColor = db.Column(db.String(6), nullable=False)
963 views = db.Column(db.Integer, nullable=False, default=0)
965 def __init__(self, title, backgroundColor="000000", textColor="ffffff"):
967 self.backgroundColor = backgroundColor
968 self.textColor = textColor
971 regex = re.compile("[^a-z_]")
972 self.name = regex.sub("", self.title.lower().replace(" ", "_"))
975 class MinetestRelease(db.Model):
976 id = db.Column(db.Integer, primary_key=True)
977 name = db.Column(db.String(100), unique=True, nullable=False)
978 protocol = db.Column(db.Integer, nullable=False, default=0)
980 def __init__(self, name=None, protocol=0):
982 self.protocol = protocol
985 return None if self.name == "None" else self
988 def get(cls, version, protocol_num):
990 parts = version.strip().split(".")
992 major_minor = parts[0] + "." + parts[1]
993 query = MinetestRelease.query.filter(MinetestRelease.name.like("{}%".format(major_minor)))
995 query = query.filter_by(protocol=protocol_num)
997 release = query.one_or_none()
1002 return MinetestRelease.query.filter_by(protocol=protocol_num).first()
1007 class PackageRelease(db.Model):
1008 id = db.Column(db.Integer, primary_key=True)
1010 package_id = db.Column(db.Integer, db.ForeignKey("package.id"))
1011 title = db.Column(db.String(100), nullable=False)
1012 releaseDate = db.Column(db.DateTime, nullable=False)
1013 url = db.Column(db.String(200), nullable=False)
1014 approved = db.Column(db.Boolean, nullable=False, default=False)
1015 task_id = db.Column(db.String(37), nullable=True)
1016 commit_hash = db.Column(db.String(41), nullable=True, default=None)
1017 downloads = db.Column(db.Integer, nullable=False, default=0)
1019 min_rel_id = db.Column(db.Integer, db.ForeignKey("minetest_release.id"), nullable=True, server_default=None)
1020 min_rel = db.relationship("MinetestRelease", foreign_keys=[min_rel_id])
1022 max_rel_id = db.Column(db.Integer, db.ForeignKey("minetest_release.id"), nullable=True, server_default=None)
1023 max_rel = db.relationship("MinetestRelease", foreign_keys=[max_rel_id])
1025 # If the release is approved, then the task_id must be null and the url must be present
1026 CK_approval_valid = db.CheckConstraint("not approved OR (task_id IS NULL AND (url = '') IS NOT FALSE)")
1028 def getAsDictionary(self):
1031 "title": self.title,
1032 "url": self.url if self.url != "" else None,
1033 "release_date": self.releaseDate.isoformat(),
1034 "commit": self.commit_hash,
1035 "downloads": self.downloads,
1036 "min_protocol": self.min_rel and self.min_rel.protocol,
1037 "max_protocol": self.max_rel and self.max_rel.protocol
1040 def getEditURL(self):
1041 return url_for("packages.edit_release",
1042 author=self.package.author.username,
1043 name=self.package.name,
1046 def getDeleteURL(self):
1047 return url_for("packages.delete_release",
1048 author=self.package.author.username,
1049 name=self.package.name,
1052 def getDownloadURL(self):
1053 return url_for("packages.download_release",
1054 author=self.package.author.username,
1055 name=self.package.name,
1059 self.releaseDate = datetime.datetime.now()
1061 def approve(self, user):
1062 if not self.package.checkPerm(user, Permission.APPROVE_RELEASE):
1065 assert self.task_id is None and self.url is not None and self.url != ""
1067 self.approved = True
1070 def checkPerm(self, user, perm):
1071 if not user.is_authenticated:
1074 if type(perm) == str:
1075 perm = Permission[perm]
1076 elif type(perm) != Permission:
1077 raise Exception("Unknown permission given to PackageRelease.checkPerm()")
1079 isOwner = user == self.package.author
1081 if perm == Permission.DELETE_RELEASE:
1082 if user.rank.atLeast(UserRank.ADMIN):
1085 if not (isOwner or user.rank.atLeast(UserRank.EDITOR)):
1088 if not self.package.approved or self.task_id is not None:
1091 count = PackageRelease.query \
1092 .filter_by(package_id=self.package_id) \
1093 .filter(PackageRelease.id > self.id) \
1098 raise Exception("Permission {} is not related to releases".format(perm.name))
1101 # class PackageReview(db.Model):
1102 # id = db.Column(db.Integer, primary_key=True)
1103 # package_id = db.Column(db.Integer, db.ForeignKey("package.id"))
1104 # thread_id = db.Column(db.Integer, db.ForeignKey("thread.id"), nullable=False)
1105 # recommend = db.Column(db.Boolean, nullable=False, default=True)
1108 class PackageScreenshot(db.Model):
1109 id = db.Column(db.Integer, primary_key=True)
1110 package_id = db.Column(db.Integer, db.ForeignKey("package.id"))
1111 title = db.Column(db.String(100), nullable=False)
1112 url = db.Column(db.String(100), nullable=False)
1113 approved = db.Column(db.Boolean, nullable=False, default=False)
1116 def getEditURL(self):
1117 return url_for("packages.edit_screenshot",
1118 author=self.package.author.username,
1119 name=self.package.name,
1122 def getThumbnailURL(self, level=2):
1123 return self.url.replace("/uploads/", ("/thumbnails/{:d}/").format(level))
1126 class APIToken(db.Model):
1127 id = db.Column(db.Integer, primary_key=True)
1128 access_token = db.Column(db.String(34), unique=True)
1130 name = db.Column(db.String(100), nullable=False)
1131 owner_id = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
1132 # owner is created using backref
1134 created_at = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
1136 package_id = db.Column(db.Integer, db.ForeignKey("package.id"), nullable=True)
1137 package = db.relationship("Package", foreign_keys=[package_id])
1139 def canOperateOnPackage(self, package):
1140 if self.package and self.package != package:
1143 return package.author == self.owner
1146 class EditRequest(db.Model):
1147 id = db.Column(db.Integer, primary_key=True)
1149 package_id = db.Column(db.Integer, db.ForeignKey("package.id"))
1150 author_id = db.Column(db.Integer, db.ForeignKey("user.id"))
1152 title = db.Column(db.String(100), nullable=False)
1153 desc = db.Column(db.String(1000), nullable=True)
1158 status = db.Column(db.Integer, nullable=False, default=0)
1160 changes = db.relationship("EditRequestChange", backref="request",
1164 return url_for("view_editrequest_page",
1165 author=self.package.author.username,
1166 name=self.package.name,
1169 def getApproveURL(self):
1170 return url_for("approve_editrequest_page",
1171 author=self.package.author.username,
1172 name=self.package.name,
1175 def getRejectURL(self):
1176 return url_for("reject_editrequest_page",
1177 author=self.package.author.username,
1178 name=self.package.name,
1181 def getEditURL(self):
1182 return url_for("create_edit_editrequest_page",
1183 author=self.package.author.username,
1184 name=self.package.name,
1187 def applyAll(self, package):
1188 for change in self.changes:
1189 change.apply(package)
1192 def checkPerm(self, user, perm):
1193 if not user.is_authenticated:
1196 if type(perm) == str:
1197 perm = Permission[perm]
1198 elif type(perm) != Permission:
1199 raise Exception("Unknown permission given to EditRequest.checkPerm()")
1201 isOwner = user == self.author
1203 # Members can edit their own packages, and editors can edit any packages
1204 if perm == Permission.EDIT_EDITREQUEST:
1205 return isOwner or user.rank.atLeast(UserRank.EDITOR)
1208 raise Exception("Permission {} is not related to packages".format(perm.name))
1213 class EditRequestChange(db.Model):
1214 id = db.Column(db.Integer, primary_key=True)
1216 request_id = db.Column(db.Integer, db.ForeignKey("edit_request.id"))
1217 key = db.Column(db.Enum(PackagePropertyKey), nullable=False)
1219 # TODO: make diff instead
1220 oldValue = db.Column(db.Text, nullable=True)
1221 newValue = db.Column(db.Text, nullable=True)
1223 def apply(self, package):
1224 if self.key == PackagePropertyKey.tags:
1225 package.tags.clear()
1226 for tagTitle in self.newValue.split(","):
1227 tag = Tag.query.filter_by(title=tagTitle.strip()).first()
1228 package.tags.append(tag)
1231 setattr(package, self.key.name, self.newValue)
1234 watchers = db.Table("watchers",
1235 db.Column("user_id", db.Integer, db.ForeignKey("user.id"), primary_key=True),
1236 db.Column("thread_id", db.Integer, db.ForeignKey("thread.id"), primary_key=True)
1239 class Thread(db.Model):
1240 id = db.Column(db.Integer, primary_key=True)
1242 package_id = db.Column(db.Integer, db.ForeignKey("package.id"), nullable=True)
1243 package = db.relationship("Package", foreign_keys=[package_id])
1245 review_id = db.Column(db.Integer, db.ForeignKey("package_review.id"), nullable=True)
1246 review = db.relationship("PackageReview", foreign_keys=[review_id])
1248 author_id = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
1249 title = db.Column(db.String(100), nullable=False)
1250 private = db.Column(db.Boolean, server_default="0", nullable=False)
1252 locked = db.Column(db.Boolean, server_default="0", nullable=False)
1254 created_at = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
1256 replies = db.relationship("ThreadReply", backref="thread", lazy="dynamic", \
1257 order_by=db.asc("thread_reply_id"))
1259 watchers = db.relationship("User", secondary=watchers, lazy="subquery", \
1260 backref=db.backref("watching", lazy=True))
1262 def getViewURL(self):
1263 return url_for("threads.view", id=self.id)
1265 def getSubscribeURL(self):
1266 return url_for("threads.subscribe", id=self.id)
1268 def getUnsubscribeURL(self):
1269 return url_for("threads.unsubscribe", id=self.id)
1271 def checkPerm(self, user, perm):
1272 if not user.is_authenticated:
1273 return perm == Permission.SEE_THREAD and not self.private
1275 if type(perm) == str:
1276 perm = Permission[perm]
1277 elif type(perm) != Permission:
1278 raise Exception("Unknown permission given to Thread.checkPerm()")
1280 isMaintainer = user == self.author or (self.package is not None and self.package.author == user)
1282 isMaintainer = isMaintainer or user in self.package.maintainers
1284 canSee = not self.private or isMaintainer or user.rank.atLeast(UserRank.EDITOR)
1286 if perm == Permission.SEE_THREAD:
1289 elif perm == Permission.COMMENT_THREAD:
1290 return canSee and (not self.locked or user.rank.atLeast(UserRank.MODERATOR))
1292 elif perm == Permission.LOCK_THREAD:
1293 return user.rank.atLeast(UserRank.MODERATOR)
1296 raise Exception("Permission {} is not related to threads".format(perm.name))
1298 class ThreadReply(db.Model):
1299 id = db.Column(db.Integer, primary_key=True)
1300 thread_id = db.Column(db.Integer, db.ForeignKey("thread.id"), nullable=False)
1301 comment = db.Column(db.String(2000), nullable=False)
1302 author_id = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
1303 created_at = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
1305 def checkPerm(self, user, perm):
1306 if not user.is_authenticated:
1309 if type(perm) == str:
1310 perm = Permission[perm]
1311 elif type(perm) != Permission:
1312 raise Exception("Unknown permission given to ThreadReply.checkPerm()")
1314 if perm == Permission.EDIT_REPLY:
1315 return user == self.author and user.rank.atLeast(UserRank.MEMBER) and not self.thread.locked
1317 elif perm == Permission.DELETE_REPLY:
1318 return user.rank.atLeast(UserRank.MODERATOR) and self.thread.replies[0] != self
1321 raise Exception("Permission {} is not related to threads".format(perm.name))
1324 class PackageReview(db.Model):
1325 id = db.Column(db.Integer, primary_key=True)
1327 package_id = db.Column(db.Integer, db.ForeignKey("package.id"), nullable=True)
1328 package = db.relationship("Package", foreign_keys=[package_id], backref=db.backref("reviews", lazy=True))
1330 created_at = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
1332 author_id = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
1333 author = db.relationship("User", foreign_keys=[author_id], backref=db.backref("reviews", lazy=True))
1335 recommends = db.Column(db.Boolean, nullable=False)
1337 thread = db.relationship("Thread", uselist=False, back_populates="review")
1340 return 1 if self.recommends else -1
1342 def getEditURL(self):
1343 return self.package.getReviewURL()
1345 def getDeleteURL(self):
1346 return url_for("packages.delete_review",
1347 author=self.package.author.username,
1348 name=self.package.name)
1351 class AuditSeverity(enum.Enum):
1352 NORMAL = 0 # Normal user changes
1353 EDITOR = 1 # Editor changes
1354 MODERATION = 2 # Destructive / moderator changes
1360 return self.name.replace("_", " ").title()
1364 return [(choice, choice.getTitle()) for choice in cls]
1367 def coerce(cls, item):
1368 return item if type(item) == AuditSeverity else AuditSeverity[item]
1372 class AuditLogEntry(db.Model):
1373 id = db.Column(db.Integer, primary_key=True)
1375 created_at = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
1377 causer_id = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
1378 causer = db.relationship("User", foreign_keys=[causer_id])
1380 severity = db.Column(db.Enum(AuditSeverity), nullable=False)
1382 title = db.Column(db.String(100), nullable=False)
1383 url = db.Column(db.String(200), nullable=True)
1385 package_id = db.Column(db.Integer, db.ForeignKey("package.id"), nullable=True)
1386 package = db.relationship("Package", foreign_keys=[package_id])
1388 description = db.Column(db.Text, nullable=True, default=None)
1390 def __init__(self, causer, severity, title, url, package=None, description=None):
1391 if len(title) > 100:
1392 title = title[:99] + "…"
1394 self.causer = causer
1395 self.severity = severity
1398 self.package = package
1399 self.description = description
1404 REPO_BLACKLIST = [".zip", "mediafire.com", "dropbox.com", "weebly.com", \
1405 "minetest.net", "dropboxusercontent.com", "4shared.com", \
1406 "digitalaudioconcepts.com", "hg.intevation.org", "www.wtfpl.net", \
1407 "imageshack.com", "imgur.com"]
1409 class ForumTopic(db.Model):
1410 topic_id = db.Column(db.Integer, primary_key=True, autoincrement=False)
1411 author_id = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
1412 author = db.relationship("User")
1414 wip = db.Column(db.Boolean, server_default="0")
1415 discarded = db.Column(db.Boolean, server_default="0")
1417 type = db.Column(db.Enum(PackageType), nullable=False)
1418 title = db.Column(db.String(200), nullable=False)
1419 name = db.Column(db.String(30), nullable=True)
1420 link = db.Column(db.String(200), nullable=True)
1422 posts = db.Column(db.Integer, nullable=False)
1423 views = db.Column(db.Integer, nullable=False)
1425 created_at = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
1427 def getRepoURL(self):
1428 if self.link is None:
1431 for item in REPO_BLACKLIST:
1432 if item in self.link:
1435 return self.link.replace("repo.or.cz/w/", "repo.or.cz/")
1437 def getAsDictionary(self):
1439 "author": self.author.username,
1441 "type": self.type.toName(),
1442 "title": self.title,
1443 "id": self.topic_id,
1445 "posts": self.posts,
1446 "views": self.views,
1448 "discarded": self.discarded,
1449 "created_at": self.created_at.isoformat(),
1452 def checkPerm(self, user, perm):
1453 if not user.is_authenticated:
1456 if type(perm) == str:
1457 perm = Permission[perm]
1458 elif type(perm) != Permission:
1459 raise Exception("Unknown permission given to ForumTopic.checkPerm()")
1461 if perm == Permission.TOPIC_DISCARD:
1462 return self.author == user or user.rank.atLeast(UserRank.EDITOR)
1465 raise Exception("Permission {} is not related to topics".format(perm.name))
1469 user_manager = UserManager(app, db, User)
1471 if app.config.get("LOG_SQL"):
1473 logging.basicConfig()
1474 logging.getLogger('sqlalchemy.engine').setLevel(logging.INFO)