]> git.lizzy.rs Git - cheatdb.git/blobdiff - app/models.py
Fix weird ordering of screenshots
[cheatdb.git] / app / models.py
index f045d75b9405b39fd9f5b2bfd9d54c7623a84d31..b1cfbb576d8091502f9d5191aed1a4059779bd92 100644 (file)
@@ -19,7 +19,7 @@ from flask import Flask, url_for
 from flask_sqlalchemy import SQLAlchemy
 from flask_migrate import Migrate
 from urllib.parse import urlparse
-from app import app
+from app import app, gravatar
 from datetime import datetime
 from sqlalchemy.orm import validates
 from flask_user import login_required, UserManager, UserMixin, SQLAlchemyAdapter
@@ -76,6 +76,10 @@ class Permission(enum.Enum):
        CHANGE_RANK        = "CHANGE_RANK"
        CHANGE_EMAIL       = "CHANGE_EMAIL"
        EDIT_EDITREQUEST   = "EDIT_EDITREQUEST"
+       SEE_THREAD         = "SEE_THREAD"
+       CREATE_THREAD      = "CREATE_THREAD"
+       UNAPPROVE_PACKAGE  = "UNAPPROVE_PACKAGE"
+       TOPIC_DISCARD      = "TOPIC_DISCARD"
 
        # Only return true if the permission is valid for *all* contexts
        # See Package.checkPerm for package-specific contexts
@@ -84,35 +88,36 @@ class Permission(enum.Enum):
                        return False
 
                if self == Permission.APPROVE_NEW or \
-                               self == Permission.APPROVE_CHANGES or \
-                               self == Permission.APPROVE_RELEASE or \
-                               self == Permission.APPROVE_SCREENSHOT:
+                               self == Permission.APPROVE_CHANGES    or \
+                               self == Permission.APPROVE_RELEASE    or \
+                               self == Permission.APPROVE_SCREENSHOT or \
+                               self == Permission.SEE_THREAD:
                        return user.rank.atLeast(UserRank.EDITOR)
                else:
                        raise Exception("Non-global permission checked globally. Use Package.checkPerm or User.checkPerm instead.")
 
-
 class User(db.Model, UserMixin):
-       id = db.Column(db.Integer, primary_key=True)
+       id           = db.Column(db.Integer, primary_key=True)
 
        # User authentication information
-       username = db.Column(db.String(50, collation="NOCASE"), nullable=False, unique=True, index=True)
-       password = db.Column(db.String(255), nullable=True)
+       username     = db.Column(db.String(50, collation="NOCASE"), nullable=False, unique=True, index=True)
+       password     = db.Column(db.String(255), nullable=True)
        reset_password_token = db.Column(db.String(100), nullable=False, server_default="")
 
-       rank = db.Column(db.Enum(UserRank))
+       rank         = db.Column(db.Enum(UserRank))
 
        # Account linking
        github_username = db.Column(db.String(50, collation="NOCASE"), nullable=True, unique=True)
        forums_username = db.Column(db.String(50, collation="NOCASE"), nullable=True, unique=True)
 
        # User email information
-       email = db.Column(db.String(255), nullable=True, unique=True)
-       confirmed_at = db.Column(db.DateTime())
+       email         = db.Column(db.String(255), nullable=True, unique=True)
+       confirmed_at  = db.Column(db.DateTime())
 
        # User information
-       active = db.Column("is_active", db.Boolean, nullable=False, server_default="0")
-       display_name = db.Column(db.String(100), nullable=False, server_default="")
+       profile_pic   = db.Column(db.String(255), nullable=True, server_default=None)
+       active        = db.Column("is_active", db.Boolean, nullable=False, server_default="0")
+       display_name  = db.Column(db.String(100), nullable=False, server_default="")
 
        # Content
        notifications = db.relationship("Notification", primaryjoin="User.id==Notification.user_id")
@@ -120,6 +125,8 @@ class User(db.Model, UserMixin):
        # causednotifs  = db.relationship("Notification", backref="causer", lazy="dynamic")
        packages      = db.relationship("Package", backref="author", lazy="dynamic")
        requests      = db.relationship("EditRequest", backref="author", lazy="dynamic")
+       threads       = db.relationship("Thread", backref="author", lazy="dynamic")
+       replies       = db.relationship("ThreadReply", backref="author", lazy="dynamic")
 
        def __init__(self, username, active=False, email=None, password=None):
                import datetime
@@ -140,6 +147,12 @@ class User(db.Model, UserMixin):
        def isClaimed(self):
                return self.rank.atLeast(UserRank.NEW_MEMBER)
 
+       def getProfilePicURL(self):
+               if self.profile_pic:
+                       return self.profile_pic
+               else:
+                       return gravatar(self.email or "")
+
        def checkPerm(self, user, perm):
                if not user.is_authenticated:
                        return False
