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):
225 one_min_ago = datetime.datetime.utcnow() - datetime.timedelta(minutes=1)
226 if ThreadReply.query.filter_by(author=self) \
227 .filter(ThreadReply.created_at > one_min_ago).count() >= 3:
230 hour_ago = datetime.datetime.utcnow() - datetime.timedelta(hours=1)
231 if ThreadReply.query.filter_by(author=self) \
232 .filter(ThreadReply.created_at > hour_ago).count() >= 20:
237 def canOpenThreadRL(self):
238 hour_ago = datetime.datetime.utcnow() - datetime.timedelta(hours=1)
239 return Thread.query.filter_by(author=self) \
240 .filter(Thread.created_at > hour_ago).count() < 2
242 def __eq__(self, other):
246 if not self.is_authenticated or not other.is_authenticated:
250 return self.id == other.id
252 class UserEmailVerification(db.Model):
253 id = db.Column(db.Integer, primary_key=True)
254 user_id = db.Column(db.Integer, db.ForeignKey("user.id"))
255 email = db.Column(db.String(100))
256 token = db.Column(db.String(32))
257 user = db.relationship("User", foreign_keys=[user_id])
259 class Notification(db.Model):
260 id = db.Column(db.Integer, primary_key=True)
262 user_id = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
263 user = db.relationship("User", foreign_keys=[user_id])
265 causer_id = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
266 causer = db.relationship("User", foreign_keys=[causer_id])
268 title = db.Column(db.String(100), nullable=False)
269 url = db.Column(db.String(200), nullable=True)
271 package_id = db.Column(db.Integer, db.ForeignKey("package.id"), nullable=True)
272 package = db.relationship("Package", foreign_keys=[package_id])
274 created_at = db.Column(db.DateTime, nullable=True, default=datetime.datetime.utcnow)
276 def __init__(self, user, causer, title, url, package=None):
278 title = title[:99] + "…"
284 self.package = package
287 class License(db.Model):
288 id = db.Column(db.Integer, primary_key=True)
289 name = db.Column(db.String(50), nullable=False, unique=True)
290 is_foss = db.Column(db.Boolean, nullable=False, default=True)
292 def __init__(self, v, is_foss=True):
294 self.is_foss = is_foss
300 class PackageType(enum.Enum):
306 return self.name.lower()
314 return PackageType[name.upper()]
320 return [(choice, choice.value) for choice in cls]
323 def coerce(cls, item):
324 return item if type(item) == PackageType else PackageType[item]
327 class PackagePropertyKey(enum.Enum):
330 short_desc = "Short Description"
334 media_license = "Media License"
336 provides = "Provides"
339 issueTracker = "Issue Tracker"
340 forums = "Forum Topic ID"
342 def convert(self, value):
343 if self == PackagePropertyKey.tags:
344 return ",".join([t.title for t in value])
345 elif self == PackagePropertyKey.provides:
346 return ",".join([t.name for t in value])
350 provides = db.Table("provides",
351 db.Column("package_id", db.Integer, db.ForeignKey("package.id"), primary_key=True),
352 db.Column("metapackage_id", db.Integer, db.ForeignKey("meta_package.id"), primary_key=True)
355 Tags = db.Table("tags",
356 db.Column("tag_id", db.Integer, db.ForeignKey("tag.id"), primary_key=True),
357 db.Column("package_id", db.Integer, db.ForeignKey("package.id"), primary_key=True)
360 ContentWarnings = db.Table("content_warnings",
361 db.Column("content_warning_id", db.Integer, db.ForeignKey("content_warning.id"), primary_key=True),
362 db.Column("package_id", db.Integer, db.ForeignKey("package.id"), primary_key=True)
365 maintainers = db.Table("maintainers",
366 db.Column("user_id", db.Integer, db.ForeignKey("user.id"), primary_key=True),
367 db.Column("package_id", db.Integer, db.ForeignKey("package.id"), primary_key=True)
370 class Dependency(db.Model):
371 id = db.Column(db.Integer, primary_key=True)
372 depender_id = db.Column(db.Integer, db.ForeignKey("package.id"), nullable=True)
373 package_id = db.Column(db.Integer, db.ForeignKey("package.id"), nullable=True)
374 package = db.relationship("Package", foreign_keys=[package_id])
375 meta_package_id = db.Column(db.Integer, db.ForeignKey("meta_package.id"), nullable=True)
376 optional = db.Column(db.Boolean, nullable=False, default=False)
377 __table_args__ = (db.UniqueConstraint("depender_id", "package_id", "meta_package_id", name="_dependency_uc"), )
379 def __init__(self, depender=None, package=None, meta=None, optional=False):
383 self.depender = depender
384 self.optional = optional
386 packageProvided = package is not None
387 metaProvided = meta is not None
389 if packageProvided and not metaProvided:
390 self.package = package
391 elif metaProvided and not packageProvided:
392 self.meta_package = meta
394 raise Exception("Either meta or package must be given, but not both!")
397 if self.meta_package:
398 return self.meta_package.name
400 return self.package.name
405 if self.package is not None:
406 return self.package.author.username + "/" + self.package.name
407 elif self.meta_package is not None:
408 return self.meta_package.name
410 raise Exception("Meta and package are both none!")
413 def SpecToList(depender, spec, cache={}):
415 arr = spec.split(",")
418 pattern1 = re.compile("^([a-z0-9_]+)$")
419 pattern2 = re.compile("^([A-Za-z0-9_]+)/([a-z0-9_]+)$")
426 if pattern1.match(x):
427 meta = MetaPackage.GetOrCreate(x, cache)
428 retval.append(Dependency(depender, meta=meta))
430 m = pattern2.match(x)
431 username = m.group(1)
433 user = User.query.filter_by(username=username).first()
435 raise Exception("Unable to find user " + username)
437 package = Package.query.filter_by(author=user, name=name).first()
439 raise Exception("Unable to find package " + name + " by " + username)
441 retval.append(Dependency(depender, package=package))
446 class Package(db.Model):
447 query_class = ArticleQuery
449 id = db.Column(db.Integer, primary_key=True)
452 author_id = db.Column(db.Integer, db.ForeignKey("user.id"))
453 name = db.Column(db.Unicode(100), nullable=False)
454 title = db.Column(db.Unicode(100), nullable=False)
455 short_desc = db.Column(db.Unicode(200), nullable=False)
456 desc = db.Column(db.UnicodeText, nullable=True)
457 type = db.Column(db.Enum(PackageType))
458 created_at = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
459 approved_at = db.Column(db.DateTime, nullable=True, default=None)
461 name_valid = db.CheckConstraint("name ~* '^[a-z0-9_]+$'")
463 search_vector = db.Column(TSVectorType("name", "title", "short_desc", "desc", \
464 weights={ "name": "A", "title": "B", "short_desc": "C", "desc": "D" }))
466 license_id = db.Column(db.Integer, db.ForeignKey("license.id"), nullable=False, default=1)
467 license = db.relationship("License", foreign_keys=[license_id])
468 media_license_id = db.Column(db.Integer, db.ForeignKey("license.id"), nullable=False, default=1)
469 media_license = db.relationship("License", foreign_keys=[media_license_id])
471 approved = db.Column(db.Boolean, nullable=False, default=False)
472 soft_deleted = db.Column(db.Boolean, nullable=False, default=False)
474 score = db.Column(db.Float, nullable=False, default=0)
475 score_downloads = db.Column(db.Float, nullable=False, default=0)
476 downloads = db.Column(db.Integer, nullable=False, default=0)
478 review_thread_id = db.Column(db.Integer, db.ForeignKey("thread.id"), nullable=True, default=None)
479 review_thread = db.relationship("Thread", foreign_keys=[review_thread_id])
482 repo = db.Column(db.String(200), nullable=True)
483 website = db.Column(db.String(200), nullable=True)
484 issueTracker = db.Column(db.String(200), nullable=True)
485 forums = db.Column(db.Integer, nullable=True)
487 provides = db.relationship("MetaPackage", \
488 secondary=provides, lazy="select", order_by=db.asc("name"), \
489 backref=db.backref("packages", lazy="dynamic", order_by=db.desc("score")))
491 dependencies = db.relationship("Dependency", backref="depender", lazy="dynamic", foreign_keys=[Dependency.depender_id])
493 tags = db.relationship("Tag", secondary=Tags, lazy="select",
494 backref=db.backref("packages", lazy=True))
496 content_warnings = db.relationship("ContentWarning", secondary=ContentWarnings, lazy="select",
497 backref=db.backref("packages", lazy=True))
499 releases = db.relationship("PackageRelease", backref="package",
500 lazy="dynamic", order_by=db.desc("package_release_releaseDate"))
502 screenshots = db.relationship("PackageScreenshot", backref="package",
503 lazy="dynamic", order_by=db.asc("package_screenshot_id"))
505 requests = db.relationship("EditRequest", backref="package",
508 maintainers = db.relationship("User", secondary=maintainers, lazy="subquery")
510 def __init__(self, package=None):
514 self.author_id = package.author_id
515 self.created_at = package.created_at
516 self.approved = package.approved
518 self.maintainers.append(self.author)
520 for e in PackagePropertyKey:
521 setattr(self, e.name, getattr(package, e.name))
524 return "{}/{}".format(self.author.username, self.name)
527 return self.license.is_foss and self.media_license.is_foss
529 def getIsOnGitHub(self):
530 if self.repo is None:
533 url = urlparse(self.repo)
534 return url.netloc == "github.com"
536 def getGitHubFullName(self):
537 if self.repo is None:
540 url = urlparse(self.repo)
541 if url.netloc != "github.com":
545 m = re.search(r"^\/([^\/]+)\/([^\/]+)\/?$", url.path)
550 repo = m.group(2).replace(".git", "")
554 def getSortedDependencies(self, is_hard=None):
555 query = self.dependencies
556 if is_hard is not None:
557 query = query.filter_by(optional=not is_hard)
560 deps.sort(key = lambda x: x.getName())
563 def getSortedHardDependencies(self):
564 return self.getSortedDependencies(True)
566 def getSortedOptionalDependencies(self):
567 return self.getSortedDependencies(False)
572 elif self.review_thread_id:
574 elif (self.type == PackageType.GAME or \
575 self.type == PackageType.TXP) and \
576 self.screenshots.count() == 0:
578 elif not self.getDownloadRelease():
580 elif "Other" in self.license.name or "Other" in self.media_license.name:
585 def getAsDictionaryKey(self):
588 "author": self.author.display_name,
589 "type": self.type.toName(),
592 def getAsDictionaryShort(self, base_url, version=None):
593 tnurl = self.getThumbnailURL(1)
594 release = self.getDownloadRelease(version=version)
598 "author": self.author.username,
599 "short_description": self.short_desc,
600 "type": self.type.toName(),
601 "release": release and release.id,
602 "thumbnail": (base_url + tnurl) if tnurl is not None else None
605 def getAsDictionary(self, base_url, version=None):
606 tnurl = self.getThumbnailURL(1)
607 release = self.getDownloadRelease(version=version)
609 "author": self.author.username,
612 "short_description": self.short_desc,
614 "type": self.type.toName(),
615 "created_at": self.created_at.isoformat(),
617 "license": self.license.name,
618 "media_license": self.media_license.name,
621 "website": self.website,
622 "issue_tracker": self.issueTracker,
623 "forums": self.forums,
625 "provides": [x.name for x in self.provides],
626 "thumbnail": (base_url + tnurl) if tnurl is not None else None,
627 "screenshots": [base_url + ss.url for ss in self.screenshots],
629 "url": base_url + self.getDownloadURL(),
630 "release": release and release.id,
632 "score": round(self.score * 10) / 10,
633 "downloads": self.downloads
636 def getThumbnailURL(self, level=2):
637 screenshot = self.screenshots.filter_by(approved=True).order_by(db.asc(PackageScreenshot.id)).first()
638 return screenshot.getThumbnailURL(level) if screenshot is not None else None
640 def getMainScreenshotURL(self, absolute=False):
641 screenshot = self.screenshots.filter_by(approved=True).order_by(db.asc(PackageScreenshot.id)).first()
642 if screenshot is None:
646 from app.utils import abs_url
647 return abs_url(screenshot.url)
649 return screenshot.url
651 def getDetailsURL(self, absolute=False):
653 from app.utils import abs_url_for
654 return abs_url_for("packages.view",
655 author=self.author.username, name=self.name)
657 return url_for("packages.view",
658 author=self.author.username, name=self.name)
660 def getShieldURL(self, type):
661 from app.utils import abs_url_for
662 return abs_url_for("packages.shield",
663 author=self.author.username, name=self.name, type=type)
665 def makeShield(self, type):
666 return "[![ContentDB]({})]({})" \
667 .format(self.getShieldURL(type), self.getDetailsURL(True))
669 def getEditURL(self):
670 return url_for("packages.create_edit",
671 author=self.author.username, name=self.name)
673 def getApproveURL(self):
674 return url_for("packages.approve",
675 author=self.author.username, name=self.name)
677 def getRemoveURL(self):
678 return url_for("packages.remove",
679 author=self.author.username, name=self.name)
681 def getNewScreenshotURL(self):
682 return url_for("packages.create_screenshot",
683 author=self.author.username, name=self.name)
685 def getCreateReleaseURL(self):
686 return url_for("packages.create_release",
687 author=self.author.username, name=self.name)
689 def getCreateEditRequestURL(self):
690 return url_for("create_edit_editrequest_page",
691 author=self.author.username, name=self.name)
693 def getBulkReleaseURL(self):
694 return url_for("packages.bulk_change_release",
695 author=self.author.username, name=self.name)
697 def getDownloadURL(self):
698 return url_for("packages.download",
699 author=self.author.username, name=self.name)
701 def getEditMaintainersURL(self):
702 return url_for("packages.edit_maintainers",
703 author=self.author.username, name=self.name)
705 def getRemoveSelfMaintainerURL(self):
706 return url_for("packages.remove_self_maintainers",
707 author=self.author.username, name=self.name)
709 def getUpdateFromReleaseURL(self):
710 return url_for("packages.update_from_release",
711 author=self.author.username, name=self.name)
713 def getReviewURL(self):
714 return url_for('packages.review',
715 author=self.author.username, name=self.name)
717 def getDownloadRelease(self, version=None):
718 for rel in self.releases:
719 if rel.approved and (version is None or
720 ((rel.min_rel is None or rel.min_rel_id <= version.id) and \
721 (rel.max_rel is None or rel.max_rel_id >= version.id))):
726 def checkPerm(self, user, perm):
727 if not user.is_authenticated:
730 if type(perm) == str:
731 perm = Permission[perm]
732 elif type(perm) != Permission:
733 raise Exception("Unknown permission given to Package.checkPerm()")
735 isOwner = user == self.author
736 isMaintainer = isOwner or user.rank.atLeast(UserRank.EDITOR) or user in self.maintainers
738 if perm == Permission.CREATE_THREAD:
739 return user.rank.atLeast(UserRank.MEMBER)
741 # Members can edit their own packages, and editors can edit any packages
742 elif perm == Permission.MAKE_RELEASE or perm == Permission.ADD_SCREENSHOTS:
745 elif perm == Permission.EDIT_PACKAGE or \
746 perm == Permission.APPROVE_CHANGES or perm == Permission.APPROVE_RELEASE:
747 return isMaintainer and user.rank.atLeast(UserRank.MEMBER if self.approved else UserRank.NEW_MEMBER)
749 # Anyone can change the package name when not approved, but only editors when approved
750 elif perm == Permission.CHANGE_NAME:
751 return not self.approved or user.rank.atLeast(UserRank.EDITOR)
753 # Editors can change authors and approve new packages
754 elif perm == Permission.APPROVE_NEW or perm == Permission.CHANGE_AUTHOR:
755 return user.rank.atLeast(UserRank.EDITOR)
757 elif perm == Permission.APPROVE_SCREENSHOT:
758 return isMaintainer and user.rank.atLeast(UserRank.TRUSTED_MEMBER if self.approved else UserRank.NEW_MEMBER)
760 elif perm == Permission.EDIT_MAINTAINERS:
761 return isOwner or user.rank.atLeast(UserRank.MODERATOR)
763 elif perm == Permission.UNAPPROVE_PACKAGE or perm == Permission.DELETE_PACKAGE:
764 return user.rank.atLeast(UserRank.EDITOR)
766 elif perm == Permission.CHANGE_RELEASE_URL:
767 return user.rank.atLeast(UserRank.MODERATOR)
769 elif perm == Permission.REIMPORT_META:
770 return user.rank.atLeast(UserRank.ADMIN)
773 raise Exception("Permission {} is not related to packages".format(perm.name))
775 def getScoreDict(self):
777 "author": self.author.username,
780 "score_downloads": self.score_downloads,
781 "score_reviews": self.score - self.score_downloads,
782 "downloads": self.downloads
785 def recalcScore(self):
786 review_scores = [ 100 * r.asSign() for r in self.reviews ]
787 self.score = self.score_downloads + sum(review_scores)
790 class MetaPackage(db.Model):
791 id = db.Column(db.Integer, primary_key=True)
792 name = db.Column(db.String(100), unique=True, nullable=False)
793 dependencies = db.relationship("Dependency", backref="meta_package", lazy="dynamic")
795 mp_name_valid = db.CheckConstraint("name ~* '^[a-z0-9_]+$'")
797 def __init__(self, name=None):
804 def ListToSpec(list):
805 return ",".join([str(x) for x in list])
808 def GetOrCreate(name, cache={}):
811 mp = MetaPackage.query.filter_by(name=name).first()
814 mp = MetaPackage(name)
821 def SpecToList(spec, cache={}):
823 arr = spec.split(",")
826 pattern = re.compile("^([a-z0-9_]+)$")
833 if not pattern.match(x):
836 retval.append(MetaPackage.GetOrCreate(x, cache))
841 class ContentWarning(db.Model):
842 id = db.Column(db.Integer, primary_key=True)
843 name = db.Column(db.String(100), unique=True, nullable=False)
844 title = db.Column(db.String(100), nullable=False)
845 description = db.Column(db.String(500), nullable=False)
847 def __init__(self, title, description=""):
849 self.description = description
852 regex = re.compile("[^a-z_]")
853 self.name = regex.sub("", self.title.lower().replace(" ", "_"))
857 id = db.Column(db.Integer, primary_key=True)
858 name = db.Column(db.String(100), unique=True, nullable=False)
859 title = db.Column(db.String(100), nullable=False)
860 description = db.Column(db.String(500), nullable=True, default=None)
861 backgroundColor = db.Column(db.String(6), nullable=False)
862 textColor = db.Column(db.String(6), nullable=False)
863 views = db.Column(db.Integer, nullable=False, default=0)
865 def __init__(self, title, backgroundColor="000000", textColor="ffffff"):
867 self.backgroundColor = backgroundColor
868 self.textColor = textColor
871 regex = re.compile("[^a-z_]")
872 self.name = regex.sub("", self.title.lower().replace(" ", "_"))
875 class MinetestRelease(db.Model):
876 id = db.Column(db.Integer, primary_key=True)
877 name = db.Column(db.String(100), unique=True, nullable=False)
878 protocol = db.Column(db.Integer, nullable=False, default=0)
880 def __init__(self, name=None, protocol=0):
882 self.protocol = protocol
885 return None if self.name == "None" else self
888 def get(cls, version, protocol_num):
890 parts = version.strip().split(".")
892 major_minor = parts[0] + "." + parts[1]
893 query = MinetestRelease.query.filter(MinetestRelease.name.like("{}%".format(major_minor)))
895 query = query.filter_by(protocol=protocol_num)
897 release = query.one_or_none()
902 return MinetestRelease.query.filter_by(protocol=protocol_num).first()
907 class PackageRelease(db.Model):
908 id = db.Column(db.Integer, primary_key=True)
910 package_id = db.Column(db.Integer, db.ForeignKey("package.id"))
911 title = db.Column(db.String(100), nullable=False)
912 releaseDate = db.Column(db.DateTime, nullable=False)
913 url = db.Column(db.String(200), nullable=False)
914 approved = db.Column(db.Boolean, nullable=False, default=False)
915 task_id = db.Column(db.String(37), nullable=True)
916 commit_hash = db.Column(db.String(41), nullable=True, default=None)
917 downloads = db.Column(db.Integer, nullable=False, default=0)
919 min_rel_id = db.Column(db.Integer, db.ForeignKey("minetest_release.id"), nullable=True, server_default=None)
920 min_rel = db.relationship("MinetestRelease", foreign_keys=[min_rel_id])
922 max_rel_id = db.Column(db.Integer, db.ForeignKey("minetest_release.id"), nullable=True, server_default=None)
923 max_rel = db.relationship("MinetestRelease", foreign_keys=[max_rel_id])
925 # If the release is approved, then the task_id must be null and the url must be present
926 CK_approval_valid = db.CheckConstraint("not approved OR (task_id IS NULL AND (url = '') IS NOT FALSE)")
928 def getAsDictionary(self):
932 "url": self.url if self.url != "" else None,
933 "release_date": self.releaseDate.isoformat(),
934 "commit": self.commit_hash,
935 "downloads": self.downloads,
936 "min_protocol": self.min_rel and self.min_rel.protocol,
937 "max_protocol": self.max_rel and self.max_rel.protocol
940 def getEditURL(self):
941 return url_for("packages.edit_release",
942 author=self.package.author.username,
943 name=self.package.name,
946 def getDeleteURL(self):
947 return url_for("packages.delete_release",
948 author=self.package.author.username,
949 name=self.package.name,
952 def getDownloadURL(self):
953 return url_for("packages.download_release",
954 author=self.package.author.username,
955 name=self.package.name,
959 self.releaseDate = datetime.datetime.now()
961 def approve(self, user):
962 if not self.package.checkPerm(user, Permission.APPROVE_RELEASE):
965 assert self.task_id is None and self.url is not None and self.url != ""
970 def checkPerm(self, user, perm):
971 if not user.is_authenticated:
974 if type(perm) == str:
975 perm = Permission[perm]
976 elif type(perm) != Permission:
977 raise Exception("Unknown permission given to PackageRelease.checkPerm()")
979 isOwner = user == self.package.author
981 if perm == Permission.DELETE_RELEASE:
982 if user.rank.atLeast(UserRank.ADMIN):
985 if not (isOwner or user.rank.atLeast(UserRank.EDITOR)):
988 if not self.package.approved or self.task_id is not None:
991 count = PackageRelease.query \
992 .filter_by(package_id=self.package_id) \
993 .filter(PackageRelease.id > self.id) \
998 raise Exception("Permission {} is not related to releases".format(perm.name))
1001 # class PackageReview(db.Model):
1002 # id = db.Column(db.Integer, primary_key=True)
1003 # package_id = db.Column(db.Integer, db.ForeignKey("package.id"))
1004 # thread_id = db.Column(db.Integer, db.ForeignKey("thread.id"), nullable=False)
1005 # recommend = db.Column(db.Boolean, nullable=False, default=True)
1008 class PackageScreenshot(db.Model):
1009 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 url = db.Column(db.String(100), nullable=False)
1013 approved = db.Column(db.Boolean, nullable=False, default=False)
1016 def getEditURL(self):
1017 return url_for("packages.edit_screenshot",
1018 author=self.package.author.username,
1019 name=self.package.name,
1022 def getThumbnailURL(self, level=2):
1023 return self.url.replace("/uploads/", ("/thumbnails/{:d}/").format(level))
1026 class APIToken(db.Model):
1027 id = db.Column(db.Integer, primary_key=True)
1028 access_token = db.Column(db.String(34), unique=True)
1030 name = db.Column(db.String(100), nullable=False)
1031 owner_id = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
1032 # owner is created using backref
1034 created_at = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
1036 package_id = db.Column(db.Integer, db.ForeignKey("package.id"), nullable=True)
1037 package = db.relationship("Package", foreign_keys=[package_id])
1039 def canOperateOnPackage(self, package):
1040 if self.package and self.package != package:
1043 return package.author == self.owner
1046 class EditRequest(db.Model):
1047 id = db.Column(db.Integer, primary_key=True)
1049 package_id = db.Column(db.Integer, db.ForeignKey("package.id"))
1050 author_id = db.Column(db.Integer, db.ForeignKey("user.id"))
1052 title = db.Column(db.String(100), nullable=False)
1053 desc = db.Column(db.String(1000), nullable=True)
1058 status = db.Column(db.Integer, nullable=False, default=0)
1060 changes = db.relationship("EditRequestChange", backref="request",
1064 return url_for("view_editrequest_page",
1065 author=self.package.author.username,
1066 name=self.package.name,
1069 def getApproveURL(self):
1070 return url_for("approve_editrequest_page",
1071 author=self.package.author.username,
1072 name=self.package.name,
1075 def getRejectURL(self):
1076 return url_for("reject_editrequest_page",
1077 author=self.package.author.username,
1078 name=self.package.name,
1081 def getEditURL(self):
1082 return url_for("create_edit_editrequest_page",
1083 author=self.package.author.username,
1084 name=self.package.name,
1087 def applyAll(self, package):
1088 for change in self.changes:
1089 change.apply(package)
1092 def checkPerm(self, user, perm):
1093 if not user.is_authenticated:
1096 if type(perm) == str:
1097 perm = Permission[perm]
1098 elif type(perm) != Permission:
1099 raise Exception("Unknown permission given to EditRequest.checkPerm()")
1101 isOwner = user == self.author
1103 # Members can edit their own packages, and editors can edit any packages
1104 if perm == Permission.EDIT_EDITREQUEST:
1105 return isOwner or user.rank.atLeast(UserRank.EDITOR)
1108 raise Exception("Permission {} is not related to packages".format(perm.name))
1113 class EditRequestChange(db.Model):
1114 id = db.Column(db.Integer, primary_key=True)
1116 request_id = db.Column(db.Integer, db.ForeignKey("edit_request.id"))
1117 key = db.Column(db.Enum(PackagePropertyKey), nullable=False)
1119 # TODO: make diff instead
1120 oldValue = db.Column(db.Text, nullable=True)
1121 newValue = db.Column(db.Text, nullable=True)
1123 def apply(self, package):
1124 if self.key == PackagePropertyKey.tags:
1125 package.tags.clear()
1126 for tagTitle in self.newValue.split(","):
1127 tag = Tag.query.filter_by(title=tagTitle.strip()).first()
1128 package.tags.append(tag)
1131 setattr(package, self.key.name, self.newValue)
1134 watchers = db.Table("watchers",
1135 db.Column("user_id", db.Integer, db.ForeignKey("user.id"), primary_key=True),
1136 db.Column("thread_id", db.Integer, db.ForeignKey("thread.id"), primary_key=True)
1139 class Thread(db.Model):
1140 id = db.Column(db.Integer, primary_key=True)
1142 package_id = db.Column(db.Integer, db.ForeignKey("package.id"), nullable=True)
1143 package = db.relationship("Package", foreign_keys=[package_id])
1145 review_id = db.Column(db.Integer, db.ForeignKey("package_review.id"), nullable=True)
1146 review = db.relationship("PackageReview", foreign_keys=[review_id])
1148 author_id = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
1149 title = db.Column(db.String(100), nullable=False)
1150 private = db.Column(db.Boolean, server_default="0", nullable=False)
1152 locked = db.Column(db.Boolean, server_default="0", nullable=False)
1154 created_at = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
1156 replies = db.relationship("ThreadReply", backref="thread", lazy="dynamic", \
1157 order_by=db.asc("thread_reply_id"))
1159 watchers = db.relationship("User", secondary=watchers, lazy="subquery", \
1160 backref=db.backref("watching", lazy=True))
1162 def getViewURL(self):
1163 return url_for("threads.view", id=self.id)
1165 def getSubscribeURL(self):
1166 return url_for("threads.subscribe", id=self.id)
1168 def getUnsubscribeURL(self):
1169 return url_for("threads.unsubscribe", id=self.id)
1171 def checkPerm(self, user, perm):
1172 if not user.is_authenticated:
1173 return perm == Permission.SEE_THREAD and not self.private
1175 if type(perm) == str:
1176 perm = Permission[perm]
1177 elif type(perm) != Permission:
1178 raise Exception("Unknown permission given to Thread.checkPerm()")
1180 isMaintainer = user == self.author or (self.package is not None and self.package.author == user)
1182 isMaintainer = isMaintainer or user in self.package.maintainers
1184 canSee = not self.private or isMaintainer or user.rank.atLeast(UserRank.EDITOR)
1186 if perm == Permission.SEE_THREAD:
1189 elif perm == Permission.COMMENT_THREAD:
1190 return canSee and (not self.locked or user.rank.atLeast(UserRank.MODERATOR))
1192 elif perm == Permission.LOCK_THREAD:
1193 return user.rank.atLeast(UserRank.MODERATOR)
1196 raise Exception("Permission {} is not related to threads".format(perm.name))
1198 class ThreadReply(db.Model):
1199 id = db.Column(db.Integer, primary_key=True)
1200 thread_id = db.Column(db.Integer, db.ForeignKey("thread.id"), nullable=False)
1201 comment = db.Column(db.String(2000), nullable=False)
1202 author_id = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
1203 created_at = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
1205 def checkPerm(self, user, perm):
1206 if not user.is_authenticated:
1209 if type(perm) == str:
1210 perm = Permission[perm]
1211 elif type(perm) != Permission:
1212 raise Exception("Unknown permission given to ThreadReply.checkPerm()")
1214 if perm == Permission.EDIT_REPLY:
1215 return user == self.author and user.rank.atLeast(UserRank.MEMBER) and not self.thread.locked
1217 elif perm == Permission.DELETE_REPLY:
1218 return user.rank.atLeast(UserRank.MODERATOR) and self.thread.replies[0] != self
1221 raise Exception("Permission {} is not related to threads".format(perm.name))
1224 class PackageReview(db.Model):
1225 id = db.Column(db.Integer, primary_key=True)
1227 package_id = db.Column(db.Integer, db.ForeignKey("package.id"), nullable=True)
1228 package = db.relationship("Package", foreign_keys=[package_id], backref=db.backref("reviews", lazy=True))
1230 created_at = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
1232 author_id = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
1233 author = db.relationship("User", foreign_keys=[author_id], backref=db.backref("reviews", lazy=True))
1235 recommends = db.Column(db.Boolean, nullable=False)
1237 thread = db.relationship("Thread", uselist=False, back_populates="review")
1240 return 1 if self.recommends else -1
1242 def getEditURL(self):
1243 return self.package.getReviewURL()
1245 def getDeleteURL(self):
1246 return url_for("packages.delete_review",
1247 author=self.package.author.username,
1248 name=self.package.name)
1251 class AuditSeverity(enum.Enum):
1252 NORMAL = 0 # Normal user changes
1253 EDITOR = 1 # Editor changes
1254 MODERATION = 2 # Destructive / moderator changes
1260 return self.name.replace("_", " ").title()
1264 return [(choice, choice.getTitle()) for choice in cls]
1267 def coerce(cls, item):
1268 return item if type(item) == AuditSeverity else AuditSeverity[item]
1272 class AuditLogEntry(db.Model):
1273 id = db.Column(db.Integer, primary_key=True)
1275 created_at = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
1277 causer_id = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
1278 causer = db.relationship("User", foreign_keys=[causer_id])
1280 severity = db.Column(db.Enum(AuditSeverity), nullable=False)
1282 title = db.Column(db.String(100), nullable=False)
1283 url = db.Column(db.String(200), nullable=True)
1285 package_id = db.Column(db.Integer, db.ForeignKey("package.id"), nullable=True)
1286 package = db.relationship("Package", foreign_keys=[package_id])
1288 description = db.Column(db.Text, nullable=True, default=None)
1290 def __init__(self, causer, severity, title, url, package=None, description=None):
1291 if len(title) > 100:
1292 title = title[:99] + "…"
1294 self.causer = causer
1295 self.severity = severity
1298 self.package = package
1299 self.description = description
1304 REPO_BLACKLIST = [".zip", "mediafire.com", "dropbox.com", "weebly.com", \
1305 "minetest.net", "dropboxusercontent.com", "4shared.com", \
1306 "digitalaudioconcepts.com", "hg.intevation.org", "www.wtfpl.net", \
1307 "imageshack.com", "imgur.com"]
1309 class ForumTopic(db.Model):
1310 topic_id = db.Column(db.Integer, primary_key=True, autoincrement=False)
1311 author_id = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
1312 author = db.relationship("User")
1314 wip = db.Column(db.Boolean, server_default="0")
1315 discarded = db.Column(db.Boolean, server_default="0")
1317 type = db.Column(db.Enum(PackageType), nullable=False)
1318 title = db.Column(db.String(200), nullable=False)
1319 name = db.Column(db.String(30), nullable=True)
1320 link = db.Column(db.String(200), nullable=True)
1322 posts = db.Column(db.Integer, nullable=False)
1323 views = db.Column(db.Integer, nullable=False)
1325 created_at = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
1327 def getRepoURL(self):
1328 if self.link is None:
1331 for item in REPO_BLACKLIST:
1332 if item in self.link:
1335 return self.link.replace("repo.or.cz/w/", "repo.or.cz/")
1337 def getAsDictionary(self):
1339 "author": self.author.username,
1341 "type": self.type.toName(),
1342 "title": self.title,
1343 "id": self.topic_id,
1345 "posts": self.posts,
1346 "views": self.views,
1348 "discarded": self.discarded,
1349 "created_at": self.created_at.isoformat(),
1352 def checkPerm(self, user, perm):
1353 if not user.is_authenticated:
1356 if type(perm) == str:
1357 perm = Permission[perm]
1358 elif type(perm) != Permission:
1359 raise Exception("Unknown permission given to ForumTopic.checkPerm()")
1361 if perm == Permission.TOPIC_DISCARD:
1362 return self.author == user or user.rank.atLeast(UserRank.EDITOR)
1365 raise Exception("Permission {} is not related to topics".format(perm.name))
1369 user_manager = UserManager(app, db, User)
1371 if app.config.get("LOG_SQL"):
1373 logging.basicConfig()
1374 logging.getLogger('sqlalchemy.engine').setLevel(logging.INFO)