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 PackagePropertyKey(enum.Enum):
342 short_desc = "Short Description"
346 media_license = "Media License"
348 provides = "Provides"
351 issueTracker = "Issue Tracker"
352 forums = "Forum Topic ID"
354 def convert(self, value):
355 if self == PackagePropertyKey.tags:
356 return ",".join([t.title for t in value])
357 elif self == PackagePropertyKey.provides:
358 return ",".join([t.name for t in value])
362 provides = db.Table("provides",
363 db.Column("package_id", db.Integer, db.ForeignKey("package.id"), primary_key=True),
364 db.Column("metapackage_id", db.Integer, db.ForeignKey("meta_package.id"), primary_key=True)
367 Tags = db.Table("tags",
368 db.Column("tag_id", db.Integer, db.ForeignKey("tag.id"), primary_key=True),
369 db.Column("package_id", db.Integer, db.ForeignKey("package.id"), primary_key=True)
372 ContentWarnings = db.Table("content_warnings",
373 db.Column("content_warning_id", db.Integer, db.ForeignKey("content_warning.id"), primary_key=True),
374 db.Column("package_id", db.Integer, db.ForeignKey("package.id"), primary_key=True)
377 maintainers = db.Table("maintainers",
378 db.Column("user_id", db.Integer, db.ForeignKey("user.id"), primary_key=True),
379 db.Column("package_id", db.Integer, db.ForeignKey("package.id"), primary_key=True)
382 class Dependency(db.Model):
383 id = db.Column(db.Integer, primary_key=True)
384 depender_id = db.Column(db.Integer, db.ForeignKey("package.id"), nullable=True)
385 package_id = db.Column(db.Integer, db.ForeignKey("package.id"), nullable=True)
386 package = db.relationship("Package", foreign_keys=[package_id])
387 meta_package_id = db.Column(db.Integer, db.ForeignKey("meta_package.id"), nullable=True)
388 optional = db.Column(db.Boolean, nullable=False, default=False)
389 __table_args__ = (db.UniqueConstraint("depender_id", "package_id", "meta_package_id", name="_dependency_uc"), )
391 def __init__(self, depender=None, package=None, meta=None, optional=False):
395 self.depender = depender
396 self.optional = optional
398 packageProvided = package is not None
399 metaProvided = meta is not None
401 if packageProvided and not metaProvided:
402 self.package = package
403 elif metaProvided and not packageProvided:
404 self.meta_package = meta
406 raise Exception("Either meta or package must be given, but not both!")
409 if self.meta_package:
410 return self.meta_package.name
412 return self.package.name
417 if self.package is not None:
418 return self.package.author.username + "/" + self.package.name
419 elif self.meta_package is not None:
420 return self.meta_package.name
422 raise Exception("Meta and package are both none!")
425 def SpecToList(depender, spec, cache={}):
427 arr = spec.split(",")
430 pattern1 = re.compile("^([a-z0-9_]+)$")
431 pattern2 = re.compile("^([A-Za-z0-9_]+)/([a-z0-9_]+)$")
438 if pattern1.match(x):
439 meta = MetaPackage.GetOrCreate(x, cache)
440 retval.append(Dependency(depender, meta=meta))
442 m = pattern2.match(x)
443 username = m.group(1)
445 user = User.query.filter_by(username=username).first()
447 raise Exception("Unable to find user " + username)
449 package = Package.query.filter_by(author=user, name=name).first()
451 raise Exception("Unable to find package " + name + " by " + username)
453 retval.append(Dependency(depender, package=package))
458 class Package(db.Model):
459 query_class = ArticleQuery
461 id = db.Column(db.Integer, primary_key=True)
464 author_id = db.Column(db.Integer, db.ForeignKey("user.id"))
465 name = db.Column(db.Unicode(100), nullable=False)
466 title = db.Column(db.Unicode(100), nullable=False)
467 short_desc = db.Column(db.Unicode(200), nullable=False)
468 desc = db.Column(db.UnicodeText, nullable=True)
469 type = db.Column(db.Enum(PackageType))
470 created_at = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
471 approved_at = db.Column(db.DateTime, nullable=True, default=None)
473 name_valid = db.CheckConstraint("name ~* '^[a-z0-9_]+$'")
475 search_vector = db.Column(TSVectorType("name", "title", "short_desc", "desc", \
476 weights={ "name": "A", "title": "B", "short_desc": "C", "desc": "D" }))
478 license_id = db.Column(db.Integer, db.ForeignKey("license.id"), nullable=False, default=1)
479 license = db.relationship("License", foreign_keys=[license_id])
480 media_license_id = db.Column(db.Integer, db.ForeignKey("license.id"), nullable=False, default=1)
481 media_license = db.relationship("License", foreign_keys=[media_license_id])
483 approved = db.Column(db.Boolean, nullable=False, default=False)
484 soft_deleted = db.Column(db.Boolean, nullable=False, default=False)
486 score = db.Column(db.Float, nullable=False, default=0)
487 score_downloads = db.Column(db.Float, nullable=False, default=0)
488 downloads = db.Column(db.Integer, nullable=False, default=0)
490 review_thread_id = db.Column(db.Integer, db.ForeignKey("thread.id"), nullable=True, default=None)
491 review_thread = db.relationship("Thread", foreign_keys=[review_thread_id])
494 repo = db.Column(db.String(200), nullable=True)
495 website = db.Column(db.String(200), nullable=True)
496 issueTracker = db.Column(db.String(200), nullable=True)
497 forums = db.Column(db.Integer, nullable=True)
499 provides = db.relationship("MetaPackage", \
500 secondary=provides, lazy="select", order_by=db.asc("name"), \
501 backref=db.backref("packages", lazy="dynamic", order_by=db.desc("score")))
503 dependencies = db.relationship("Dependency", backref="depender", lazy="dynamic", foreign_keys=[Dependency.depender_id])
505 tags = db.relationship("Tag", secondary=Tags, lazy="select",
506 backref=db.backref("packages", lazy=True))
508 content_warnings = db.relationship("ContentWarning", secondary=ContentWarnings, lazy="select",
509 backref=db.backref("packages", lazy=True))
511 releases = db.relationship("PackageRelease", backref="package",
512 lazy="dynamic", order_by=db.desc("package_release_releaseDate"))
514 screenshots = db.relationship("PackageScreenshot", backref="package",
515 lazy="dynamic", order_by=db.asc("package_screenshot_id"))
517 requests = db.relationship("EditRequest", backref="package",
520 maintainers = db.relationship("User", secondary=maintainers, lazy="subquery")
522 def __init__(self, package=None):
526 self.author_id = package.author_id
527 self.created_at = package.created_at
528 self.approved = package.approved
530 self.maintainers.append(self.author)
532 for e in PackagePropertyKey:
533 setattr(self, e.name, getattr(package, e.name))
536 return "{}/{}".format(self.author.username, self.name)
539 return self.license.is_foss and self.media_license.is_foss
541 def getIsOnGitHub(self):
542 if self.repo is None:
545 url = urlparse(self.repo)
546 return url.netloc == "github.com"
548 def getGitHubFullName(self):
549 if self.repo is None:
552 url = urlparse(self.repo)
553 if url.netloc != "github.com":
557 m = re.search(r"^\/([^\/]+)\/([^\/]+)\/?$", url.path)
562 repo = m.group(2).replace(".git", "")
566 def getSortedDependencies(self, is_hard=None):
567 query = self.dependencies
568 if is_hard is not None:
569 query = query.filter_by(optional=not is_hard)
572 deps.sort(key = lambda x: x.getName())
575 def getSortedHardDependencies(self):
576 return self.getSortedDependencies(True)
578 def getSortedOptionalDependencies(self):
579 return self.getSortedDependencies(False)
584 elif self.review_thread_id:
586 elif (self.type == PackageType.GAME or \
587 self.type == PackageType.TXP) and \
588 self.screenshots.count() == 0:
590 elif not self.getDownloadRelease():
592 elif "Other" in self.license.name or "Other" in self.media_license.name:
597 def getAsDictionaryKey(self):
600 "author": self.author.display_name,
601 "type": self.type.toName(),
604 def getAsDictionaryShort(self, base_url, version=None):
605 tnurl = self.getThumbnailURL(1)
606 release = self.getDownloadRelease(version=version)
610 "author": self.author.username,
611 "short_description": self.short_desc,
612 "type": self.type.toName(),
613 "release": release and release.id,
614 "thumbnail": (base_url + tnurl) if tnurl is not None else None
617 def getAsDictionary(self, base_url, version=None):
618 tnurl = self.getThumbnailURL(1)
619 release = self.getDownloadRelease(version=version)
621 "author": self.author.username,
624 "short_description": self.short_desc,
626 "type": self.type.toName(),
627 "created_at": self.created_at.isoformat(),
629 "license": self.license.name,
630 "media_license": self.media_license.name,
633 "website": self.website,
634 "issue_tracker": self.issueTracker,
635 "forums": self.forums,
637 "provides": [x.name for x in self.provides],
638 "thumbnail": (base_url + tnurl) if tnurl is not None else None,
639 "screenshots": [base_url + ss.url for ss in self.screenshots],
641 "url": base_url + self.getDownloadURL(),
642 "release": release and release.id,
644 "score": round(self.score * 10) / 10,
645 "downloads": self.downloads
648 def getThumbnailURL(self, level=2):
649 screenshot = self.screenshots.filter_by(approved=True).order_by(db.asc(PackageScreenshot.id)).first()
650 return screenshot.getThumbnailURL(level) if screenshot is not None else None
652 def getMainScreenshotURL(self, absolute=False):
653 screenshot = self.screenshots.filter_by(approved=True).order_by(db.asc(PackageScreenshot.id)).first()
654 if screenshot is None:
658 from app.utils import abs_url
659 return abs_url(screenshot.url)
661 return screenshot.url
663 def getDetailsURL(self, absolute=False):
665 from app.utils import abs_url_for
666 return abs_url_for("packages.view",
667 author=self.author.username, name=self.name)
669 return url_for("packages.view",
670 author=self.author.username, name=self.name)
672 def getShieldURL(self, type):
673 from app.utils import abs_url_for
674 return abs_url_for("packages.shield",
675 author=self.author.username, name=self.name, type=type)
677 def makeShield(self, type):
678 return "[![ContentDB]({})]({})" \
679 .format(self.getShieldURL(type), self.getDetailsURL(True))
681 def getEditURL(self):
682 return url_for("packages.create_edit",
683 author=self.author.username, name=self.name)
685 def getApproveURL(self):
686 return url_for("packages.approve",
687 author=self.author.username, name=self.name)
689 def getRemoveURL(self):
690 return url_for("packages.remove",
691 author=self.author.username, name=self.name)
693 def getNewScreenshotURL(self):
694 return url_for("packages.create_screenshot",
695 author=self.author.username, name=self.name)
697 def getCreateReleaseURL(self):
698 return url_for("packages.create_release",
699 author=self.author.username, name=self.name)
701 def getCreateEditRequestURL(self):
702 return url_for("create_edit_editrequest_page",
703 author=self.author.username, name=self.name)
705 def getBulkReleaseURL(self):
706 return url_for("packages.bulk_change_release",
707 author=self.author.username, name=self.name)
709 def getDownloadURL(self):
710 return url_for("packages.download",
711 author=self.author.username, name=self.name)
713 def getEditMaintainersURL(self):
714 return url_for("packages.edit_maintainers",
715 author=self.author.username, name=self.name)
717 def getRemoveSelfMaintainerURL(self):
718 return url_for("packages.remove_self_maintainers",
719 author=self.author.username, name=self.name)
721 def getUpdateFromReleaseURL(self):
722 return url_for("packages.update_from_release",
723 author=self.author.username, name=self.name)
725 def getReviewURL(self):
726 return url_for('packages.review',
727 author=self.author.username, name=self.name)
729 def getDownloadRelease(self, version=None):
730 for rel in self.releases:
731 if rel.approved and (version is None or
732 ((rel.min_rel is None or rel.min_rel_id <= version.id) and \
733 (rel.max_rel is None or rel.max_rel_id >= version.id))):
738 def checkPerm(self, user, perm):
739 if not user.is_authenticated:
742 if type(perm) == str:
743 perm = Permission[perm]
744 elif type(perm) != Permission:
745 raise Exception("Unknown permission given to Package.checkPerm()")
747 isOwner = user == self.author
748 isMaintainer = isOwner or user.rank.atLeast(UserRank.EDITOR) or user in self.maintainers
750 if perm == Permission.CREATE_THREAD:
751 return user.rank.atLeast(UserRank.MEMBER)
753 # Members can edit their own packages, and editors can edit any packages
754 elif perm == Permission.MAKE_RELEASE or perm == Permission.ADD_SCREENSHOTS:
757 elif perm == Permission.EDIT_PACKAGE or \
758 perm == Permission.APPROVE_CHANGES or perm == Permission.APPROVE_RELEASE:
759 return isMaintainer and user.rank.atLeast(UserRank.MEMBER if self.approved else UserRank.NEW_MEMBER)
761 # Anyone can change the package name when not approved, but only editors when approved
762 elif perm == Permission.CHANGE_NAME:
763 return not self.approved or user.rank.atLeast(UserRank.EDITOR)
765 # Editors can change authors and approve new packages
766 elif perm == Permission.APPROVE_NEW or perm == Permission.CHANGE_AUTHOR:
767 return user.rank.atLeast(UserRank.EDITOR)
769 elif perm == Permission.APPROVE_SCREENSHOT:
770 return isMaintainer and user.rank.atLeast(UserRank.TRUSTED_MEMBER if self.approved else UserRank.NEW_MEMBER)
772 elif perm == Permission.EDIT_MAINTAINERS:
773 return isOwner or user.rank.atLeast(UserRank.MODERATOR)
775 elif perm == Permission.UNAPPROVE_PACKAGE or perm == Permission.DELETE_PACKAGE:
776 return user.rank.atLeast(UserRank.EDITOR)
778 elif perm == Permission.CHANGE_RELEASE_URL:
779 return user.rank.atLeast(UserRank.MODERATOR)
781 elif perm == Permission.REIMPORT_META:
782 return user.rank.atLeast(UserRank.ADMIN)
785 raise Exception("Permission {} is not related to packages".format(perm.name))
787 def getScoreDict(self):
789 "author": self.author.username,
792 "score_downloads": self.score_downloads,
793 "score_reviews": self.score - self.score_downloads,
794 "downloads": self.downloads
797 def recalcScore(self):
798 review_scores = [ 100 * r.asSign() for r in self.reviews ]
799 self.score = self.score_downloads + sum(review_scores)
802 class MetaPackage(db.Model):
803 id = db.Column(db.Integer, primary_key=True)
804 name = db.Column(db.String(100), unique=True, nullable=False)
805 dependencies = db.relationship("Dependency", backref="meta_package", lazy="dynamic")
807 mp_name_valid = db.CheckConstraint("name ~* '^[a-z0-9_]+$'")
809 def __init__(self, name=None):
816 def ListToSpec(list):
817 return ",".join([str(x) for x in list])
820 def GetOrCreate(name, cache={}):
823 mp = MetaPackage.query.filter_by(name=name).first()
826 mp = MetaPackage(name)
833 def SpecToList(spec, cache={}):
835 arr = spec.split(",")
838 pattern = re.compile("^([a-z0-9_]+)$")
845 if not pattern.match(x):
848 retval.append(MetaPackage.GetOrCreate(x, cache))
853 class ContentWarning(db.Model):
854 id = db.Column(db.Integer, primary_key=True)
855 name = db.Column(db.String(100), unique=True, nullable=False)
856 title = db.Column(db.String(100), nullable=False)
857 description = db.Column(db.String(500), nullable=False)
859 def __init__(self, title, description=""):
861 self.description = description
864 regex = re.compile("[^a-z_]")
865 self.name = regex.sub("", self.title.lower().replace(" ", "_"))
869 id = db.Column(db.Integer, primary_key=True)
870 name = db.Column(db.String(100), unique=True, nullable=False)
871 title = db.Column(db.String(100), nullable=False)
872 description = db.Column(db.String(500), nullable=True, default=None)
873 backgroundColor = db.Column(db.String(6), nullable=False)
874 textColor = db.Column(db.String(6), nullable=False)
875 views = db.Column(db.Integer, nullable=False, default=0)
877 def __init__(self, title, backgroundColor="000000", textColor="ffffff"):
879 self.backgroundColor = backgroundColor
880 self.textColor = textColor
883 regex = re.compile("[^a-z_]")
884 self.name = regex.sub("", self.title.lower().replace(" ", "_"))
887 class MinetestRelease(db.Model):
888 id = db.Column(db.Integer, primary_key=True)
889 name = db.Column(db.String(100), unique=True, nullable=False)
890 protocol = db.Column(db.Integer, nullable=False, default=0)
892 def __init__(self, name=None, protocol=0):
894 self.protocol = protocol
897 return None if self.name == "None" else self
900 def get(cls, version, protocol_num):
902 parts = version.strip().split(".")
904 major_minor = parts[0] + "." + parts[1]
905 query = MinetestRelease.query.filter(MinetestRelease.name.like("{}%".format(major_minor)))
907 query = query.filter_by(protocol=protocol_num)
909 release = query.one_or_none()
914 return MinetestRelease.query.filter_by(protocol=protocol_num).first()
919 class PackageRelease(db.Model):
920 id = db.Column(db.Integer, primary_key=True)
922 package_id = db.Column(db.Integer, db.ForeignKey("package.id"))
923 title = db.Column(db.String(100), nullable=False)
924 releaseDate = db.Column(db.DateTime, nullable=False)
925 url = db.Column(db.String(200), nullable=False)
926 approved = db.Column(db.Boolean, nullable=False, default=False)
927 task_id = db.Column(db.String(37), nullable=True)
928 commit_hash = db.Column(db.String(41), nullable=True, default=None)
929 downloads = db.Column(db.Integer, nullable=False, default=0)
931 min_rel_id = db.Column(db.Integer, db.ForeignKey("minetest_release.id"), nullable=True, server_default=None)
932 min_rel = db.relationship("MinetestRelease", foreign_keys=[min_rel_id])
934 max_rel_id = db.Column(db.Integer, db.ForeignKey("minetest_release.id"), nullable=True, server_default=None)
935 max_rel = db.relationship("MinetestRelease", foreign_keys=[max_rel_id])
937 # If the release is approved, then the task_id must be null and the url must be present
938 CK_approval_valid = db.CheckConstraint("not approved OR (task_id IS NULL AND (url = '') IS NOT FALSE)")
940 def getAsDictionary(self):
944 "url": self.url if self.url != "" else None,
945 "release_date": self.releaseDate.isoformat(),
946 "commit": self.commit_hash,
947 "downloads": self.downloads,
948 "min_protocol": self.min_rel and self.min_rel.protocol,
949 "max_protocol": self.max_rel and self.max_rel.protocol
952 def getEditURL(self):
953 return url_for("packages.edit_release",
954 author=self.package.author.username,
955 name=self.package.name,
958 def getDeleteURL(self):
959 return url_for("packages.delete_release",
960 author=self.package.author.username,
961 name=self.package.name,
964 def getDownloadURL(self):
965 return url_for("packages.download_release",
966 author=self.package.author.username,
967 name=self.package.name,
971 self.releaseDate = datetime.datetime.now()
973 def approve(self, user):
974 if not self.package.checkPerm(user, Permission.APPROVE_RELEASE):
977 assert self.task_id is None and self.url is not None and self.url != ""
982 def checkPerm(self, user, perm):
983 if not user.is_authenticated:
986 if type(perm) == str:
987 perm = Permission[perm]
988 elif type(perm) != Permission:
989 raise Exception("Unknown permission given to PackageRelease.checkPerm()")
991 isOwner = user == self.package.author
993 if perm == Permission.DELETE_RELEASE:
994 if user.rank.atLeast(UserRank.ADMIN):
997 if not (isOwner or user.rank.atLeast(UserRank.EDITOR)):
1000 if not self.package.approved or self.task_id is not None:
1003 count = PackageRelease.query \
1004 .filter_by(package_id=self.package_id) \
1005 .filter(PackageRelease.id > self.id) \
1010 raise Exception("Permission {} is not related to releases".format(perm.name))
1013 # class PackageReview(db.Model):
1014 # id = db.Column(db.Integer, primary_key=True)
1015 # package_id = db.Column(db.Integer, db.ForeignKey("package.id"))
1016 # thread_id = db.Column(db.Integer, db.ForeignKey("thread.id"), nullable=False)
1017 # recommend = db.Column(db.Boolean, nullable=False, default=True)
1020 class PackageScreenshot(db.Model):
1021 id = db.Column(db.Integer, primary_key=True)
1022 package_id = db.Column(db.Integer, db.ForeignKey("package.id"))
1023 title = db.Column(db.String(100), nullable=False)
1024 url = db.Column(db.String(100), nullable=False)
1025 approved = db.Column(db.Boolean, nullable=False, default=False)
1028 def getEditURL(self):
1029 return url_for("packages.edit_screenshot",
1030 author=self.package.author.username,
1031 name=self.package.name,
1034 def getThumbnailURL(self, level=2):
1035 return self.url.replace("/uploads/", ("/thumbnails/{:d}/").format(level))
1038 class APIToken(db.Model):
1039 id = db.Column(db.Integer, primary_key=True)
1040 access_token = db.Column(db.String(34), unique=True)
1042 name = db.Column(db.String(100), nullable=False)
1043 owner_id = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
1044 # owner is created using backref
1046 created_at = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
1048 package_id = db.Column(db.Integer, db.ForeignKey("package.id"), nullable=True)
1049 package = db.relationship("Package", foreign_keys=[package_id])
1051 def canOperateOnPackage(self, package):
1052 if self.package and self.package != package:
1055 return package.author == self.owner
1058 class EditRequest(db.Model):
1059 id = db.Column(db.Integer, primary_key=True)
1061 package_id = db.Column(db.Integer, db.ForeignKey("package.id"))
1062 author_id = db.Column(db.Integer, db.ForeignKey("user.id"))
1064 title = db.Column(db.String(100), nullable=False)
1065 desc = db.Column(db.String(1000), nullable=True)
1070 status = db.Column(db.Integer, nullable=False, default=0)
1072 changes = db.relationship("EditRequestChange", backref="request",
1076 return url_for("view_editrequest_page",
1077 author=self.package.author.username,
1078 name=self.package.name,
1081 def getApproveURL(self):
1082 return url_for("approve_editrequest_page",
1083 author=self.package.author.username,
1084 name=self.package.name,
1087 def getRejectURL(self):
1088 return url_for("reject_editrequest_page",
1089 author=self.package.author.username,
1090 name=self.package.name,
1093 def getEditURL(self):
1094 return url_for("create_edit_editrequest_page",
1095 author=self.package.author.username,
1096 name=self.package.name,
1099 def applyAll(self, package):
1100 for change in self.changes:
1101 change.apply(package)
1104 def checkPerm(self, user, perm):
1105 if not user.is_authenticated:
1108 if type(perm) == str:
1109 perm = Permission[perm]
1110 elif type(perm) != Permission:
1111 raise Exception("Unknown permission given to EditRequest.checkPerm()")
1113 isOwner = user == self.author
1115 # Members can edit their own packages, and editors can edit any packages
1116 if perm == Permission.EDIT_EDITREQUEST:
1117 return isOwner or user.rank.atLeast(UserRank.EDITOR)
1120 raise Exception("Permission {} is not related to packages".format(perm.name))
1125 class EditRequestChange(db.Model):
1126 id = db.Column(db.Integer, primary_key=True)
1128 request_id = db.Column(db.Integer, db.ForeignKey("edit_request.id"))
1129 key = db.Column(db.Enum(PackagePropertyKey), nullable=False)
1131 # TODO: make diff instead
1132 oldValue = db.Column(db.Text, nullable=True)
1133 newValue = db.Column(db.Text, nullable=True)
1135 def apply(self, package):
1136 if self.key == PackagePropertyKey.tags:
1137 package.tags.clear()
1138 for tagTitle in self.newValue.split(","):
1139 tag = Tag.query.filter_by(title=tagTitle.strip()).first()
1140 package.tags.append(tag)
1143 setattr(package, self.key.name, self.newValue)
1146 watchers = db.Table("watchers",
1147 db.Column("user_id", db.Integer, db.ForeignKey("user.id"), primary_key=True),
1148 db.Column("thread_id", db.Integer, db.ForeignKey("thread.id"), primary_key=True)
1151 class Thread(db.Model):
1152 id = db.Column(db.Integer, primary_key=True)
1154 package_id = db.Column(db.Integer, db.ForeignKey("package.id"), nullable=True)
1155 package = db.relationship("Package", foreign_keys=[package_id])
1157 review_id = db.Column(db.Integer, db.ForeignKey("package_review.id"), nullable=True)
1158 review = db.relationship("PackageReview", foreign_keys=[review_id])
1160 author_id = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
1161 title = db.Column(db.String(100), nullable=False)
1162 private = db.Column(db.Boolean, server_default="0", nullable=False)
1164 locked = db.Column(db.Boolean, server_default="0", nullable=False)
1166 created_at = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
1168 replies = db.relationship("ThreadReply", backref="thread", lazy="dynamic", \
1169 order_by=db.asc("thread_reply_id"))
1171 watchers = db.relationship("User", secondary=watchers, lazy="subquery", \
1172 backref=db.backref("watching", lazy=True))
1174 def getViewURL(self):
1175 return url_for("threads.view", id=self.id)
1177 def getSubscribeURL(self):
1178 return url_for("threads.subscribe", id=self.id)
1180 def getUnsubscribeURL(self):
1181 return url_for("threads.unsubscribe", id=self.id)
1183 def checkPerm(self, user, perm):
1184 if not user.is_authenticated:
1185 return perm == Permission.SEE_THREAD and not self.private
1187 if type(perm) == str:
1188 perm = Permission[perm]
1189 elif type(perm) != Permission:
1190 raise Exception("Unknown permission given to Thread.checkPerm()")
1192 isMaintainer = user == self.author or (self.package is not None and self.package.author == user)
1194 isMaintainer = isMaintainer or user in self.package.maintainers
1196 canSee = not self.private or isMaintainer or user.rank.atLeast(UserRank.EDITOR)
1198 if perm == Permission.SEE_THREAD:
1201 elif perm == Permission.COMMENT_THREAD:
1202 return canSee and (not self.locked or user.rank.atLeast(UserRank.MODERATOR))
1204 elif perm == Permission.LOCK_THREAD:
1205 return user.rank.atLeast(UserRank.MODERATOR)
1208 raise Exception("Permission {} is not related to threads".format(perm.name))
1210 class ThreadReply(db.Model):
1211 id = db.Column(db.Integer, primary_key=True)
1212 thread_id = db.Column(db.Integer, db.ForeignKey("thread.id"), nullable=False)
1213 comment = db.Column(db.String(2000), nullable=False)
1214 author_id = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
1215 created_at = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
1217 def checkPerm(self, user, perm):
1218 if not user.is_authenticated:
1221 if type(perm) == str:
1222 perm = Permission[perm]
1223 elif type(perm) != Permission:
1224 raise Exception("Unknown permission given to ThreadReply.checkPerm()")
1226 if perm == Permission.EDIT_REPLY:
1227 return user == self.author and user.rank.atLeast(UserRank.MEMBER) and not self.thread.locked
1229 elif perm == Permission.DELETE_REPLY:
1230 return user.rank.atLeast(UserRank.MODERATOR) and self.thread.replies[0] != self
1233 raise Exception("Permission {} is not related to threads".format(perm.name))
1236 class PackageReview(db.Model):
1237 id = db.Column(db.Integer, primary_key=True)
1239 package_id = db.Column(db.Integer, db.ForeignKey("package.id"), nullable=True)
1240 package = db.relationship("Package", foreign_keys=[package_id], backref=db.backref("reviews", lazy=True))
1242 created_at = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
1244 author_id = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
1245 author = db.relationship("User", foreign_keys=[author_id], backref=db.backref("reviews", lazy=True))
1247 recommends = db.Column(db.Boolean, nullable=False)
1249 thread = db.relationship("Thread", uselist=False, back_populates="review")
1252 return 1 if self.recommends else -1
1254 def getEditURL(self):
1255 return self.package.getReviewURL()
1257 def getDeleteURL(self):
1258 return url_for("packages.delete_review",
1259 author=self.package.author.username,
1260 name=self.package.name)
1263 class AuditSeverity(enum.Enum):
1264 NORMAL = 0 # Normal user changes
1265 EDITOR = 1 # Editor changes
1266 MODERATION = 2 # Destructive / moderator changes
1272 return self.name.replace("_", " ").title()
1276 return [(choice, choice.getTitle()) for choice in cls]
1279 def coerce(cls, item):
1280 return item if type(item) == AuditSeverity else AuditSeverity[item]
1284 class AuditLogEntry(db.Model):
1285 id = db.Column(db.Integer, primary_key=True)
1287 created_at = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
1289 causer_id = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
1290 causer = db.relationship("User", foreign_keys=[causer_id])
1292 severity = db.Column(db.Enum(AuditSeverity), nullable=False)
1294 title = db.Column(db.String(100), nullable=False)
1295 url = db.Column(db.String(200), nullable=True)
1297 package_id = db.Column(db.Integer, db.ForeignKey("package.id"), nullable=True)
1298 package = db.relationship("Package", foreign_keys=[package_id])
1300 description = db.Column(db.Text, nullable=True, default=None)
1302 def __init__(self, causer, severity, title, url, package=None, description=None):
1303 if len(title) > 100:
1304 title = title[:99] + "…"
1306 self.causer = causer
1307 self.severity = severity
1310 self.package = package
1311 self.description = description
1316 REPO_BLACKLIST = [".zip", "mediafire.com", "dropbox.com", "weebly.com", \
1317 "minetest.net", "dropboxusercontent.com", "4shared.com", \
1318 "digitalaudioconcepts.com", "hg.intevation.org", "www.wtfpl.net", \
1319 "imageshack.com", "imgur.com"]
1321 class ForumTopic(db.Model):
1322 topic_id = db.Column(db.Integer, primary_key=True, autoincrement=False)
1323 author_id = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
1324 author = db.relationship("User")
1326 wip = db.Column(db.Boolean, server_default="0")
1327 discarded = db.Column(db.Boolean, server_default="0")
1329 type = db.Column(db.Enum(PackageType), nullable=False)
1330 title = db.Column(db.String(200), nullable=False)
1331 name = db.Column(db.String(30), nullable=True)
1332 link = db.Column(db.String(200), nullable=True)
1334 posts = db.Column(db.Integer, nullable=False)
1335 views = db.Column(db.Integer, nullable=False)
1337 created_at = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
1339 def getRepoURL(self):
1340 if self.link is None:
1343 for item in REPO_BLACKLIST:
1344 if item in self.link:
1347 return self.link.replace("repo.or.cz/w/", "repo.or.cz/")
1349 def getAsDictionary(self):
1351 "author": self.author.username,
1353 "type": self.type.toName(),
1354 "title": self.title,
1355 "id": self.topic_id,
1357 "posts": self.posts,
1358 "views": self.views,
1360 "discarded": self.discarded,
1361 "created_at": self.created_at.isoformat(),
1364 def checkPerm(self, user, perm):
1365 if not user.is_authenticated:
1368 if type(perm) == str:
1369 perm = Permission[perm]
1370 elif type(perm) != Permission:
1371 raise Exception("Unknown permission given to ForumTopic.checkPerm()")
1373 if perm == Permission.TOPIC_DISCARD:
1374 return self.author == user or user.rank.atLeast(UserRank.EDITOR)
1377 raise Exception("Permission {} is not related to topics".format(perm.name))
1381 user_manager = UserManager(app, db, User)
1383 if app.config.get("LOG_SQL"):
1385 logging.basicConfig()
1386 logging.getLogger('sqlalchemy.engine').setLevel(logging.INFO)