@@ -207,6 +220,13 @@ class PackageType(enum.Enum):
        def __str__(self):
                return self.name
 
+       @classmethod
+       def get(cls, name):
+               try:
+                       return PackageType[name.upper()]
+               except KeyError:
+                       return None
+
        @classmethod
        def choices(cls):
                return [(choice, choice.value) for choice in cls]
@@ -337,6 +357,11 @@ class Package(db.Model):
        approved     = db.Column(db.Boolean, nullable=False, default=False)
        soft_deleted = db.Column(db.Boolean, nullable=False, default=False)
 
+       score        = db.Column(db.Float, nullable=False, default=0)
+
+       review_thread_id = db.Column(db.Integer, db.ForeignKey("thread.id"), nullable=True, default=None)
+       review_thread    = db.relationship("Thread", foreign_keys=[review_thread_id])
+
        # Downloads
        repo         = db.Column(db.String(200), nullable=True)
        website      = db.Column(db.String(200), nullable=True)
@@ -355,7 +380,7 @@ class Package(db.Model):
                        lazy="dynamic", order_by=db.desc("package_release_releaseDate"))
 
        screenshots = db.relationship("PackageScreenshot", backref="package",
-                       lazy="dynamic")
+                       lazy="dynamic", order_by=db.asc("package_screenshot_id"))
 
        requests = db.relationship("EditRequest", backref="package",
                        lazy="dynamic")
@@ -371,28 +396,54 @@ class Package(db.Model):
                for e in PackagePropertyKey:
                        setattr(self, e.name, getattr(package, e.name))
 
-       def getAsDictionary(self, base_url):
-               tnurl = self.getThumbnailURL()
+       def getAsDictionaryShort(self, base_url):
+               tnurl = self.getThumbnailURL(1)
                return {
                        "name": self.name,
                        "title": self.title,
                        "author": self.author.display_name,
-                       "shortDesc": self.shortDesc,
+                       "short_description": self.shortDesc,
                        "type": self.type.toName(),
+                       "release": self.getDownloadRelease().id if self.getDownloadRelease() is not None else None,
+                       "thumbnail": (base_url + tnurl) if tnurl is not None else None,
+                       "score": round(self.score * 10) / 10
+               }
+
+       def getAsDictionary(self, base_url):
+               tnurl = self.getThumbnailURL(1)
+               return {
+                       "author": self.author.display_name,
+                       "name": self.name,
+                       "title": self.title,
+                       "short_description": self.shortDesc,
+                       "desc": self.desc,
+                       "type": self.type.toName(),
+                       "created_at": self.created_at,
+
                        "license": self.license.name,
+                       "media_license": self.media_license.name,
+
                        "repo": self.repo,
+                       "website": self.website,
+                       "issue_tracker": self.issueTracker,
+                       "forums": self.forums,
+
+                       "provides": [x.name for x in self.provides],
+                       "thumbnail": (base_url + tnurl) if tnurl is not None else None,
+                       "screenshots": [base_url + ss.url for ss in self.screenshots],
+
                        "url": base_url + self.getDownloadURL(),
                        "release": self.getDownloadRelease().id if self.getDownloadRelease() is not None else None,
-                       "screenshots": [base_url + ss.url for ss in self.screenshots],
-                       "thumbnail": (base_url + tnurl) if tnurl is not None else None
+
+                       "score": round(self.score * 10) / 10
                }
 
-       def getThumbnailURL(self):
-               screenshot = self.screenshots.filter_by(approved=True).first()
-               return screenshot.getThumbnailURL() if screenshot is not None else None
+       def getThumbnailURL(self, level=2):
+               screenshot = self.screenshots.filter_by(approved=True).order_by(db.asc(PackageScreenshot.id)).first()
+               return screenshot.getThumbnailURL(level) if screenshot is not None else None
 
        def getMainScreenshotURL(self):
-               screenshot = self.screenshots.filter_by(approved=True).first()
+               screenshot = self.screenshots.filter_by(approved=True).order_by(db.asc(PackageScreenshot.id)).first()
                return screenshot.url if screenshot is not None else None
 
        def getDetailsURL(self):
@@ -407,8 +458,8 @@ class Package(db.Model):
                return url_for("approve_package_page",
                                author=self.author.username, name=self.name)
 
