]> git.lizzy.rs Git - cheatdb.git/blobdiff - app/models.py
Add badges next to packages awaiting approval list
[cheatdb.git] / app / models.py
index 338b4f0bf7abc274b281c2a7d2d19a964928bdab..be4cdea0c255989c42d65cb6b09b6cbe816e6369 100644 (file)
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 
+import enum, datetime
+
+from app import app, gravatar
+from urllib.parse import urlparse
+
 from flask import Flask, url_for
-from flask_sqlalchemy import SQLAlchemy
+from flask_sqlalchemy import SQLAlchemy, BaseQuery
 from flask_migrate import Migrate
-from urllib.parse import urlparse
-from app import app
-from datetime import datetime
-from sqlalchemy.orm import validates
 from flask_user import login_required, UserManager, UserMixin, SQLAlchemyAdapter
-import enum
+from sqlalchemy.orm import validates
+from sqlalchemy_searchable import SearchQueryMixin
+from sqlalchemy_utils.types import TSVectorType
+from sqlalchemy_searchable import make_searchable
+
 
 # Initialise database
 db = SQLAlchemy(app)
 migrate = Migrate(app, db)
+make_searchable(db.metadata)
+
+
+class ArticleQuery(BaseQuery, SearchQueryMixin):
+       pass
 
 
 class UserRank(enum.Enum):
@@ -77,6 +87,9 @@ class Permission(enum.Enum):
        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
@@ -85,34 +98,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")
@@ -124,8 +139,6 @@ class User(db.Model, UserMixin):
        replies       = db.relationship("ThreadReply", backref="author", lazy="dynamic")
 
        def __init__(self, username, active=False, email=None, password=None):
-               import datetime
-
                self.username = username
                self.confirmed_at = datetime.datetime.now() - datetime.timedelta(days=6000)
                self.display_name = username
@@ -142,6 +155,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
@@ -161,6 +180,16 @@ class User(db.Model, UserMixin):
                else:
                        raise Exception("Permission {} is not related to users".format(perm.name))
 
+       def canCommentRL(self):
+               hour_ago = datetime.datetime.utcnow() - datetime.timedelta(hours=1)
+               return ThreadReply.query.filter_by(author=self) \
+                       .filter(ThreadReply.created_at > hour_ago).count() < 4
+
+       def canOpenThreadRL(self):
+               hour_ago = datetime.datetime.utcnow() - datetime.timedelta(hours=1)
+               return Thread.query.filter_by(author=self) \
+                       .filter(Thread.created_at > hour_ago).count() < 2
+
 class UserEmailVerification(db.Model):
        id      = db.Column(db.Integer, primary_key=True)
        user_id = db.Column(db.Integer, db.ForeignKey("user.id"))
@@ -209,6 +238,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]
@@ -221,7 +257,7 @@ class PackageType(enum.Enum):
 class PackagePropertyKey(enum.Enum):
        name          = "Name"
        title         = "Title"
-       shortDesc     = "Short Description"
+       short_desc     = "Short Description"
        desc          = "Description"
        type          = "Type"
        license       = "License"
@@ -318,18 +354,21 @@ class Dependency(db.Model):
                return retval
 
 
-
 class Package(db.Model):
+       query_class  = ArticleQuery
+
        id           = db.Column(db.Integer, primary_key=True)
 
        # Basic details
        author_id    = db.Column(db.Integer, db.ForeignKey("user.id"))
        name         = db.Column(db.String(100), nullable=False)
-       title        = db.Column(db.String(100), nullable=False)
-       shortDesc    = db.Column(db.String(200), nullable=False)
-       desc         = db.Column(db.Text, nullable=True)
+       title        = db.Column(db.Unicode(100), nullable=False)
+       short_desc   = db.Column(db.Unicode(200), nullable=False)
+       desc         = db.Column(db.UnicodeText, nullable=True)
        type         = db.Column(db.Enum(PackageType))
-       created_at   = db.Column(db.DateTime, nullable=False, default=datetime.utcnow)
+       created_at   = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
+
+       search_vector = db.Column(TSVectorType("title", "short_desc", "desc"))
 
        license_id   = db.Column(db.Integer, db.ForeignKey("license.id"), nullable=False, default=1)
        license      = db.relationship("License", foreign_keys=[license_id])
@@ -362,7 +401,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")
@@ -378,36 +417,54 @@ class Package(db.Model):
                for e in PackagePropertyKey:
                        setattr(self, e.name, getattr(package, e.name))
 
