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")
168 packages = db.relationship("Package", backref=db.backref("author", lazy="joined"), lazy="dynamic")
169 requests = db.relationship("EditRequest", backref="author", lazy="dynamic")
170 threads = db.relationship("Thread", backref="author", lazy="dynamic")
171 tokens = db.relationship("APIToken", backref="owner", lazy="dynamic")
172 replies = db.relationship("ThreadReply", backref="author", lazy="dynamic")
174 def __init__(self, username=None, active=False, email=None, password=""):
175 self.username = username
176 self.email_confirmed_at = datetime.datetime.now() - datetime.timedelta(days=6000)
177 self.display_name = username
180 self.password = password
181 self.rank = UserRank.NOT_JOINED
183 def hasPassword(self):
184 return self.password != ""
186 def canAccessTodoList(self):
187 return Permission.APPROVE_NEW.check(self) or \
188 Permission.APPROVE_RELEASE.check(self) or \
189 Permission.APPROVE_CHANGES.check(self)
192 return self.rank.atLeast(UserRank.NEW_MEMBER)
194 def getProfilePicURL(self):
196 return self.profile_pic
198 return gravatar(self.email or "")
200 def checkPerm(self, user, perm):
201 if not user.is_authenticated:
204 if type(perm) == str:
205 perm = Permission[perm]
206 elif type(perm) != Permission:
207 raise Exception("Unknown permission given to User.checkPerm()")
209 # Members can edit their own packages, and editors can edit any packages
210 if perm == Permission.CHANGE_AUTHOR:
211 return user.rank.atLeast(UserRank.EDITOR)
212 elif perm == Permission.CHANGE_RANK or perm == Permission.CHANGE_USERNAMES:
213 return user.rank.atLeast(UserRank.MODERATOR)
214 elif perm == Permission.CHANGE_EMAIL or perm == Permission.CHANGE_PROFILE_URLS:
215 return user == self or user.rank.atLeast(UserRank.ADMIN)
216 elif perm == Permission.CREATE_TOKEN:
218 return user.rank.atLeast(UserRank.MEMBER)
220 return user.rank.atLeast(UserRank.MODERATOR) and user.rank.atLeast(self.rank)
222 raise Exception("Permission {} is not related to users".format(perm.name))
224 def canCommentRL(self):
226 if self.rank.atLeast(UserRank.ADMIN):
228 elif self.rank.atLeast(UserRank.TRUSTED_MEMBER):
231 one_min_ago = datetime.datetime.utcnow() - datetime.timedelta(minutes=1)
232 if ThreadReply.query.filter_by(author=self) \
233 .filter(ThreadReply.created_at > one_min_ago).count() >= 3 * factor:
236 hour_ago = datetime.datetime.utcnow() - datetime.timedelta(hours=1)
237 if ThreadReply.query.filter_by(author=self) \
238 .filter(ThreadReply.created_at > hour_ago).count() >= 20 * factor:
243 def canOpenThreadRL(self):
245 if self.rank.atLeast(UserRank.ADMIN):
247 elif self.rank.atLeast(UserRank.TRUSTED_MEMBER):
250 hour_ago = datetime.datetime.utcnow() - datetime.timedelta(hours=1)
251 return Thread.query.filter_by(author=self) \
252 .filter(Thread.created_at > hour_ago).count() < 2 * factor
254 def __eq__(self, other):
258 if not self.is_authenticated or not other.is_authenticated:
262 return self.id == other.id
264 class UserEmailVerification(db.Model):
265 id = db.Column(db.Integer, primary_key=True)
266 user_id = db.Column(db.Integer, db.ForeignKey("user.id"))
267 email = db.Column(db.String(100))
268 token = db.Column(db.String(32))
269 user = db.relationship("User", foreign_keys=[user_id])
271 class Notification(db.Model):
272 id = db.Column(db.Integer, primary_key=True)
274 user_id = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
275 user = db.relationship("User", foreign_keys=[user_id])
277 causer_id = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
278 causer = db.relationship("User", foreign_keys=[causer_id])
280 title = db.Column(db.String(100), nullable=False)
281 url = db.Column(db.String(200), nullable=True)
283 package_id = db.Column(db.Integer, db.ForeignKey("package.id"), nullable=True)
284 package = db.relationship("Package", foreign_keys=[package_id])
286 created_at = db.Column(db.DateTime, nullable=True, default=datetime.datetime.utcnow)
288 def __init__(self, user, causer, title, url, package=None):
290 title = title[:99] + "…"
296 self.package = package
299 class License(db.Model):
300 id = db.Column(db.Integer, primary_key=True)
301 name = db.Column(db.String(50), nullable=False, unique=True)
302 is_foss = db.Column(db.Boolean, nullable=False, default=True)
304 def __init__(self, v, is_foss=True):
306 self.is_foss = is_foss
312 class PackageType(enum.Enum):
318 return self.name.lower()
326 return PackageType[name.upper()]
332 return [(choice, choice.value) for choice in cls]
335 def coerce(cls, item):
336 return item if type(item) == PackageType else PackageType[item]
339 class PackageState(enum.Enum):
340 WIP = "Work in Progress"
341 CHANGES_NEEDED = "Changes Needed"
342 READY_FOR_REVIEW = "Ready for Review"
343 APPROVED = "Approved"
347 return self.name.lower()
350 if self == self.READY_FOR_REVIEW:
351 return "Submit for Review"
352 elif self == self.APPROVED:
354 elif self == self.DELETED:
365 return PackageState[name.upper()]
371 return [(choice, choice.value) for choice in cls]
374 def coerce(cls, item):
375 return item if type(item) == PackageState else PackageState[item]
378 PACKAGE_STATE_FLOW = {
379 PackageState.WIP: set([ PackageState.READY_FOR_REVIEW ]),
380 PackageState.CHANGES_NEEDED: set([ PackageState.READY_FOR_REVIEW ]),
381 PackageState.READY_FOR_REVIEW: set([ PackageState.WIP, PackageState.CHANGES_NEEDED, PackageState.APPROVED ]),
382 PackageState.APPROVED: set([ PackageState.CHANGES_NEEDED ]),
383 PackageState.DELETED: set([ PackageState.READY_FOR_REVIEW ]),
387 class PackagePropertyKey(enum.Enum):
390 short_desc = "Short Description"
394 media_license = "Media License"
396 provides = "Provides"
399 issueTracker = "Issue Tracker"
400 forums = "Forum Topic ID"
402 def convert(self, value):
403 if self == PackagePropertyKey.tags:
404 return ",".join([t.title for t in value])
405 elif self == PackagePropertyKey.provides:
406 return ",".join([t.name for t in value])
410 provides = db.Table("provides",
411 db.Column("package_id", db.Integer, db.ForeignKey("package.id"), primary_key=True),
412 db.Column("metapackage_id", db.Integer, db.ForeignKey("meta_package.id"), primary_key=True)
415 Tags = db.Table("tags",
416 db.Column("tag_id", db.Integer, db.ForeignKey("tag.id"), primary_key=True),
417 db.Column("package_id", db.Integer, db.ForeignKey("package.id"), primary_key=True)
420 ContentWarnings = db.Table("content_warnings",
421 db.Column("content_warning_id", db.Integer, db.ForeignKey("content_warning.id"), primary_key=True),
422 db.Column("package_id", db.Integer, db.ForeignKey("package.id"), primary_key=True)
425 maintainers = db.Table("maintainers",
426 db.Column("user_id", db.Integer, db.ForeignKey("user.id"), primary_key=True),
427 db.Column("package_id", db.Integer, db.ForeignKey("package.id"), primary_key=True)
430 class Dependency(db.Model):
431 id = db.Column(db.Integer, primary_key=True)
432 depender_id = db.Column(db.Integer, db.ForeignKey("package.id"), nullable=True)
433 package_id = db.Column(db.Integer, db.ForeignKey("package.id"), nullable=True)
434 package = db.relationship("Package", foreign_keys=[package_id])
435 meta_package_id = db.Column(db.Integer, db.ForeignKey("meta_package.id"), nullable=True)
436 optional = db.Column(db.Boolean, nullable=False, default=False)
437 __table_args__ = (db.UniqueConstraint("depender_id", "package_id", "meta_package_id", name="_dependency_uc"), )
439 def __init__(self, depender=None, package=None, meta=None, optional=False):
443 self.depender = depender
444 self.optional = optional
446 packageProvided = package is not None
447 metaProvided = meta is not None
449 if packageProvided and not metaProvided:
450 self.package = package
451 elif metaProvided and not packageProvided:
452 self.meta_package = meta
454 raise Exception("Either meta or package must be given, but not both!")
457 if self.meta_package:
458 return self.meta_package.name
460 return self.package.name
465 if self.package is not None:
466 return self.package.author.username + "/" + self.package.name
467 elif self.meta_package is not None:
468 return self.meta_package.name
470 raise Exception("Meta and package are both none!")
473 def SpecToList(depender, spec, cache={}):
475 arr = spec.split(",")
478 pattern1 = re.compile("^([a-z0-9_]+)$")
479 pattern2 = re.compile("^([A-Za-z0-9_]+)/([a-z0-9_]+)$")
486 if pattern1.match(x):
487 meta = MetaPackage.GetOrCreate(x, cache)
488 retval.append(Dependency(depender, meta=meta))
490 m = pattern2.match(x)
491 username = m.group(1)
493 user = User.query.filter_by(username=username).first()
495 raise Exception("Unable to find user " + username)
497 package = Package.query.filter_by(author=user, name=name).first()
499 raise Exception("Unable to find package " + name + " by " + username)
501 retval.append(Dependency(depender, package=package))
506 class Package(db.Model):
507 query_class = ArticleQuery
509 id = db.Column(db.Integer, primary_key=True)
512 author_id = db.Column(db.Integer, db.ForeignKey("user.id"))
513 name = db.Column(db.Unicode(100), nullable=False)
514 title = db.Column(db.Unicode(100), nullable=False)
515 short_desc = db.Column(db.Unicode(200), nullable=False)
516 desc = db.Column(db.UnicodeText, nullable=True)
517 type = db.Column(db.Enum(PackageType))
518 created_at = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
519 approved_at = db.Column(db.DateTime, nullable=True, default=None)
521 name_valid = db.CheckConstraint("name ~* '^[a-z0-9_]+$'")
523 search_vector = db.Column(TSVectorType("name", "title", "short_desc", "desc", \
524 weights={ "name": "A", "title": "B", "short_desc": "C", "desc": "D" }))
526 license_id = db.Column(db.Integer, db.ForeignKey("license.id"), nullable=False, default=1)
527 license = db.relationship("License", foreign_keys=[license_id])
528 media_license_id = db.Column(db.Integer, db.ForeignKey("license.id"), nullable=False, default=1)
529 media_license = db.relationship("License", foreign_keys=[media_license_id])
531 state = db.Column(db.Enum(PackageState), default=PackageState.WIP)
535 return self.state == PackageState.APPROVED
537 score = db.Column(db.Float, nullable=False, default=0)
538 score_downloads = db.Column(db.Float, nullable=False, default=0)
539 downloads = db.Column(db.Integer, nullable=False, default=0)
541 review_thread_id = db.Column(db.Integer, db.ForeignKey("thread.id"), nullable=True, default=None)
542 review_thread = db.relationship("Thread", foreign_keys=[review_thread_id])
545 repo = db.Column(db.String(200), nullable=True)
546 website = db.Column(db.String(200), nullable=True)
547 issueTracker = db.Column(db.String(200), nullable=True)
548 forums = db.Column(db.Integer, nullable=True)
550 provides = db.relationship("MetaPackage", \
551 secondary=provides, lazy="select", order_by=db.asc("name"), \
552 backref=db.backref("packages", lazy="dynamic", order_by=db.desc("score")))
554 dependencies = db.relationship("Dependency", backref="depender", lazy="dynamic", foreign_keys=[Dependency.depender_id])
556 tags = db.relationship("Tag", secondary=Tags, lazy="select",
557 backref=db.backref("packages", lazy=True))
559 content_warnings = db.relationship("ContentWarning", secondary=ContentWarnings, lazy="select",
560 backref=db.backref("packages", lazy=True))
562 releases = db.relationship("PackageRelease", backref="package",
563 lazy="dynamic", order_by=db.desc("package_release_releaseDate"))
565 screenshots = db.relationship("PackageScreenshot", backref="package",
566 lazy="dynamic", order_by=db.asc("package_screenshot_id"))
568 requests = db.relationship("EditRequest", backref="package",
571 maintainers = db.relationship("User", secondary=maintainers, lazy="subquery")
573 def __init__(self, package=None):
577 self.author_id = package.author_id
578 self.created_at = package.created_at
579 self.state = package.state
581 self.maintainers.append(self.author)
583 for e in PackagePropertyKey:
584 setattr(self, e.name, getattr(package, e.name))
587 return "{}/{}".format(self.author.username, self.name)
590 return self.license.is_foss and self.media_license.is_foss
592 def getIsOnGitHub(self):
593 if self.repo is None:
596 url = urlparse(self.repo)
597 return url.netloc == "github.com"
599 def getGitHubFullName(self):
600 if self.repo is None:
603 url = urlparse(self.repo)
604 if url.netloc != "github.com":
608 m = re.search(r"^\/([^\/]+)\/([^\/]+)\/?$", url.path)
613 repo = m.group(2).replace(".git", "")
617 def getSortedDependencies(self, is_hard=None):
618 query = self.dependencies
619 if is_hard is not None:
620 query = query.filter_by(optional=not is_hard)
623 deps.sort(key = lambda x: x.getName())
626 def getSortedHardDependencies(self):
627 return self.getSortedDependencies(True)
629 def getSortedOptionalDependencies(self):
630 return self.getSortedDependencies(False)
632 def getAsDictionaryKey(self):
635 "author": self.author.display_name,
636 "type": self.type.toName(),
639 def getAsDictionaryShort(self, base_url, version=None):
640 tnurl = self.getThumbnailURL(1)
641 release = self.getDownloadRelease(version=version)
645 "author": self.author.username,
646 "short_description": self.short_desc,
647 "type": self.type.toName(),
648 "release": release and release.id,
649 "thumbnail": (base_url + tnurl) if tnurl is not None else None
652 def getAsDictionary(self, base_url, version=None):
653 tnurl = self.getThumbnailURL(1)
654 release = self.getDownloadRelease(version=version)
656 "author": self.author.username,
659 "short_description": self.short_desc,
661 "type": self.type.toName(),
662 "created_at": self.created_at.isoformat(),
664 "license": self.license.name,
665 "media_license": self.media_license.name,
668 "website": self.website,
669 "issue_tracker": self.issueTracker,
670 "forums": self.forums,
672 "provides": [x.name for x in self.provides],
673 "thumbnail": (base_url + tnurl) if tnurl is not None else None,
674 "screenshots": [base_url + ss.url for ss in self.screenshots],
676 "url": base_url + self.getDownloadURL(),
677 "release": release and release.id,
679 "score": round(self.score * 10) / 10,
680 "downloads": self.downloads
683 def getThumbnailURL(self, level=2):
684 screenshot = self.screenshots.filter_by(approved=True).order_by(db.asc(PackageScreenshot.id)).first()
685 return screenshot.getThumbnailURL(level) if screenshot is not None else None
687 def getMainScreenshotURL(self, absolute=False):
688 screenshot = self.screenshots.filter_by(approved=True).order_by(db.asc(PackageScreenshot.id)).first()
689 if screenshot is None:
693 from app.utils import abs_url
694 return abs_url(screenshot.url)
696 return screenshot.url
698 def getDetailsURL(self, absolute=False):
700 from app.utils import abs_url_for
701 return abs_url_for("packages.view",
702 author=self.author.username, name=self.name)
704 return url_for("packages.view",
705 author=self.author.username, name=self.name)
707 def getShieldURL(self, type):
708 from app.utils import abs_url_for
709 return abs_url_for("packages.shield",
710 author=self.author.username, name=self.name, type=type)
712 def makeShield(self, type):
713 return "[![ContentDB]({})]({})" \
714 .format(self.getShieldURL(type), self.getDetailsURL(True))
716 def getEditURL(self):
717 return url_for("packages.create_edit",
718 author=self.author.username, name=self.name)
720 def getSetStateURL(self, state):
721 if type(state) == str:
722 state = PackageState[perm]
723 elif type(state) != PackageState:
724 raise Exception("Unknown state given to Package.canMoveToState()")
726 return url_for("packages.move_to_state",
727 author=self.author.username, name=self.name, state=state.name.lower())
729 def getRemoveURL(self):
730 return url_for("packages.remove",
731 author=self.author.username, name=self.name)
733 def getNewScreenshotURL(self):
734 return url_for("packages.create_screenshot",
735 author=self.author.username, name=self.name)
737 def getCreateReleaseURL(self):
738 return url_for("packages.create_release",
739 author=self.author.username, name=self.name)
741 def getCreateEditRequestURL(self):
742 return url_for("create_edit_editrequest_page",
743 author=self.author.username, name=self.name)
745 def getBulkReleaseURL(self):
746 return url_for("packages.bulk_change_release",
747 author=self.author.username, name=self.name)
749 def getDownloadURL(self):
750 return url_for("packages.download",
751 author=self.author.username, name=self.name)
753 def getEditMaintainersURL(self):
754 return url_for("packages.edit_maintainers",
755 author=self.author.username, name=self.name)
757 def getRemoveSelfMaintainerURL(self):
758 return url_for("packages.remove_self_maintainers",
759 author=self.author.username, name=self.name)
761 def getUpdateFromReleaseURL(self):
762 return url_for("packages.update_from_release",
763 author=self.author.username, name=self.name)
765 def getReviewURL(self):
766 return url_for('packages.review',
767 author=self.author.username, name=self.name)
769 def getDownloadRelease(self, version=None):
770 for rel in self.releases:
771 if rel.approved and (version is None or
772 ((rel.min_rel is None or rel.min_rel_id <= version.id) and \
773 (rel.max_rel is None or rel.max_rel_id >= version.id))):
778 def checkPerm(self, user, perm):
779 if not user.is_authenticated:
782 if type(perm) == str:
783 perm = Permission[perm]
784 elif type(perm) != Permission:
785 raise Exception("Unknown permission given to Package.checkPerm()")
787 isOwner = user == self.author
788 isMaintainer = isOwner or user.rank.atLeast(UserRank.EDITOR) or user in self.maintainers
790 if perm == Permission.CREATE_THREAD:
791 return user.rank.atLeast(UserRank.MEMBER)
793 # Members can edit their own packages, and editors can edit any packages
794 elif perm == Permission.MAKE_RELEASE or perm == Permission.ADD_SCREENSHOTS:
797 elif perm == Permission.EDIT_PACKAGE or \
798 perm == Permission.APPROVE_CHANGES or perm == Permission.APPROVE_RELEASE:
799 return isMaintainer and user.rank.atLeast(UserRank.MEMBER if self.approved else UserRank.NEW_MEMBER)
801 # Anyone can change the package name when not approved, but only editors when approved
802 elif perm == Permission.CHANGE_NAME:
803 return not self.approved or user.rank.atLeast(UserRank.EDITOR)
805 # Editors can change authors and approve new packages
806 elif perm == Permission.APPROVE_NEW or perm == Permission.CHANGE_AUTHOR:
807 return user.rank.atLeast(UserRank.EDITOR)
809 elif perm == Permission.APPROVE_SCREENSHOT:
810 return isMaintainer and user.rank.atLeast(UserRank.TRUSTED_MEMBER if self.approved else UserRank.NEW_MEMBER)
812 elif perm == Permission.EDIT_MAINTAINERS:
813 return isOwner or user.rank.atLeast(UserRank.MODERATOR)
815 elif perm == Permission.UNAPPROVE_PACKAGE or perm == Permission.DELETE_PACKAGE:
816 return user.rank.atLeast(UserRank.EDITOR)
818 elif perm == Permission.CHANGE_RELEASE_URL:
819 return user.rank.atLeast(UserRank.MODERATOR)
821 elif perm == Permission.REIMPORT_META:
822 return user.rank.atLeast(UserRank.ADMIN)
825 raise Exception("Permission {} is not related to packages".format(perm.name))
828 def canMoveToState(self, user, state):
829 if not user.is_authenticated:
832 if type(state) == str:
833 state = PackageState[perm]
834 elif type(state) != PackageState:
835 raise Exception("Unknown state given to Package.canMoveToState()")
837 if state not in PACKAGE_STATE_FLOW[self.state]:
840 if state == PackageState.READY_FOR_REVIEW or state == PackageState.APPROVED:
841 requiredPerm = Permission.APPROVE_NEW if state == PackageState.APPROVED else Permission.EDIT_PACKAGE
843 if not self.checkPerm(user, requiredPerm):
846 if state == PackageState.APPROVED and \
847 ("Other" in self.license.name or "Other" in self.media_license.name):
851 (self.type == self.type.GAME or self.type == self.type.TXP) and \
852 self.screenshots.count() == 0
853 return self.releases.count() > 0 and not needsScreenshot
855 elif state == PackageState.CHANGES_NEEDED:
856 return self.checkPerm(user, Permission.APPROVE_NEW)
858 elif state == PackageState.WIP:
859 return self.checkPerm(user, Permission.EDIT_PACKAGE) and user in self.maintainers
864 def getNextStates(self, user):
867 for state in PackageState:
868 if self.canMoveToState(user, state):
874 def getScoreDict(self):
876 "author": self.author.username,
879 "score_downloads": self.score_downloads,
880 "score_reviews": self.score - self.score_downloads,
881 "downloads": self.downloads
884 def recalcScore(self):
885 review_scores = [ 100 * r.asSign() for r in self.reviews ]
886 self.score = self.score_downloads + sum(review_scores)
889 class MetaPackage(db.Model):
890 id = db.Column(db.Integer, primary_key=True)
891 name = db.Column(db.String(100), unique=True, nullable=False)
892 dependencies = db.relationship("Dependency", backref="meta_package", lazy="dynamic")
894 mp_name_valid = db.CheckConstraint("name ~* '^[a-z0-9_]+$'")
896 def __init__(self, name=None):
903 def ListToSpec(list):
904 return ",".join([str(x) for x in list])
907 def GetOrCreate(name, cache={}):
910 mp = MetaPackage.query.filter_by(name=name).first()
913 mp = MetaPackage(name)
920 def SpecToList(spec, cache={}):
922 arr = spec.split(",")
925 pattern = re.compile("^([a-z0-9_]+)$")
932 if not pattern.match(x):
935 retval.append(MetaPackage.GetOrCreate(x, cache))
940 class ContentWarning(db.Model):
941 id = db.Column(db.Integer, primary_key=True)
942 name = db.Column(db.String(100), unique=True, nullable=False)
943 title = db.Column(db.String(100), nullable=False)
944 description = db.Column(db.String(500), nullable=False)
946 def __init__(self, title, description=""):
948 self.description = description
951 regex = re.compile("[^a-z_]")
952 self.name = regex.sub("", self.title.lower().replace(" ", "_"))
956 id = db.Column(db.Integer, primary_key=True)
957 name = db.Column(db.String(100), unique=True, nullable=False)
958 title = db.Column(db.String(100), nullable=False)
959 description = db.Column(db.String(500), nullable=True, default=None)
960 backgroundColor = db.Column(db.String(6), nullable=False)
961 textColor = db.Column(db.String(6), nullable=False)
962 views = db.Column(db.Integer, nullable=False, default=0)
964 def __init__(self, title, backgroundColor="000000", textColor="ffffff"):
966 self.backgroundColor = backgroundColor
967 self.textColor = textColor
970 regex = re.compile("[^a-z_]")
971 self.name = regex.sub("", self.title.lower().replace(" ", "_"))
974 class MinetestRelease(db.Model):
975 id = db.Column(db.Integer, primary_key=True)
976 name = db.Column(db.String(100), unique=True, nullable=False)
977 protocol = db.Column(db.Integer, nullable=False, default=0)
979 def __init__(self, name=None, protocol=0):
981 self.protocol = protocol
984 return None if self.name == "None" else self
987 def get(cls, version, protocol_num):
989 parts = version.strip().split(".")
991 major_minor = parts[0] + "." + parts[1]
992 query = MinetestRelease.query.filter(MinetestRelease.name.like("{}%".format(major_minor)))
994 query = query.filter_by(protocol=protocol_num)
996 release = query.one_or_none()
1001 return MinetestRelease.query.filter_by(protocol=protocol_num).first()
1006 class PackageRelease(db.Model):
1007 id = db.Column(db.Integer, primary_key=True)
1009 package_id = db.Column(db.Integer, db.ForeignKey("package.id"))
1010 title = db.Column(db.String(100), nullable=False)
1011 releaseDate = db.Column(db.DateTime, nullable=False)
1012 url = db.Column(db.String(200), nullable=False)
1013 approved = db.Column(db.Boolean, nullable=False, default=False)
1014 task_id = db.Column(db.String(37), nullable=True)
1015 commit_hash = db.Column(db.String(41), nullable=True, default=None)
1016 downloads = db.Column(db.Integer, nullable=False, default=0)
1018 min_rel_id = db.Column(db.Integer, db.ForeignKey("minetest_release.id"), nullable=True, server_default=None)
1019 min_rel = db.relationship("MinetestRelease", foreign_keys=[min_rel_id])
1021 max_rel_id = db.Column(db.Integer, db.ForeignKey("minetest_release.id"), nullable=True, server_default=None)
1022 max_rel = db.relationship("MinetestRelease", foreign_keys=[max_rel_id])
1024 # If the release is approved, then the task_id must be null and the url must be present
1025 CK_approval_valid = db.CheckConstraint("not approved OR (task_id IS NULL AND (url = '') IS NOT FALSE)")
1027 def getAsDictionary(self):
1030 "title": self.title,
1031 "url": self.url if self.url != "" else None,
1032 "release_date": self.releaseDate.isoformat(),
1033 "commit": self.commit_hash,
1034 "downloads": self.downloads,
1035 "min_protocol": self.min_rel and self.min_rel.protocol,
1036 "max_protocol": self.max_rel and self.max_rel.protocol
1039 def getEditURL(self):
1040 return url_for("packages.edit_release",
1041 author=self.package.author.username,
1042 name=self.package.name,
1045 def getDeleteURL(self):
1046 return url_for("packages.delete_release",
1047 author=self.package.author.username,
1048 name=self.package.name,
1051 def getDownloadURL(self):
1052 return url_for("packages.download_release",
1053 author=self.package.author.username,
1054 name=self.package.name,
1058 self.releaseDate = datetime.datetime.now()
1060 def approve(self, user):
1061 if not self.package.checkPerm(user, Permission.APPROVE_RELEASE):
1064 assert self.task_id is None and self.url is not None and self.url != ""
1066 self.approved = True
1069 def checkPerm(self, user, perm):
1070 if not user.is_authenticated:
1073 if type(perm) == str:
1074 perm = Permission[perm]
1075 elif type(perm) != Permission:
1076 raise Exception("Unknown permission given to PackageRelease.checkPerm()")
1078 isOwner = user == self.package.author
1080 if perm == Permission.DELETE_RELEASE:
1081 if user.rank.atLeast(UserRank.ADMIN):
1084 if not (isOwner or user.rank.atLeast(UserRank.EDITOR)):
1087 if not self.package.approved or self.task_id is not None:
1090 count = PackageRelease.query \
1091 .filter_by(package_id=self.package_id) \
1092 .filter(PackageRelease.id > self.id) \
1097 raise Exception("Permission {} is not related to releases".format(perm.name))
1100 # class PackageReview(db.Model):
1101 # id = db.Column(db.Integer, primary_key=True)
1102 # package_id = db.Column(db.Integer, db.ForeignKey("package.id"))
1103 # thread_id = db.Column(db.Integer, db.ForeignKey("thread.id"), nullable=False)
1104 # recommend = db.Column(db.Boolean, nullable=False, default=True)
1107 class PackageScreenshot(db.Model):
1108 id = db.Column(db.Integer, primary_key=True)
1109 package_id = db.Column(db.Integer, db.ForeignKey("package.id"))
1110 title = db.Column(db.String(100), nullable=False)
1111 url = db.Column(db.String(100), nullable=False)
1112 approved = db.Column(db.Boolean, nullable=False, default=False)
1115 def getEditURL(self):
1116 return url_for("packages.edit_screenshot",
1117 author=self.package.author.username,
1118 name=self.package.name,
1121 def getThumbnailURL(self, level=2):
1122 return self.url.replace("/uploads/", ("/thumbnails/{:d}/").format(level))
1125 class APIToken(db.Model):
1126 id = db.Column(db.Integer, primary_key=True)
1127 access_token = db.Column(db.String(34), unique=True)
1129 name = db.Column(db.String(100), nullable=False)
1130 owner_id = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
1131 # owner is created using backref
1133 created_at = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
1135 package_id = db.Column(db.Integer, db.ForeignKey("package.id"), nullable=True)
1136 package = db.relationship("Package", foreign_keys=[package_id])
1138 def canOperateOnPackage(self, package):
1139 if self.package and self.package != package:
1142 return package.author == self.owner
1145 class EditRequest(db.Model):
1146 id = db.Column(db.Integer, primary_key=True)
1148 package_id = db.Column(db.Integer, db.ForeignKey("package.id"))
1149 author_id = db.Column(db.Integer, db.ForeignKey("user.id"))
1151 title = db.Column(db.String(100), nullable=False)
1152 desc = db.Column(db.String(1000), nullable=True)
1157 status = db.Column(db.Integer, nullable=False, default=0)
1159 changes = db.relationship("EditRequestChange", backref="request",
1163 return url_for("view_editrequest_page",
1164 author=self.package.author.username,
1165 name=self.package.name,
1168 def getApproveURL(self):
1169 return url_for("approve_editrequest_page",
1170 author=self.package.author.username,
1171 name=self.package.name,
1174 def getRejectURL(self):
1175 return url_for("reject_editrequest_page",
1176 author=self.package.author.username,
1177 name=self.package.name,
1180 def getEditURL(self):
1181 return url_for("create_edit_editrequest_page",
1182 author=self.package.author.username,
1183 name=self.package.name,
1186 def applyAll(self, package):
1187 for change in self.changes:
1188 change.apply(package)
1191 def checkPerm(self, user, perm):
1192 if not user.is_authenticated:
1195 if type(perm) == str:
1196 perm = Permission[perm]
1197 elif type(perm) != Permission:
1198 raise Exception("Unknown permission given to EditRequest.checkPerm()")
1200 isOwner = user == self.author
1202 # Members can edit their own packages, and editors can edit any packages
1203 if perm == Permission.EDIT_EDITREQUEST:
1204 return isOwner or user.rank.atLeast(UserRank.EDITOR)
1207 raise Exception("Permission {} is not related to packages".format(perm.name))
1212 class EditRequestChange(db.Model):
1213 id = db.Column(db.Integer, primary_key=True)
1215 request_id = db.Column(db.Integer, db.ForeignKey("edit_request.id"))
1216 key = db.Column(db.Enum(PackagePropertyKey), nullable=False)
1218 # TODO: make diff instead
1219 oldValue = db.Column(db.Text, nullable=True)
1220 newValue = db.Column(db.Text, nullable=True)
1222 def apply(self, package):
1223 if self.key == PackagePropertyKey.tags:
1224 package.tags.clear()
1225 for tagTitle in self.newValue.split(","):
1226 tag = Tag.query.filter_by(title=tagTitle.strip()).first()
1227 package.tags.append(tag)
1230 setattr(package, self.key.name, self.newValue)
1233 watchers = db.Table("watchers",
1234 db.Column("user_id", db.Integer, db.ForeignKey("user.id"), primary_key=True),
1235 db.Column("thread_id", db.Integer, db.ForeignKey("thread.id"), primary_key=True)
1238 class Thread(db.Model):
1239 id = db.Column(db.Integer, primary_key=True)
1241 package_id = db.Column(db.Integer, db.ForeignKey("package.id"), nullable=True)
1242 package = db.relationship("Package", foreign_keys=[package_id])
1244 review_id = db.Column(db.Integer, db.ForeignKey("package_review.id"), nullable=True)
1245 review = db.relationship("PackageReview", foreign_keys=[review_id])
1247 author_id = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
1248 title = db.Column(db.String(100), nullable=False)
1249 private = db.Column(db.Boolean, server_default="0", nullable=False)
1251 locked = db.Column(db.Boolean, server_default="0", nullable=False)
1253 created_at = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
1255 replies = db.relationship("ThreadReply", backref="thread", lazy="dynamic", \
1256 order_by=db.asc("thread_reply_id"))
1258 watchers = db.relationship("User", secondary=watchers, lazy="subquery", \
1259 backref=db.backref("watching", lazy=True))
1261 def getViewURL(self):
1262 return url_for("threads.view", id=self.id)
1264 def getSubscribeURL(self):
1265 return url_for("threads.subscribe", id=self.id)
1267 def getUnsubscribeURL(self):
1268 return url_for("threads.unsubscribe", id=self.id)
1270 def checkPerm(self, user, perm):
1271 if not user.is_authenticated:
1272 return perm == Permission.SEE_THREAD and not self.private
1274 if type(perm) == str:
1275 perm = Permission[perm]
1276 elif type(perm) != Permission:
1277 raise Exception("Unknown permission given to Thread.checkPerm()")
1279 isMaintainer = user == self.author or (self.package is not None and self.package.author == user)
1281 isMaintainer = isMaintainer or user in self.package.maintainers
1283 canSee = not self.private or isMaintainer or user.rank.atLeast(UserRank.EDITOR)
1285 if perm == Permission.SEE_THREAD:
1288 elif perm == Permission.COMMENT_THREAD:
1289 return canSee and (not self.locked or user.rank.atLeast(UserRank.MODERATOR))
1291 elif perm == Permission.LOCK_THREAD:
1292 return user.rank.atLeast(UserRank.MODERATOR)
1295 raise Exception("Permission {} is not related to threads".format(perm.name))
1297 class ThreadReply(db.Model):
1298 id = db.Column(db.Integer, primary_key=True)
1299 thread_id = db.Column(db.Integer, db.ForeignKey("thread.id"), nullable=False)
1300 comment = db.Column(db.String(2000), nullable=False)
1301 author_id = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
1302 created_at = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
1304 def checkPerm(self, user, perm):
1305 if not user.is_authenticated:
1308 if type(perm) == str:
1309 perm = Permission[perm]
1310 elif type(perm) != Permission:
1311 raise Exception("Unknown permission given to ThreadReply.checkPerm()")
1313 if perm == Permission.EDIT_REPLY:
1314 return user == self.author and user.rank.atLeast(UserRank.MEMBER) and not self.thread.locked
1316 elif perm == Permission.DELETE_REPLY:
1317 return user.rank.atLeast(UserRank.MODERATOR) and self.thread.replies[0] != self
1320 raise Exception("Permission {} is not related to threads".format(perm.name))
1323 class PackageReview(db.Model):
1324 id = db.Column(db.Integer, primary_key=True)
1326 package_id = db.Column(db.Integer, db.ForeignKey("package.id"), nullable=True)
1327 package = db.relationship("Package", foreign_keys=[package_id], backref=db.backref("reviews", lazy=True))
1329 created_at = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
1331 author_id = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
1332 author = db.relationship("User", foreign_keys=[author_id], backref=db.backref("reviews", lazy=True))
1334 recommends = db.Column(db.Boolean, nullable=False)
1336 thread = db.relationship("Thread", uselist=False, back_populates="review")
1339 return 1 if self.recommends else -1
1341 def getEditURL(self):
1342 return self.package.getReviewURL()
1344 def getDeleteURL(self):
1345 return url_for("packages.delete_review",
1346 author=self.package.author.username,
1347 name=self.package.name)
1350 class AuditSeverity(enum.Enum):
1351 NORMAL = 0 # Normal user changes
1352 EDITOR = 1 # Editor changes
1353 MODERATION = 2 # Destructive / moderator changes
1359 return self.name.replace("_", " ").title()
1363 return [(choice, choice.getTitle()) for choice in cls]
1366 def coerce(cls, item):
1367 return item if type(item) == AuditSeverity else AuditSeverity[item]
1371 class AuditLogEntry(db.Model):
1372 id = db.Column(db.Integer, primary_key=True)
1374 created_at = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
1376 causer_id = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
1377 causer = db.relationship("User", foreign_keys=[causer_id])
1379 severity = db.Column(db.Enum(AuditSeverity), nullable=False)
1381 title = db.Column(db.String(100), nullable=False)
1382 url = db.Column(db.String(200), nullable=True)
1384 package_id = db.Column(db.Integer, db.ForeignKey("package.id"), nullable=True)
1385 package = db.relationship("Package", foreign_keys=[package_id])
1387 description = db.Column(db.Text, nullable=True, default=None)
1389 def __init__(self, causer, severity, title, url, package=None, description=None):
1390 if len(title) > 100:
1391 title = title[:99] + "…"
1393 self.causer = causer
1394 self.severity = severity
1397 self.package = package
1398 self.description = description
1403 REPO_BLACKLIST = [".zip", "mediafire.com", "dropbox.com", "weebly.com", \
1404 "minetest.net", "dropboxusercontent.com", "4shared.com", \
1405 "digitalaudioconcepts.com", "hg.intevation.org", "www.wtfpl.net", \
1406 "imageshack.com", "imgur.com"]
1408 class ForumTopic(db.Model):
1409 topic_id = db.Column(db.Integer, primary_key=True, autoincrement=False)
1410 author_id = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
1411 author = db.relationship("User")
1413 wip = db.Column(db.Boolean, server_default="0")
1414 discarded = db.Column(db.Boolean, server_default="0")
1416 type = db.Column(db.Enum(PackageType), nullable=False)
1417 title = db.Column(db.String(200), nullable=False)
1418 name = db.Column(db.String(30), nullable=True)
1419 link = db.Column(db.String(200), nullable=True)
1421 posts = db.Column(db.Integer, nullable=False)
1422 views = db.Column(db.Integer, nullable=False)
1424 created_at = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
1426 def getRepoURL(self):
1427 if self.link is None:
1430 for item in REPO_BLACKLIST:
1431 if item in self.link:
1434 return self.link.replace("repo.or.cz/w/", "repo.or.cz/")
1436 def getAsDictionary(self):
1438 "author": self.author.username,
1440 "type": self.type.toName(),
1441 "title": self.title,
1442 "id": self.topic_id,
1444 "posts": self.posts,
1445 "views": self.views,
1447 "discarded": self.discarded,
1448 "created_at": self.created_at.isoformat(),
1451 def checkPerm(self, user, perm):
1452 if not user.is_authenticated:
1455 if type(perm) == str:
1456 perm = Permission[perm]
1457 elif type(perm) != Permission:
1458 raise Exception("Unknown permission given to ForumTopic.checkPerm()")
1460 if perm == Permission.TOPIC_DISCARD:
1461 return self.author == user or user.rank.atLeast(UserRank.EDITOR)
1464 raise Exception("Permission {} is not related to topics".format(perm.name))
1468 user_manager = UserManager(app, db, User)
1470 if app.config.get("LOG_SQL"):
1472 logging.basicConfig()
1473 logging.getLogger('sqlalchemy.engine').setLevel(logging.INFO)