-       def getDeleteURL(self):
-               return url_for("delete_package_page",
+       def getRemoveURL(self):
+               return url_for("remove_package_page",
                                author=self.author.username, name=self.name)
 
        def getNewScreenshotURL(self):
@@ -434,16 +485,6 @@ class Package(db.Model):
 
                return None
 
-       def canMakeReleaseFromVCS(self):
-               if self.repo is None:
-                       return False
-
-               url = urlparse(self.repo)
-               if url.netloc == "github.com":
-                       return True
-
-               return False
-
        def checkPerm(self, user, perm):
                if not user.is_authenticated:
                        return False
@@ -456,7 +497,7 @@ class Package(db.Model):
                isOwner = user == self.author
 
                # Members can edit their own packages, and editors can edit any packages
-               if perm == Permission.MAKE_RELEASE or perm == Permission.ADD_SCREENSHOTS:
+               if perm == Permission.MAKE_RELEASE or perm == Permission.ADD_SCREENSHOTS or perm == Permission.CREATE_THREAD:
                        return isOwner or user.rank.atLeast(UserRank.EDITOR)
 
                if perm == Permission.EDIT_PACKAGE or perm == Permission.APPROVE_CHANGES:
@@ -465,21 +506,40 @@ class Package(db.Model):
                        else:
                                return user.rank.atLeast(UserRank.EDITOR)
 
-               # Editors can change authors
-               elif perm == Permission.CHANGE_AUTHOR:
+               # Editors can change authors and approve new packages
+               elif perm == Permission.APPROVE_NEW or perm == Permission.CHANGE_AUTHOR:
                        return user.rank.atLeast(UserRank.EDITOR)
 
-               elif perm == Permission.APPROVE_NEW or perm == Permission.APPROVE_RELEASE \
-                               or perm == Permission.APPROVE_SCREENSHOT:
+               elif perm == Permission.APPROVE_RELEASE or perm == Permission.APPROVE_SCREENSHOT:
                        return user.rank.atLeast(UserRank.TRUSTED_MEMBER if isOwner else UserRank.EDITOR)
 
                # Moderators can delete packages
-               elif perm == Permission.DELETE_PACKAGE or perm == Permission.CHANGE_RELEASE_URL:
+               elif perm == Permission.DELETE_PACKAGE or perm == Permission.UNAPPROVE_PACKAGE \
+                               or perm == Permission.CHANGE_RELEASE_URL:
                        return user.rank.atLeast(UserRank.MODERATOR)
 
                else:
                        raise Exception("Permission {} is not related to packages".format(perm.name))
 
+       def recalcScore(self):
+               import datetime
+
+               self.score = 10
+
+               if self.forums is not None:
+                       topic = ForumTopic.query.get(self.forums)
+                       if topic:
+                               days   = (datetime.datetime.now() - topic.created_at).days
+                               months = days / 30
+                               years  = days / 365
+                               self.score = topic.views / max(years, 0.0416) + 80*min(max(months, 0.5), 6)
+
+               if self.getMainScreenshotURL() is None:
+                       self.score *= 0.8
+
+               if not self.license.is_foss or not self.media_license.is_foss:
+                       self.score *= 0.1
+
 class MetaPackage(db.Model):
        id           = db.Column(db.Integer, primary_key=True)
        name         = db.Column(db.String(100), unique=True, nullable=False)
@@ -553,6 +613,7 @@ class PackageRelease(db.Model):
        url          = db.Column(db.String(200), nullable=False)
        approved     = db.Column(db.Boolean, nullable=False, default=False)
        task_id      = db.Column(db.String(37), nullable=True)
+       commit_hash  = db.Column(db.String(41), nullable=True, default=None)
 
 
        def getEditURL(self):
@@ -561,9 +622,24 @@ class PackageRelease(db.Model):
                                name=self.package.name,
                                id=self.id)
 
+       def getDownloadURL(self):
+               return url_for("download_release_page",
+                               author=self.package.author.username,
+                               name=self.package.name,
+                               id=self.id)
+
+
        def __init__(self):
                self.releaseDate = datetime.now()
 
+
+class PackageReview(db.Model):
+       id         = db.Column(db.Integer, primary_key=True)
+       package_id = db.Column(db.Integer, db.ForeignKey("package.id"))
+       thread_id  = db.Column(db.Integer, db.ForeignKey("thread.id"), nullable=False)
+       recommend  = db.Column(db.Boolean, nullable=False, default=True)
+
+
 class PackageScreenshot(db.Model):
        id         = db.Column(db.Integer, primary_key=True)
        package_id = db.Column(db.Integer, db.ForeignKey("package.id"))
@@ -578,8 +654,10 @@ class PackageScreenshot(db.Model):
                                name=self.package.name,
                                id=self.id)
 
-       def getThumbnailURL(self):
-               return self.url.replace("/uploads/", "/thumbnails/350x233/")
+       def getThumbnailURL(self, level=2):
+               return self.url.replace("/uploads/", ("/thumbnails/{:d}/").format(level))
+
+
 
 class EditRequest(db.Model):
        id           = db.Column(db.Integer, primary_key=True)
@@ -669,22 +747,124 @@ class EditRequestChange(db.Model):
                        setattr(package, self.key.name, self.newValue)
 
 
