contentdb/app/models/packages.py

1091 lines
34 KiB
Python
Raw Normal View History

2020-07-12 17:34:25 +02:00
# ContentDB
2021-01-30 17:59:42 +01:00
# Copyright (C) 2018-21 rubenwardy
2018-05-17 16:18:20 +02:00
#
# This program is free software: you can redistribute it and/or modify
2021-01-30 17:59:42 +01:00
# it under the terms of the GNU Affero General Public License as published by
2018-05-17 16:18:20 +02:00
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
2021-01-30 17:59:42 +01:00
# GNU Affero General Public License for more details.
2018-05-17 16:18:20 +02:00
#
2021-01-30 17:59:42 +01:00
# You should have received a copy of the GNU Affero General Public License
2018-05-17 16:18:20 +02:00
# along with this program. If not, see <https://www.gnu.org/licenses/>.
2020-12-04 03:23:04 +01:00
import datetime
import enum
2019-01-29 04:00:01 +01:00
2020-12-04 03:23:04 +01:00
from flask import url_for
2020-12-10 12:37:15 +01:00
from flask_sqlalchemy import BaseQuery
from sqlalchemy_searchable import SearchQueryMixin
2019-01-29 04:00:01 +01:00
from sqlalchemy_utils.types import TSVectorType
2020-12-05 21:36:09 +01:00
2020-12-10 12:37:15 +01:00
from . import db
from .users import Permission, UserRank, User
2019-01-29 04:00:01 +01:00
class PackageQuery(BaseQuery, SearchQueryMixin):
pass
2018-03-18 18:43:30 +01:00
2018-04-03 15:13:11 +02:00
class License(db.Model):
2018-05-29 22:24:50 +02:00
id = db.Column(db.Integer, primary_key=True)
name = db.Column(db.String(50), nullable=False, unique=True)
is_foss = db.Column(db.Boolean, nullable=False, default=True)
2021-07-31 22:03:45 +02:00
url = db.Column(db.String(128), nullable=True, default=None)
2018-04-03 15:13:11 +02:00
2021-07-31 22:03:45 +02:00
def __init__(self, v: str, is_foss: bool = True, url: str = None):
2018-04-03 15:13:11 +02:00
self.name = v
2018-05-29 22:24:50 +02:00
self.is_foss = is_foss
2021-07-31 22:03:45 +02:00
self.url = url
2018-04-03 15:13:11 +02:00
def __str__(self):
return self.name
2018-03-20 01:44:47 +01:00
class PackageType(enum.Enum):
MOD = "Mod"
GAME = "Game"
TXP = "Texture Pack"
2018-03-20 04:32:14 +01:00
def toName(self):
2018-03-20 05:11:50 +01:00
return self.name.lower()
def __str__(self):
return self.name
@classmethod
def get(cls, name):
try:
return PackageType[name.upper()]
except KeyError:
return None
2018-03-20 03:58:31 +01:00
@classmethod
def choices(cls):
return [(choice, choice.value) for choice in cls]
@classmethod
def coerce(cls, item):
return item if type(item) == PackageType else PackageType[item.upper()]
2018-03-20 03:58:31 +01:00
2018-03-23 20:08:55 +01:00
2021-12-20 22:07:12 +01:00
class PackageDevState(enum.Enum):
WIP = "Work in Progress"
BETA = "Beta"
ACTIVELY_DEVELOPED = "Actively Developed"
MAINTENANCE_ONLY = "Maintenance Only"
AS_IS = "As-Is"
DEPRECATED = "Deprecated"
LOOKING_FOR_MAINTAINER = "Looking for Maintainer"
def toName(self):
return self.name.lower()
def __str__(self):
return self.name
def get_desc(self):
if self == PackageDevState.WIP:
return "Under active development, and may break worlds/things without warning"
elif self == PackageDevState.BETA:
return "Fully playable, but with some breakages/changes expected"
elif self == PackageDevState.MAINTENANCE_ONLY:
return "Finished, with bug fixes being made as needed"
elif self == PackageDevState.AS_IS:
return "Finished, the maintainer doesn't intend to continue working on it or provide support"
elif self == PackageDevState.DEPRECATED:
return "The maintainer doesn't recommend this package. See the description for more info"
else:
return None
@classmethod
def get(cls, name):
try:
return PackageDevState[name.upper()]
except KeyError:
return None
@classmethod
def choices(cls, with_none):
def build_label(choice):
desc = choice.get_desc()
if desc is None:
return choice.value
else:
return f"{choice.value}: {desc}"
ret = [(choice, build_label(choice)) for choice in cls]
if with_none:
2022-01-04 14:08:53 +01:00
ret.insert(0, (None, ""))
2021-12-20 22:07:12 +01:00
return ret
@classmethod
def coerce(cls, item):
2022-01-04 14:08:53 +01:00
if item is None or (isinstance(item, str) and item.upper() == "NONE"):
2021-12-20 22:07:12 +01:00
return None
return item if type(item) == PackageDevState else PackageDevState[item.upper()]
class PackageState(enum.Enum):
WIP = "Draft"
CHANGES_NEEDED = "Changes Needed"
READY_FOR_REVIEW = "Ready for Review"
APPROVED = "Approved"
DELETED = "Deleted"
def toName(self):
return self.name.lower()
def verb(self):
if self == self.READY_FOR_REVIEW:
return "Submit for Review"
elif self == self.APPROVED:
return "Approve"
elif self == self.DELETED:
return "Delete"
else:
return self.value
def __str__(self):
return self.name
@property
def color(self):
if self == self.WIP:
return "warning"
elif self == self.CHANGES_NEEDED:
return "danger"
elif self == self.READY_FOR_REVIEW:
return "success"
elif self == self.APPROVED:
return "info"
else:
return "danger"
@classmethod
def get(cls, name):
try:
return PackageState[name.upper()]
except KeyError:
return None
@classmethod
def choices(cls):
return [(choice, choice.value) for choice in cls]
@classmethod
def coerce(cls, item):
return item if type(item) == PackageState else PackageState[item.upper()]
PACKAGE_STATE_FLOW = {
2020-12-04 03:23:04 +01:00
PackageState.WIP: {PackageState.READY_FOR_REVIEW},
PackageState.CHANGES_NEEDED: {PackageState.READY_FOR_REVIEW},
PackageState.READY_FOR_REVIEW: {PackageState.WIP, PackageState.CHANGES_NEEDED, PackageState.APPROVED},
PackageState.APPROVED: {PackageState.CHANGES_NEEDED},
PackageState.DELETED: {PackageState.READY_FOR_REVIEW},
}
2018-03-23 20:08:55 +01:00
class PackagePropertyKey(enum.Enum):
2018-05-29 21:51:42 +02:00
name = "Name"
title = "Title"
2019-01-29 04:00:01 +01:00
short_desc = "Short Description"
2018-05-29 21:51:42 +02:00
desc = "Description"
type = "Type"
license = "License"
media_license = "Media License"
tags = "Tags"
provides = "Provides"
repo = "Repository"
website = "Website"
issueTracker = "Issue Tracker"
forums = "Forum Topic ID"
2018-03-23 20:08:55 +01:00
def convert(self, value):
if self == PackagePropertyKey.tags:
2018-05-21 23:20:28 +02:00
return ",".join([t.title for t in value])
2018-05-27 17:37:54 +02:00
elif self == PackagePropertyKey.provides:
return ",".join([t.name for t in value])
else:
return str(value)
2020-12-10 17:49:37 +01:00
PackageProvides = db.Table("provides",
2018-05-21 23:20:28 +02:00
db.Column("package_id", db.Integer, db.ForeignKey("package.id"), primary_key=True),
2020-12-04 03:23:04 +01:00
db.Column("metapackage_id", db.Integer, db.ForeignKey("meta_package.id"), primary_key=True)
2018-05-21 23:20:28 +02:00
)
2020-12-10 17:49:37 +01:00
2020-07-12 18:56:06 +02:00
Tags = db.Table("tags",
2020-12-04 03:23:04 +01:00
db.Column("tag_id", db.Integer, db.ForeignKey("tag.id"), primary_key=True),
db.Column("package_id", db.Integer, db.ForeignKey("package.id"), primary_key=True)
2018-05-21 23:20:28 +02:00
)
2020-12-10 17:49:37 +01:00
2020-07-17 21:48:51 +02:00
ContentWarnings = db.Table("content_warnings",
2020-12-04 03:23:04 +01:00
db.Column("content_warning_id", db.Integer, db.ForeignKey("content_warning.id"), primary_key=True),
db.Column("package_id", db.Integer, db.ForeignKey("package.id"), primary_key=True)
2020-07-17 21:48:51 +02:00
)
2020-12-10 17:49:37 +01:00
maintainers = db.Table("maintainers",
2020-12-04 03:23:04 +01:00
db.Column("user_id", db.Integer, db.ForeignKey("user.id"), primary_key=True),
db.Column("package_id", db.Integer, db.ForeignKey("package.id"), primary_key=True)
)
2020-12-10 17:49:37 +01:00
2018-05-27 22:31:11 +02:00
class Dependency(db.Model):
id = db.Column(db.Integer, primary_key=True)
2018-05-27 22:31:11 +02:00
depender_id = db.Column(db.Integer, db.ForeignKey("package.id"), nullable=True)
depender = db.relationship("Package", foreign_keys=[depender_id])
2018-05-27 22:31:11 +02:00
package_id = db.Column(db.Integer, db.ForeignKey("package.id"), nullable=True)
package = db.relationship("Package", foreign_keys=[package_id])
2018-05-27 22:31:11 +02:00
meta_package_id = db.Column(db.Integer, db.ForeignKey("meta_package.id"), nullable=True)
meta_package = db.relationship("MetaPackage", foreign_keys=[meta_package_id])
2018-05-27 22:31:11 +02:00
optional = db.Column(db.Boolean, nullable=False, default=False)
2020-01-18 18:54:46 +01:00
__table_args__ = (db.UniqueConstraint("depender_id", "package_id", "meta_package_id", name="_dependency_uc"), )
2018-05-27 22:31:11 +02:00
def __init__(self, depender=None, package=None, meta=None, optional=False):
2018-05-27 22:31:11 +02:00
if depender is None:
return
self.depender = depender
self.optional = optional
2018-05-27 22:31:11 +02:00
packageProvided = package is not None
metaProvided = meta is not None
if packageProvided and not metaProvided:
self.package = package
elif metaProvided and not packageProvided:
self.meta_package = meta
else:
raise Exception("Either meta or package must be given, but not both!")
2020-01-21 23:59:44 +01:00
def getName(self):
if self.meta_package:
return self.meta_package.name
elif self.package:
return self.package.name
else:
assert False
2018-05-27 22:31:11 +02:00
def __str__(self):
if self.package is not None:
return self.package.author.username + "/" + self.package.name
elif self.meta_package is not None:
return self.meta_package.name
else:
raise Exception("Meta and package are both none!")
@staticmethod
2020-12-04 03:23:04 +01:00
def SpecToList(depender, spec, cache):
2018-05-27 22:31:11 +02:00
retval = []
arr = spec.split(",")
import re
pattern1 = re.compile("^([a-z0-9_]+)$")
pattern2 = re.compile("^([A-Za-z0-9_]+)/([a-z0-9_]+)$")
for x in arr:
x = x.strip()
if x == "":
continue
if pattern1.match(x):
meta = MetaPackage.GetOrCreate(x, cache)
retval.append(Dependency(depender, meta=meta))
else:
m = pattern2.match(x)
username = m.group(1)
name = m.group(2)
user = User.query.filter_by(username=username).first()
if user is None:
raise Exception("Unable to find user " + username)
package = Package.query.filter_by(author=user, name=name).first()
if package is None:
raise Exception("Unable to find package " + name + " by " + username)
retval.append(Dependency(depender, package=package))
return retval
2018-05-21 23:20:28 +02:00
2018-03-19 19:25:13 +01:00
class Package(db.Model):
query_class = PackageQuery
2019-01-29 04:00:01 +01:00
2018-03-20 01:44:47 +01:00
id = db.Column(db.Integer, primary_key=True)
2018-03-18 18:43:30 +01:00
# Basic details
2020-12-10 17:49:37 +01:00
author_id = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
author = db.relationship("User", back_populates="packages", foreign_keys=[author_id])
2020-01-18 18:54:46 +01:00
name = db.Column(db.Unicode(100), nullable=False)
2019-01-29 04:00:01 +01:00
title = db.Column(db.Unicode(100), nullable=False)
short_desc = db.Column(db.Unicode(200), nullable=False)
desc = db.Column(db.UnicodeText, nullable=True)
2020-12-10 17:49:37 +01:00
type = db.Column(db.Enum(PackageType), nullable=False)
created_at = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
2020-07-18 02:22:52 +02:00
approved_at = db.Column(db.DateTime, nullable=True, default=None)
2018-03-18 18:43:30 +01:00
2020-01-18 18:54:46 +01:00
name_valid = db.CheckConstraint("name ~* '^[a-z0-9_]+$'")
2020-12-04 03:23:04 +01:00
search_vector = db.Column(TSVectorType("name", "title", "short_desc", "desc",
2020-01-19 00:20:49 +01:00
weights={ "name": "A", "title": "B", "short_desc": "C", "desc": "D" }))
2019-01-29 04:00:01 +01:00
2018-05-29 21:17:18 +02:00
license_id = db.Column(db.Integer, db.ForeignKey("license.id"), nullable=False, default=1)
license = db.relationship("License", foreign_keys=[license_id])
media_license_id = db.Column(db.Integer, db.ForeignKey("license.id"), nullable=False, default=1)
media_license = db.relationship("License", foreign_keys=[media_license_id])
2018-04-03 15:13:11 +02:00
2021-12-20 22:07:12 +01:00
state = db.Column(db.Enum(PackageState), nullable=False, default=PackageState.WIP)
dev_state = db.Column(db.Enum(PackageDevState), nullable=True, default=None)
@property
def approved(self):
return self.state == PackageState.APPROVED
2018-03-21 20:03:14 +01:00
score = db.Column(db.Float, nullable=False, default=0)
score_downloads = db.Column(db.Float, nullable=False, default=0)
downloads = db.Column(db.Integer, nullable=False, default=0)
2018-06-11 23:49:25 +02:00
review_thread_id = db.Column(db.Integer, db.ForeignKey("thread.id"), nullable=True, default=None)
2020-12-10 17:49:37 +01:00
review_thread = db.relationship("Thread", uselist=False, foreign_keys=[review_thread_id], back_populates="is_review_thread")
2018-06-11 23:49:25 +02:00
2018-03-18 18:43:30 +01:00
# Downloads
2018-03-20 01:44:47 +01:00
repo = db.Column(db.String(200), nullable=True)
website = db.Column(db.String(200), nullable=True)
2018-03-18 18:43:30 +01:00
issueTracker = db.Column(db.String(200), nullable=True)
2018-05-23 20:40:37 +02:00
forums = db.Column(db.Integer, nullable=True)
2018-03-18 18:43:30 +01:00
provides = db.relationship("MetaPackage", secondary=PackageProvides, order_by=db.asc("name"), back_populates="packages")
2018-05-21 23:20:28 +02:00
dependencies = db.relationship("Dependency", back_populates="depender", lazy="dynamic", foreign_keys=[Dependency.depender_id])
2018-03-26 12:28:34 +02:00
tags = db.relationship("Tag", secondary=Tags, back_populates="packages")
2018-03-26 12:28:34 +02:00
content_warnings = db.relationship("ContentWarning", secondary=ContentWarnings, back_populates="packages")
2020-07-17 21:48:51 +02:00
releases = db.relationship("PackageRelease", back_populates="package",
lazy="dynamic", order_by=db.desc("package_release_releaseDate"), cascade="all, delete, delete-orphan")
2018-03-20 19:20:30 +01:00
screenshots = db.relationship("PackageScreenshot", back_populates="package", foreign_keys="PackageScreenshot.package_id",
lazy="dynamic", order_by=db.asc("package_screenshot_order"), cascade="all, delete, delete-orphan")
2018-03-23 20:08:55 +01:00
2021-01-30 20:32:04 +01:00
main_screenshot = db.relationship("PackageScreenshot", uselist=False, foreign_keys="PackageScreenshot.package_id",
lazy=True, order_by=db.asc("package_screenshot_order"),
primaryjoin="and_(Package.id==PackageScreenshot.package_id, PackageScreenshot.approved)")
cover_image_id = db.Column(db.Integer, db.ForeignKey("package_screenshot.id"), nullable=True, default=None)
cover_image = db.relationship("PackageScreenshot", uselist=False, foreign_keys=[cover_image_id])
maintainers = db.relationship("User", secondary=maintainers)
threads = db.relationship("Thread", back_populates="package", order_by=db.desc("thread_created_at"),
foreign_keys="Thread.package_id", cascade="all, delete, delete-orphan", lazy="dynamic")
2021-08-18 23:09:41 +02:00
reviews = db.relationship("PackageReview", back_populates="package",
order_by=[db.desc("package_review_score"),db.desc("package_review_created_at")],
cascade="all, delete, delete-orphan")
2021-02-08 01:46:39 +01:00
audit_log_entries = db.relationship("AuditLogEntry", foreign_keys="AuditLogEntry.package_id",
lazy="dynamic", back_populates="package", order_by=db.desc("audit_log_entry_created_at"))
2020-12-10 17:49:37 +01:00
notifications = db.relationship("Notification", foreign_keys="Notification.package_id",
back_populates="package", cascade="all, delete, delete-orphan")
tokens = db.relationship("APIToken", foreign_keys="APIToken.package_id", back_populates="package",
cascade="all, delete, delete-orphan")
update_config = db.relationship("PackageUpdateConfig", uselist=False, back_populates="package",
cascade="all, delete, delete-orphan")
aliases = db.relationship("PackageAlias", foreign_keys="PackageAlias.package_id",
back_populates="package", cascade="all, delete, delete-orphan")
def __init__(self, package=None):
if package is None:
return
self.author_id = package.author_id
self.created_at = package.created_at
self.state = package.state
self.maintainers.append(self.author)
for e in PackagePropertyKey:
setattr(self, e.name, getattr(package, e.name))
def getId(self):
return "{}/{}".format(self.author.username, self.name)
2019-11-21 23:16:35 +01:00
def getIsFOSS(self):
return self.license.is_foss and self.media_license.is_foss
2020-01-21 23:59:44 +01:00
def getSortedDependencies(self, is_hard=None):
query = self.dependencies
if is_hard is not None:
query = query.filter_by(optional=not is_hard)
deps = query.all()
deps.sort(key = lambda x: x.getName())
return deps
def getSortedHardDependencies(self):
return self.getSortedDependencies(True)
def getSortedOptionalDependencies(self):
return self.getSortedDependencies(False)
2019-09-03 01:42:51 +02:00
def getAsDictionaryKey(self):
return {
"name": self.name,
"author": self.author.display_name,
"type": self.type.toName(),
}
2021-01-30 20:49:15 +01:00
def getAsDictionaryShort(self, base_url, version=None, release_id=None, no_load=False):
2018-12-21 22:22:15 +01:00
tnurl = self.getThumbnailURL(1)
2021-01-30 20:32:04 +01:00
2021-01-30 20:49:15 +01:00
if release_id is None and no_load == False:
2021-01-30 20:32:04 +01:00
release = self.getDownloadRelease(version=version)
release_id = release and release.id
short_desc = self.short_desc
if self.dev_state == PackageDevState.WIP:
short_desc = "Work in Progress. " + self.short_desc
ret = {
2018-03-23 18:33:34 +01:00
"name": self.name,
"title": self.title,
"author": self.author.username,
"short_description": short_desc,
2018-03-23 18:33:34 +01:00
"type": self.type.toName(),
2021-01-30 20:32:04 +01:00
"release": release_id,
"thumbnail": (base_url + tnurl) if tnurl is not None else None,
"aliases": [ alias.getAsDictionary() for alias in self.aliases ],
}
if not ret["aliases"]:
del ret["aliases"]
return ret
def getAsDictionary(self, base_url, version=None):
2018-12-21 22:22:15 +01:00
tnurl = self.getThumbnailURL(1)
release = self.getDownloadRelease(version=version)
return {
"author": self.author.username,
2021-02-02 23:47:46 +01:00
"maintainers": [x.username for x in self.maintainers],
"state": self.state.name,
2021-12-23 12:58:39 +01:00
"dev_state": self.dev_state.name if self.dev_state else None,
2021-02-02 23:47:46 +01:00
"name": self.name,
"title": self.title,
2019-01-29 04:00:01 +01:00
"short_description": self.short_desc,
"long_description": self.desc,
"type": self.type.toName(),
2020-01-24 21:21:40 +01:00
"created_at": self.created_at.isoformat(),
2018-04-03 15:13:11 +02:00
"license": self.license.name,
2018-11-25 14:21:24 +01:00
"media_license": self.media_license.name,
2018-03-23 18:33:34 +01:00
"repo": self.repo,
"website": self.website,
2018-11-25 14:21:24 +01:00
"issue_tracker": self.issueTracker,
"forums": self.forums,
2021-02-02 23:47:46 +01:00
"tags": [x.name for x in self.tags],
"content_warnings": [x.name for x in self.content_warnings],
"provides": [x.name for x in self.provides],
"thumbnail": (base_url + tnurl) if tnurl is not None else None,
2018-05-29 17:19:17 +02:00
"screenshots": [base_url + ss.url for ss in self.screenshots],
2021-07-24 05:30:14 +02:00
"url": base_url + self.getURL("packages.download"),
"release": release and release.id,
2020-08-02 18:10:47 +02:00
"score": round(self.score * 10) / 10,
"downloads": self.downloads
2018-03-23 18:33:34 +01:00
}
2021-01-29 21:21:17 +01:00
def getThumbnailOrPlaceholder(self, level=2):
return self.getThumbnailURL(level) or "/static/placeholder.png"
2018-12-21 22:22:15 +01:00
def getThumbnailURL(self, level=2):
2021-01-30 20:32:04 +01:00
screenshot = self.main_screenshot
2018-12-21 22:22:15 +01:00
return screenshot.getThumbnailURL(level) if screenshot is not None else None
2018-05-29 17:19:17 +02:00
2020-04-24 00:49:46 +02:00
def getMainScreenshotURL(self, absolute=False):
2021-01-30 20:32:04 +01:00
screenshot = self.main_screenshot
2020-04-24 00:49:46 +02:00
if screenshot is None:
return None
2018-05-29 17:19:17 +02:00
2020-04-24 00:49:46 +02:00
if absolute:
from app.utils import abs_url
return abs_url(screenshot.url)
else:
return screenshot.url
2021-07-24 05:30:14 +02:00
def getURL(self, endpoint, absolute=False, **kwargs):
2020-04-24 00:49:46 +02:00
if absolute:
from app.utils import abs_url_for
2021-07-24 05:30:14 +02:00
return abs_url_for(endpoint, author=self.author.username, name=self.name, **kwargs)
2020-04-24 00:49:46 +02:00
else:
2021-07-24 05:30:14 +02:00
return url_for(endpoint, author=self.author.username, name=self.name, **kwargs)
2018-03-20 03:58:31 +01:00
2020-08-02 18:41:06 +02:00
def getShieldURL(self, type):
from app.utils import abs_url_for
return abs_url_for("packages.shield",
author=self.author.username, name=self.name, type=type)
def makeShield(self, type):
return "[![ContentDB]({})]({})" \
2021-07-24 05:30:14 +02:00
.format(self.getShieldURL(type), self.getURL("packages.view", True))
2021-05-04 04:15:26 +02:00
def getSetStateURL(self, state):
if type(state) == str:
state = PackageState[state]
elif type(state) != PackageState:
raise Exception("Unknown state given to Package.canMoveToState()")
return url_for("packages.move_to_state",
author=self.author.username, name=self.name, state=state.name.lower())
2018-03-21 20:03:14 +01:00
def getDownloadRelease(self, version=None):
2018-03-23 17:20:56 +01:00
for rel in self.releases:
if rel.approved and (version is None or
2020-12-04 03:23:04 +01:00
((rel.min_rel is None or rel.min_rel_id <= version.id) and
(rel.max_rel is None or rel.max_rel_id >= version.id))):
2018-03-23 17:20:56 +01:00
return rel
return None
2018-03-20 03:58:31 +01:00
def checkPerm(self, user, perm):
2018-03-20 04:45:01 +01:00
if not user.is_authenticated:
return False
2018-03-20 04:16:46 +01:00
if type(perm) == str:
perm = Permission[perm]
elif type(perm) != Permission:
raise Exception("Unknown permission given to Package.checkPerm()")
2018-03-20 04:16:46 +01:00
isOwner = user == self.author
isMaintainer = isOwner or user.rank.atLeast(UserRank.EDITOR) or user in self.maintainers
2021-08-16 19:57:05 +02:00
isApprover = user.rank.atLeast(UserRank.APPROVER)
2018-03-20 04:45:01 +01:00
if perm == Permission.CREATE_THREAD:
return user.rank.atLeast(UserRank.MEMBER)
2018-03-20 04:45:01 +01:00
# Members can edit their own packages, and editors can edit any packages
elif perm == Permission.MAKE_RELEASE or perm == Permission.ADD_SCREENSHOTS:
return isMaintainer
2018-03-20 19:20:30 +01:00
2021-08-16 19:57:05 +02:00
elif perm == Permission.EDIT_PACKAGE:
return isMaintainer and user.rank.atLeast(UserRank.MEMBER if self.approved else UserRank.NEW_MEMBER)
2018-03-20 04:45:01 +01:00
2021-08-16 19:57:05 +02:00
elif perm == Permission.APPROVE_RELEASE:
return (isMaintainer or isApprover) and user.rank.atLeast(UserRank.MEMBER if self.approved else UserRank.NEW_MEMBER)
# Anyone can change the package name when not approved, but only editors when approved
elif perm == Permission.CHANGE_NAME:
return not self.approved or user.rank.atLeast(UserRank.EDITOR)
# Editors can change authors and approve new packages
elif perm == Permission.APPROVE_NEW or perm == Permission.CHANGE_AUTHOR:
2021-08-16 19:57:05 +02:00
return isApprover
2018-03-20 04:45:01 +01:00
elif perm == Permission.APPROVE_SCREENSHOT:
2021-08-16 19:57:05 +02:00
return (isMaintainer or isApprover) and \
user.rank.atLeast(UserRank.TRUSTED_MEMBER if self.approved else UserRank.NEW_MEMBER)
2021-08-16 19:57:05 +02:00
elif perm == Permission.EDIT_MAINTAINERS or perm == Permission.DELETE_PACKAGE:
return isOwner or user.rank.atLeast(UserRank.EDITOR)
2021-08-16 19:57:05 +02:00
elif perm == Permission.UNAPPROVE_PACKAGE:
return isOwner or user.rank.atLeast(UserRank.APPROVER)
elif perm == Permission.CHANGE_RELEASE_URL:
2018-03-20 04:45:01 +01:00
return user.rank.atLeast(UserRank.MODERATOR)
2018-03-20 04:16:46 +01:00
else:
raise Exception("Permission {} is not related to packages".format(perm.name))
2018-03-20 03:58:31 +01:00
def getMissingHardDependenciesQuery(self):
return MetaPackage.query \
.filter(~ MetaPackage.packages.any(state=PackageState.APPROVED)) \
.filter(MetaPackage.dependencies.any(optional=False, depender=self)) \
.order_by(db.asc(MetaPackage.name))
def getMissingHardDependencies(self):
return [mp.name for mp in self.getMissingHardDependenciesQuery().all()]
def canMoveToState(self, user, state):
if not user.is_authenticated:
return False
if type(state) == str:
state = PackageState[state]
elif type(state) != PackageState:
raise Exception("Unknown state given to Package.canMoveToState()")
if state not in PACKAGE_STATE_FLOW[self.state]:
return False
if state == PackageState.READY_FOR_REVIEW or state == PackageState.APPROVED:
2021-08-16 19:57:05 +02:00
if state == PackageState.APPROVED and not self.checkPerm(user, Permission.APPROVE_NEW):
return False
2021-08-16 19:57:05 +02:00
if not (self.checkPerm(user, Permission.APPROVE_NEW) or self.checkPerm(user, Permission.EDIT_PACKAGE)):
return False
if state == PackageState.APPROVED and ("Other" in self.license.name or "Other" in self.media_license.name):
return False
if self.getMissingHardDependenciesQuery().count() > 0:
return False
needsScreenshot = \
(self.type == self.type.GAME or self.type == self.type.TXP) and \
self.screenshots.count() == 0
return self.releases.count() > 0 and not needsScreenshot
elif state == PackageState.CHANGES_NEEDED:
return self.checkPerm(user, Permission.APPROVE_NEW)
elif state == PackageState.WIP:
2020-09-16 23:10:22 +02:00
return self.checkPerm(user, Permission.EDIT_PACKAGE) and \
(user in self.maintainers or user.rank.atLeast(UserRank.ADMIN))
return True
def getNextStates(self, user):
states = []
for state in PackageState:
if self.canMoveToState(user, state):
states.append(state)
return states
2020-07-09 05:32:13 +02:00
def getScoreDict(self):
return {
"author": self.author.username,
"name": self.name,
"score": self.score,
"score_downloads": self.score_downloads,
"score_reviews": self.score - self.score_downloads,
"downloads": self.downloads
}
def recalcScore(self):
2020-07-09 05:32:13 +02:00
review_scores = [ 100 * r.asSign() for r in self.reviews ]
self.score = self.score_downloads + sum(review_scores)
2019-11-21 23:16:35 +01:00
2018-05-27 17:37:54 +02:00
class MetaPackage(db.Model):
id = db.Column(db.Integer, primary_key=True)
name = db.Column(db.String(100), unique=True, nullable=False)
dependencies = db.relationship("Dependency", back_populates="meta_package", lazy="dynamic")
packages = db.relationship("Package", lazy="dynamic", back_populates="provides", secondary=PackageProvides)
2018-05-27 17:37:54 +02:00
mp_name_valid = db.CheckConstraint("name ~* '^[a-z0-9_]+$'")
2018-05-27 17:37:54 +02:00
def __init__(self, name=None):
self.name = name
def __str__(self):
return self.name
2018-05-27 18:58:09 +02:00
@staticmethod
def ListToSpec(list):
return ",".join([str(x) for x in list])
2018-05-27 21:15:35 +02:00
@staticmethod
2020-12-04 03:23:04 +01:00
def GetOrCreate(name, cache):
2018-05-27 21:15:35 +02:00
mp = cache.get(name)
if mp is None:
mp = MetaPackage.query.filter_by(name=name).first()
if mp is None:
mp = MetaPackage(name)
db.session.add(mp)
cache[name] = mp
return mp
2018-05-27 18:58:09 +02:00
@staticmethod
2020-12-04 03:23:04 +01:00
def SpecToList(spec, cache):
2018-05-27 18:58:09 +02:00
retval = []
arr = spec.split(",")
import re
pattern = re.compile("^([a-z0-9_]+)$")
for x in arr:
x = x.strip()
if x == "":
continue
if not pattern.match(x):
continue
2018-05-27 21:15:35 +02:00
retval.append(MetaPackage.GetOrCreate(x, cache))
2018-05-27 18:58:09 +02:00
return retval
2020-07-17 21:48:51 +02:00
class ContentWarning(db.Model):
id = db.Column(db.Integer, primary_key=True)
name = db.Column(db.String(100), unique=True, nullable=False)
title = db.Column(db.String(100), nullable=False)
description = db.Column(db.String(500), nullable=False)
packages = db.relationship("Package", back_populates="content_warnings", secondary=ContentWarnings)
2020-07-17 21:48:51 +02:00
def __init__(self, title, description=""):
self.title = title
self.description = description
import re
regex = re.compile("[^a-z_]")
self.name = regex.sub("", self.title.lower().replace(" ", "_"))
2021-02-03 00:58:59 +01:00
def getAsDictionary(self):
description = self.description if self.description != "" else None
return { "name": self.name, "title": self.title, "description": description }
2020-07-17 21:48:51 +02:00
2018-03-26 12:28:34 +02:00
class Tag(db.Model):
2020-07-15 20:06:00 +02:00
id = db.Column(db.Integer, primary_key=True)
name = db.Column(db.String(100), unique=True, nullable=False)
2018-03-26 12:28:34 +02:00
title = db.Column(db.String(100), nullable=False)
description = db.Column(db.String(500), nullable=True, default=None)
2020-07-15 20:06:00 +02:00
backgroundColor = db.Column(db.String(6), nullable=False)
textColor = db.Column(db.String(6), nullable=False)
views = db.Column(db.Integer, nullable=False, default=0)
is_protected = db.Column(db.Boolean, nullable=False, default=False)
2018-03-26 12:28:34 +02:00
packages = db.relationship("Package", back_populates="tags", secondary=Tags)
2018-03-26 12:28:34 +02:00
def __init__(self, title, backgroundColor="000000", textColor="ffffff"):
self.title = title
self.backgroundColor = backgroundColor
self.textColor = textColor
import re
2018-05-21 23:20:28 +02:00
regex = re.compile("[^a-z_]")
self.name = regex.sub("", self.title.lower().replace(" ", "_"))
2018-03-26 12:28:34 +02:00
2021-01-16 01:34:09 +01:00
def getAsDictionary(self):
description = self.description if self.description != "" else None
return { "name": self.name, "title": self.title, "description": description }
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)
2020-01-19 20:09:04 +01:00
def __init__(self, name=None, protocol=0):
self.name = name
2020-01-19 20:09:04 +01:00
self.protocol = protocol
def getActual(self):
return None if self.name == "None" else self
2021-02-02 18:09:28 +01:00
def getAsDictionary(self):
return {
"name": self.name,
"protocol_version": self.protocol,
"is_dev": "-dev" in self.name,
}
@classmethod
def get(cls, version, protocol_num):
if version:
parts = version.strip().split(".")
if len(parts) >= 2:
major_minor = parts[0] + "." + parts[1]
2020-06-04 21:40:56 +02:00
query = MinetestRelease.query.filter(MinetestRelease.name.like("{}%".format(major_minor)))
if protocol_num:
query = query.filter_by(protocol=protocol_num)
release = query.one_or_none()
if release:
return release
if protocol_num:
2021-05-03 18:59:23 +02:00
# Find the closest matching release
return MinetestRelease.query.order_by(db.desc(MinetestRelease.protocol),
db.desc(MinetestRelease.id)) \
2021-05-03 18:59:23 +02:00
.filter(MinetestRelease.protocol <= protocol_num).first()
return None
2018-03-20 19:20:30 +01:00
class PackageRelease(db.Model):
id = db.Column(db.Integer, primary_key=True)
2018-03-21 23:03:37 +01:00
package_id = db.Column(db.Integer, db.ForeignKey("package.id"))
package = db.relationship("Package", back_populates="releases", foreign_keys=[package_id])
2018-03-20 19:20:30 +01:00
title = db.Column(db.String(100), nullable=False)
releaseDate = db.Column(db.DateTime, nullable=False)
url = db.Column(db.String(200), nullable=False, default="")
2018-03-20 19:20:30 +01:00
approved = db.Column(db.Boolean, nullable=False, default=False)
2018-05-23 19:19:29 +02:00
task_id = db.Column(db.String(37), nullable=True)
2018-07-28 15:48:03 +02:00
commit_hash = db.Column(db.String(41), nullable=True, default=None)
2019-01-29 01:43:55 +01:00
downloads = db.Column(db.Integer, nullable=False, default=0)
2018-03-20 19:20:30 +01:00
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])
# If the release is approved, then the task_id must be null and the url must be present
CK_approval_valid = db.CheckConstraint("not approved OR (task_id IS NULL AND (url = '') IS NOT FALSE)")
2020-01-24 21:21:40 +01:00
def getAsDictionary(self):
return {
"id": self.id,
"title": self.title,
"url": self.url if self.url != "" else None,
"release_date": self.releaseDate.isoformat(),
"commit": self.commit_hash,
"downloads": self.downloads,
2021-02-02 18:09:28 +01:00
"min_minetest_version": self.min_rel and self.min_rel.getAsDictionary(),
"max_minetest_version": self.max_rel and self.max_rel.getAsDictionary(),
2020-01-24 21:21:40 +01:00
}
2021-03-05 13:55:21 +01:00
def getLongAsDictionary(self):
return {
"id": self.id,
"title": self.title,
"url": self.url if self.url != "" else None,
"release_date": self.releaseDate.isoformat(),
"commit": self.commit_hash,
"downloads": self.downloads,
"min_minetest_version": self.min_rel and self.min_rel.getAsDictionary(),
"max_minetest_version": self.max_rel and self.max_rel.getAsDictionary(),
"package": self.package.getAsDictionaryKey()
}
def getEditURL(self):
return url_for("packages.edit_release",
author=self.package.author.username,
name=self.package.name,
id=self.id)
2020-01-19 01:02:33 +01:00
def getDeleteURL(self):
return url_for("packages.delete_release",
author=self.package.author.username,
name=self.package.name,
id=self.id)
2018-07-28 19:33:36 +02:00
def getDownloadURL(self):
return url_for("packages.download_release",
2018-07-28 19:33:36 +02:00
author=self.package.author.username,
name=self.package.name,
id=self.id)
2018-03-20 19:20:30 +01:00
def __init__(self):
self.releaseDate = datetime.datetime.now()
2018-03-20 19:20:30 +01:00
2021-05-04 23:06:31 +02:00
def getDownloadFileName(self):
return f"{self.package.name}_{self.id}.zip"
2019-03-29 21:47:48 +01:00
def approve(self, user):
if not self.checkPerm(user, Permission.APPROVE_RELEASE):
2019-03-29 21:47:48 +01:00
return False
if self.approved:
return True
assert self.task_id is None and self.url is not None and self.url != ""
2019-03-29 21:47:48 +01:00
self.approved = True
if self.package.update_config:
self.package.update_config.outdated_at = None
self.package.update_config.last_commit = self.commit_hash
2019-03-29 21:47:48 +01:00
return True
2020-01-19 01:02:33 +01:00
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 PackageRelease.checkPerm()")
isMaintainer = user == self.package.author or user in self.package.maintainers
2020-01-19 01:02:33 +01:00
if perm == Permission.DELETE_RELEASE:
if user.rank.atLeast(UserRank.ADMIN):
return True
if not (isMaintainer or user.rank.atLeast(UserRank.EDITOR)):
2020-01-19 01:02:33 +01:00
return False
if not self.package.approved or self.task_id is not None:
2020-01-19 01:02:33 +01:00
return True
count = self.package.releases \
2020-01-19 01:02:33 +01:00
.filter(PackageRelease.id > self.id) \
.count()
return count > 0
elif perm == Permission.APPROVE_RELEASE:
2021-08-16 19:57:05 +02:00
return user.rank.atLeast(UserRank.APPROVER) or \
(isMaintainer and user.rank.atLeast(
UserRank.MEMBER if self.approved else UserRank.NEW_MEMBER))
2020-01-19 01:02:33 +01:00
else:
raise Exception("Permission {} is not related to releases".format(perm.name))
2018-03-26 11:52:25 +02:00
class PackageScreenshot(db.Model):
id = db.Column(db.Integer, primary_key=True)
2020-12-10 17:49:37 +01:00
package_id = db.Column(db.Integer, db.ForeignKey("package.id"), nullable=False)
package = db.relationship("Package", back_populates="screenshots", foreign_keys=[package_id])
2020-12-06 04:35:25 +01:00
order = db.Column(db.Integer, nullable=False, default=0)
2018-03-26 11:52:25 +02:00
title = db.Column(db.String(100), nullable=False)
url = db.Column(db.String(100), nullable=False)
2018-05-25 19:57:30 +02:00
approved = db.Column(db.Boolean, nullable=False, default=False)
2021-02-02 18:29:03 +01:00
created_at = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
2018-05-25 19:57:30 +02:00
def getEditURL(self):
return url_for("packages.edit_screenshot",
2018-05-25 19:57:30 +02:00
author=self.package.author.username,
name=self.package.name,
id=self.id)
2018-03-26 11:52:25 +02:00
2020-12-06 05:30:47 +01:00
def getDeleteURL(self):
return url_for("packages.delete_screenshot",
author=self.package.author.username,
name=self.package.name,
id=self.id)
2018-12-21 22:22:15 +01:00
def getThumbnailURL(self, level=2):
2020-12-04 03:23:04 +01:00
return self.url.replace("/uploads/", "/thumbnails/{:d}/".format(level))
2021-02-02 18:09:25 +01:00
def getAsDictionary(self, base_url=""):
2021-02-02 18:09:21 +01:00
return {
"id": self.id,
2021-02-02 18:09:25 +01:00
"order": self.order,
2021-02-02 18:09:21 +01:00
"title": self.title,
2021-02-02 18:09:25 +01:00
"url": base_url + self.url,
2021-02-02 18:09:21 +01:00
"approved": self.approved,
2021-02-02 18:29:03 +01:00
"created_at": self.created_at.isoformat(),
2021-02-02 18:09:21 +01:00
}
class PackageUpdateTrigger(enum.Enum):
COMMIT = "New Commit"
TAG = "New Tag"
def toName(self):
return self.name.lower()
def __str__(self):
return self.name
@classmethod
def get(cls, name):
try:
return PackageUpdateTrigger[name.upper()]
except KeyError:
return None
@classmethod
def choices(cls):
return [(choice, choice.value) for choice in cls]
@classmethod
def coerce(cls, item):
return item if type(item) == PackageUpdateTrigger else PackageUpdateTrigger[item.upper()]
class PackageUpdateConfig(db.Model):
package_id = db.Column(db.Integer, db.ForeignKey("package.id"), primary_key=True)
package = db.relationship("Package", back_populates="update_config", foreign_keys=[package_id])
last_commit = db.Column(db.String(41), nullable=True, default=None)
last_tag = db.Column(db.String(41), nullable=True, default=None)
# Set to now when an outdated notification is sent. Set to None when a release is created
outdated_at = db.Column(db.DateTime, nullable=True, default=None)
trigger = db.Column(db.Enum(PackageUpdateTrigger), nullable=False, default=PackageUpdateTrigger.COMMIT)
2020-12-15 23:00:46 +01:00
ref = db.Column(db.String(41), nullable=True, default=None)
make_release = db.Column(db.Boolean, nullable=False, default=False)
2021-01-30 00:18:37 +01:00
# Was this made using Add Update Configs in Admin?
auto_created = db.Column(db.Boolean, nullable=False, default=False)
def set_outdated(self):
self.outdated_at = datetime.datetime.utcnow()
2021-01-30 17:48:11 +01:00
def get_message(self):
if self.trigger == PackageUpdateTrigger.COMMIT:
msg = "New commit {} found on the Git repo.".format(self.last_commit[0:5])
last_release = self.package.releases.first()
if last_release and last_release.commit_hash:
msg += " The last release was commit {}".format(last_release.commit_hash[0:5])
2021-01-30 17:48:11 +01:00
return msg
2021-01-30 17:48:11 +01:00
else:
return "New tag {} found on the Git repo.".format(self.last_tag)
2021-01-30 17:48:11 +01:00
def get_title(self):
return self.last_tag or self.outdated_at.strftime("%Y-%m-%d")
def get_ref(self):
return self.last_tag or self.last_commit
2021-01-30 17:48:11 +01:00
def get_create_release_url(self):
2021-07-24 05:30:14 +02:00
return self.package.getURL("packages.create_release", title=self.get_title(), ref=self.get_ref())
class PackageAlias(db.Model):
id = db.Column(db.Integer, primary_key=True)
package_id = db.Column(db.Integer, db.ForeignKey("package.id"), nullable=False)
package = db.relationship("Package", back_populates="aliases", foreign_keys=[package_id])
author = db.Column(db.String(50), nullable=False)
name = db.Column(db.String(100), nullable=False)
def __init__(self, author="", name=""):
self.author = author
self.name = name
def getEditURL(self):
return url_for("packages.alias_create_edit", author=self.package.author.username,
name=self.package.name, alias_id=self.id)
def getAsDictionary(self):
return f"{self.author}/{self.name}"