-       def getAsDictionaryShort(self, base_url):
-               tnurl = self.getThumbnailURL()
+       def getState(self):
+               if self.approved:
+                       return "approved"
+               elif self.review_thread_id:
+                       return "thread"
+               elif (self.type == PackageType.GAME or \
+                                       self.type == PackageType.TXP) and \
+                               self.screenshots.count() == 0:
+                       return "wip"
+               elif not self.getDownloadRelease():
+                       return "wip"
+               elif "Other" in self.license.name or "Other" in self.media_license.name:
+                       return "license"
+               else:
+                       return "ready"
+
+       def getAsDictionaryShort(self, base_url, version=None, protonum=None):
+               tnurl = self.getThumbnailURL(1)
+               release = self.getDownloadRelease(version=version, protonum=protonum)
                return {
                        "name": self.name,
                        "title": self.title,
                        "author": self.author.display_name,
-                       "shortDesc": self.shortDesc,
+                       "short_description": self.short_desc,
                        "type": self.type.toName(),
-                       "release": self.getDownloadRelease().id if self.getDownloadRelease() is not None else None,
+                       "release": release and release.id,
                        "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()
+       def getAsDictionary(self, base_url, version=None, protonum=None):
+               tnurl = self.getThumbnailURL(1)
+               release = self.getDownloadRelease(version=version, protonum=protonum)
                return {
                        "author": self.author.display_name,
                        "name": self.name,
                        "title": self.title,
-                       "shortDesc": self.shortDesc,
+                       "short_description": self.short_desc,
                        "desc": self.desc,
                        "type": self.type.toName(),
-                       "createdAt": self.created_at,
+                       "created_at": self.created_at,
 
                        "license": self.license.name,
-                       "mediaLicense": self.media_license.name,
+                       "media_license": self.media_license.name,
 
                        "repo": self.repo,
                        "website": self.website,
-                       "issueTracker": self.issueTracker,
+                       "issue_tracker": self.issueTracker,
                        "forums": self.forums,
 
                        "provides": [x.name for x in self.provides],
@@ -415,17 +472,17 @@ class Package(db.Model):
                        "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,
+                       "release": release and release.id,
 
                        "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):
@@ -440,8 +497,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):
@@ -456,17 +513,37 @@ class Package(db.Model):
                return url_for("create_edit_editrequest_page",
                                author=self.author.username, name=self.name)
 
+       def getBulkReleaseURL(self):
+               return url_for("bulk_change_release_page",
+                       author=self.author.username, name=self.name)
+
        def getDownloadURL(self):
                return url_for("package_download_page",
                                author=self.author.username, name=self.name)
 
-       def getDownloadRelease(self):
+       def getDownloadRelease(self, version=None, protonum=None):
+               if version is None and protonum is not None:
+                       version = MinetestRelease.query.filter(MinetestRelease.protocol >= int(protonum)).first()
+                       if version is not None:
+                               version = version.id
+                       else:
+                               version = 10000000
+
+
                for rel in self.releases:
-                       if rel.approved:
+                       if rel.approved and (version is None or
+                                       ((rel.min_rel is None or rel.min_rel_id <= version) and \
+                                       (rel.max_rel is None or rel.max_rel_id >= version))):
                                return rel
 
                return None
 
+       def getDownloadCount(self):
+               counter = 0
+               for release in self.releases:
+                       counter += release.downloads
+               return counter
+
        def checkPerm(self, user, perm):
                if not user.is_authenticated:
                        return False
@@ -478,6 +555,9 @@ class Package(db.Model):
 
                isOwner = user == self.author
 
+               if perm == Permission.CREATE_THREAD:
+                       return user.rank.atLeast(UserRank.MEMBER)
+
                # Members can edit their own packages, and editors can edit any packages
                if perm == Permission.MAKE_RELEASE or perm == Permission.ADD_SCREENSHOTS:
                        return isOwner or user.rank.atLeast(UserRank.EDITOR)
@@ -488,35 +568,37 @@ 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
 
-               self.score = 0
+               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.forums is None:
-                       return
+               if self.getMainScreenshotURL() is None:
+                       self.score *= 0.8
 
-               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 / years + 80*min(6, months)
+               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)
@@ -582,15 +664,36 @@ class Tag(db.Model):
                regex = re.compile("[^a-z_]")
                self.name = regex.sub("", self.title.lower().replace(" ", "_"))
 
+
+class MinetestRelease(db.Model):
+       id       = db.Column(db.Integer, primary_key=True)
+       name     = db.Column(db.String(100), unique=True, nullable=False)
+       protocol = db.Column(db.Integer, nullable=False, default=0)
+
+       def __init__(self, name=None):
+               self.name = name
+
+       def getActual(self):
+               return None if self.name == "None" else self
+
+
 class PackageRelease(db.Model):
        id           = db.Column(db.Integer, primary_key=True)
 
        package_id   = db.Column(db.Integer, db.ForeignKey("package.id"))
        title        = db.Column(db.String(100), nullable=False)
-       releaseDate  = db.Column(db.DateTime,        nullable=False)
+       releaseDate  = db.Column(db.DateTime,    nullable=False)
        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)
+       downloads    = db.Column(db.Integer, nullable=False, default=0)
+
+       min_rel_id = db.Column(db.Integer, db.ForeignKey("minetest_release.id"), nullable=True, server_default=None)
+       min_rel    = db.relationship("MinetestRelease", foreign_keys=[min_rel_id])
+
+       max_rel_id = db.Column(db.Integer, db.ForeignKey("minetest_release.id"), nullable=True, server_default=None)
+       max_rel    = db.relationship("MinetestRelease", foreign_keys=[max_rel_id])
 
 
        def getEditURL(self):
@@ -599,8 +702,32 @@ 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()
+               self.releaseDate = datetime.datetime.now()
+
+       def approve(self, user):
+               if not self.package.checkPerm(user, Permission.APPROVE_RELEASE):
+                       return False
+
+               assert(self.task_id is None and self.url is not None and self.url != "")
+
+               self.approved = True
+               return True
+
+
+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)
@@ -616,8 +743,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)
@@ -722,13 +851,22 @@ class Thread(db.Model):
        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)
+       created_at = db.Column(db.DateTime, nullable=False, default=datetime.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
@@ -751,11 +889,7 @@ class ThreadReply(db.Model):
        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)
-
-
-
-
+       created_at = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
 
 
 REPO_BLACKLIST = [".zip", "mediafire.com", "dropbox.com", "weebly.com", \
@@ -768,6 +902,9 @@ class ForumTopic(db.Model):
        author_id = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
        author    = db.relationship("User")
 
+       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)
@@ -776,7 +913,7 @@ class ForumTopic(db.Model):
        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)
+       created_at = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
 
        def getRepoURL(self):
                if self.link is None:
@@ -788,6 +925,36 @@ class ForumTopic(db.Model):
 
                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
 db_adapter = SQLAlchemyAdapter(db, User)        # Register the User model