+watchers = db.Table("watchers",
+    db.Column("user_id", db.Integer, db.ForeignKey("user.id"), primary_key=True),
+    db.Column("thread_id", db.Integer, db.ForeignKey("thread.id"), primary_key=True)
+)
+
+class Thread(db.Model):
+       id         = db.Column(db.Integer, primary_key=True)
+
+       package_id = db.Column(db.Integer, db.ForeignKey("package.id"), nullable=True)
+       package    = db.relationship("Package", foreign_keys=[package_id])
+
+       author_id  = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
+       title      = db.Column(db.String(100), nullable=False)
+       private    = db.Column(db.Boolean, server_default="0")
+
+       created_at = db.Column(db.DateTime, nullable=False, default=datetime.utcnow)
+
+       replies    = db.relationship("ThreadReply", backref="thread", lazy="dynamic")
+
+       watchers   = db.relationship("User", secondary=watchers, lazy="subquery", \
+                                               backref=db.backref("watching", lazy=True))
+
+
+       def getSubscribeURL(self):
+               return url_for("thread_subscribe_page",
+                               id=self.id)
+
+       def getUnsubscribeURL(self):
+               return url_for("thread_unsubscribe_page",
+                               id=self.id)
+
+       def checkPerm(self, user, perm):
+               if not user.is_authenticated:
+                       return not self.private
+
+               if type(perm) == str:
+                       perm = Permission[perm]
+               elif type(perm) != Permission:
+                       raise Exception("Unknown permission given to Thread.checkPerm()")
+
+               isOwner = user == self.author or (self.package is not None and self.package.author == user)
+
+               if perm == Permission.SEE_THREAD:
+                       return not self.private or isOwner or user.rank.atLeast(UserRank.EDITOR)
+
+               else:
+                       raise Exception("Permission {} is not related to threads".format(perm.name))
+
+class ThreadReply(db.Model):
+       id         = db.Column(db.Integer, primary_key=True)
+       thread_id  = db.Column(db.Integer, db.ForeignKey("thread.id"), nullable=False)
+       comment    = db.Column(db.String(500), nullable=False)
+       author_id  = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
+       created_at = db.Column(db.DateTime, nullable=False, default=datetime.utcnow)
 
-class KrockForumTopic(db.Model):
+
+REPO_BLACKLIST = [".zip", "mediafire.com", "dropbox.com", "weebly.com", \
+               "minetest.net", "dropboxusercontent.com", "4shared.com", \
+               "digitalaudioconcepts.com", "hg.intevation.org", "www.wtfpl.net", \
+               "imageshack.com", "imgur.com"]
+
+class ForumTopic(db.Model):
        topic_id  = db.Column(db.Integer, primary_key=True, autoincrement=False)
        author_id = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
        author    = db.relationship("User")
 
-       ttype     = db.Column(db.Integer, nullable=False)
+       wip       = db.Column(db.Boolean, server_default="0")
+       discarded = db.Column(db.Boolean, server_default="0")
+
+       type      = db.Column(db.Enum(PackageType), nullable=False)
        title     = db.Column(db.String(200), nullable=False)
        name      = db.Column(db.String(30), nullable=True)
        link      = db.Column(db.String(200), nullable=True)
 
-       def getType(self):
-               if self.ttype == 1 or self.ttype == 2:
-                       return PackageType.MOD
-               elif self.ttype == 6:
-                       return PackageType.GAME
+       posts     = db.Column(db.Integer, nullable=False)
+       views     = db.Column(db.Integer, nullable=False)
+
+       created_at = db.Column(db.DateTime, nullable=False, default=datetime.utcnow)
+
+       def getRepoURL(self):
+               if self.link is None:
+                       return None
+
+               for item in REPO_BLACKLIST:
+                       if item in self.link:
+                               return None
+
+               return self.link.replace("repo.or.cz/w/", "repo.or.cz/")
+
+       def getAsDictionary(self):
+               return {
+                       "author": self.author.username,
+                       "name":   self.name,
+                       "type":   self.type.toName(),
+                       "title":  self.title,
+                       "id":     self.topic_id,
+                       "link":   self.link,
+                       "posts":  self.posts,
+                       "views":  self.views,
+                       "is_wip": self.wip,
+                       "discarded":  self.discarded,
+                       "created_at": self.created_at.isoformat(),
+               }
+
+       def checkPerm(self, user, perm):
+               if not user.is_authenticated:
+                       return False
+
+               if type(perm) == str:
+                       perm = Permission[perm]
+               elif type(perm) != Permission:
+                       raise Exception("Unknown permission given to ForumTopic.checkPerm()")
+
+               if perm == Permission.TOPIC_DISCARD:
+                       return self.author == user or user.rank.atLeast(UserRank.EDITOR)
+
+               else:
+                       raise Exception("Permission {} is not related to topics".format(perm.name))
 
 
 # Setup Flask-User