contentdb/app/blueprints/api/endpoints.py

547 lines
16 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
2019-11-22 15:33:22 +01: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
2019-11-22 15:33:22 +01: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.
2019-11-22 15:33:22 +01:00
#
2021-01-30 17:59:42 +01:00
# You should have received a copy of the GNU Affero General Public License
2019-11-22 15:33:22 +01:00
# along with this program. If not, see <https://www.gnu.org/licenses/>.
2022-01-30 04:35:02 +01:00
2021-11-26 15:56:01 +01:00
import math
2021-11-25 11:35:31 +01:00
from typing import List
2019-11-22 15:33:22 +01:00
2021-11-26 15:33:17 +01:00
import flask_sqlalchemy
2021-04-10 17:30:19 +02:00
from flask import request, jsonify, current_app
from flask_login import current_user, login_required
2022-01-30 04:35:02 +01:00
from sqlalchemy.orm import joinedload
2021-02-02 18:09:23 +01:00
from sqlalchemy.sql.expression import func
from app import csrf
from app.markdown import render_markdown
2021-11-24 17:33:37 +01:00
from app.models import Tag, PackageState, PackageType, Package, db, PackageRelease, Permission, ForumTopic, \
2021-11-26 15:33:17 +01:00
MinetestRelease, APIToken, PackageScreenshot, License, ContentWarning, User, PackageReview, Thread
2019-11-22 15:33:22 +01:00
from app.querybuilder import QueryBuilder
2021-11-26 15:33:17 +01:00
from app.utils import is_package_page, get_int_or_abort, url_set_query, abs_url, isYes
2021-02-02 18:09:23 +01:00
from . import bp
from .auth import is_api_authd
2021-02-02 22:35:29 +01:00
from .support import error, api_create_vcs_release, api_create_zip_release, api_create_screenshot, api_order_screenshots, api_edit_package
2021-11-24 16:39:50 +01:00
from functools import wraps
def cors_allowed(f):
@wraps(f)
def inner(*args, **kwargs):
res = f(*args, **kwargs)
res.headers["Access-Control-Allow-Origin"] = "*"
res.headers["Access-Control-Allow-Methods"] = "GET, POST, PUT, DELETE, OPTIONS"
2021-11-24 16:49:00 +01:00
res.headers["Access-Control-Allow-Headers"] = "Content-Type, Authorization"
2021-11-24 16:39:50 +01:00
return res
return inner
2021-02-02 18:09:23 +01:00
2019-11-22 15:33:22 +01:00
@bp.route("/api/packages/")
2021-11-24 16:39:50 +01:00
@cors_allowed
2019-11-22 15:33:22 +01:00
def packages():
qb = QueryBuilder(request.args)
query = qb.buildPackageQuery()
2021-01-16 01:34:09 +01:00
if request.args.get("fmt") == "keys":
return jsonify([package.getAsDictionaryKey() for package in query.all()])
2021-01-30 20:32:04 +01:00
pkgs = qb.convertToDictionary(query.all())
2021-01-16 01:34:09 +01:00
if "engine_version" in request.args or "protocol_version" in request.args:
pkgs = [package for package in pkgs if package.get("release")]
return jsonify(pkgs)
2019-11-22 15:33:22 +01:00
@bp.route("/api/packages/<author>/<name>/")
@is_package_page
2021-11-24 16:39:50 +01:00
@cors_allowed
2019-11-22 15:33:22 +01:00
def package(package):
return jsonify(package.getAsDictionary(current_app.config["BASE_URL"]))
2021-02-02 22:35:29 +01:00
@bp.route("/api/packages/<author>/<name>/", methods=["PUT"])
@csrf.exempt
@is_package_page
@is_api_authd
2021-11-24 16:39:50 +01:00
@cors_allowed
2021-02-02 22:35:29 +01:00
def edit_package(token, package):
if not token:
error(401, "Authentication needed")
return api_edit_package(token, package, request.json)
def resolve_package_deps(out, package, only_hard, depth=1):
id = package.getId()
if id in out:
return
2019-11-22 15:33:22 +01:00
ret = []
out[id] = ret
if package.type != PackageType.MOD:
return
2019-11-22 15:33:22 +01:00
for dep in package.dependencies:
2020-06-05 05:46:46 +02:00
if only_hard and dep.optional:
continue
2019-11-22 15:33:22 +01:00
if dep.package:
name = dep.package.name
fulfilled_by = [ dep.package.getId() ]
resolve_package_deps(out, dep.package, only_hard, depth)
2019-11-22 15:33:22 +01:00
elif dep.meta_package:
name = dep.meta_package.name
fulfilled_by = [ pkg.getId() for pkg in dep.meta_package.packages]
if depth == 1 and not dep.optional:
most_likely = next((pkg for pkg in dep.meta_package.packages if pkg.type == PackageType.MOD), None)
if most_likely:
resolve_package_deps(out, most_likely, only_hard, depth + 1)
2019-11-22 15:33:22 +01:00
else:
2020-12-04 03:23:04 +01:00
raise Exception("Malformed dependency")
2019-11-22 15:33:22 +01:00
ret.append({
"name": name,
"is_optional": dep.optional,
"packages": fulfilled_by
})
@bp.route("/api/packages/<author>/<name>/dependencies/")
@is_package_page
2021-11-24 16:39:50 +01:00
@cors_allowed
def package_dependencies(package):
only_hard = request.args.get("only_hard")
out = {}
resolve_package_deps(out, package, only_hard)
return jsonify(out)
2019-11-22 15:33:22 +01:00
@bp.route("/api/topics/")
2021-11-24 16:39:50 +01:00
@cors_allowed
2019-11-22 15:33:22 +01:00
def topics():
qb = QueryBuilder(request.args)
query = qb.buildTopicQuery(show_added=True)
return jsonify([t.getAsDictionary() for t in query.all()])
@bp.route("/api/topic_discard/", methods=["POST"])
@login_required
def topic_set_discard():
tid = request.args.get("tid")
discard = request.args.get("discard")
if tid is None or discard is None:
2021-04-10 17:30:19 +02:00
error(400, "Missing topic ID or discard bool")
2019-11-22 15:33:22 +01:00
topic = ForumTopic.query.get(tid)
if not topic.checkPerm(current_user, Permission.TOPIC_DISCARD):
2021-04-10 17:30:19 +02:00
error(403, "Permission denied, need: TOPIC_DISCARD")
2019-11-22 15:33:22 +01:00
topic.discarded = discard == "true"
db.session.commit()
return jsonify(topic.getAsDictionary())
@bp.route("/api/whoami/")
@is_api_authd
2021-11-24 16:39:50 +01:00
@cors_allowed
2019-11-22 15:33:22 +01:00
def whoami(token):
if token is None:
return jsonify({ "is_authenticated": False, "username": None })
else:
return jsonify({ "is_authenticated": True, "username": token.owner.username })
@bp.route("/api/markdown/", methods=["POST"])
@csrf.exempt
2020-01-24 21:21:40 +01:00
def markdown():
return render_markdown(request.data.decode("utf-8"))
2020-01-24 21:21:40 +01:00
2021-03-05 13:55:21 +01:00
@bp.route("/api/releases/")
2021-11-24 16:39:50 +01:00
@cors_allowed
2021-03-05 13:55:21 +01:00
def list_all_releases():
query = PackageRelease.query.filter_by(approved=True) \
.filter(PackageRelease.package.has(state=PackageState.APPROVED)) \
.order_by(db.desc(PackageRelease.releaseDate))
if "author" in request.args:
author = User.query.filter_by(username=request.args["author"]).first()
if author is None:
2021-04-10 17:30:19 +02:00
error(404, "Author not found")
2021-03-05 13:55:21 +01:00
query = query.filter(PackageRelease.package.has(author=author))
if "maintainer" in request.args:
maintainer = User.query.filter_by(username=request.args["maintainer"]).first()
if maintainer is None:
2021-04-10 17:30:19 +02:00
error(404, "Maintainer not found")
2021-03-05 13:55:21 +01:00
query = query.join(Package)
query = query.filter(Package.maintainers.any(id=maintainer.id))
return jsonify([ rel.getLongAsDictionary() for rel in query.limit(30).all() ])
2021-02-02 18:09:25 +01:00
@bp.route("/api/packages/<author>/<name>/releases/")
@is_package_page
2021-11-24 16:39:50 +01:00
@cors_allowed
2021-02-02 18:09:25 +01:00
def list_releases(package):
2021-02-02 18:09:28 +01:00
return jsonify([ rel.getAsDictionary() for rel in package.releases.all() ])
2021-02-02 18:09:25 +01:00
2020-01-24 21:21:40 +01:00
@bp.route("/api/packages/<author>/<name>/releases/new/", methods=["POST"])
@csrf.exempt
@is_package_page
@is_api_authd
2021-11-24 16:39:50 +01:00
@cors_allowed
2020-01-24 21:21:40 +01:00
def create_release(token, package):
if not token:
error(401, "Authentication needed")
if not package.checkPerm(token.owner, Permission.APPROVE_RELEASE):
error(403, "You do not have the permission to approve releases")
data = request.json or request.form
if "title" not in data:
error(400, "Title is required in the POST data")
2020-01-24 21:21:40 +01:00
2021-02-02 18:09:28 +01:00
if data.get("method") == "git":
for option in ["method", "ref"]:
if option not in data:
error(400, option + " is required in the POST data")
2020-01-24 21:21:40 +01:00
return api_create_vcs_release(token, package, data["title"], data["ref"])
elif request.files:
file = request.files.get("file")
if file is None:
error(400, "Missing 'file' in multipart body")
commit_hash = data.get("commit")
return api_create_zip_release(token, package, data["title"], file, None, None, "API", commit_hash)
2021-02-02 18:09:23 +01:00
2021-02-02 18:09:28 +01:00
else:
error(400, "Unknown release-creation method. Specify the method or provide a file.")
@bp.route("/api/packages/<author>/<name>/releases/<int:id>/")
@is_package_page
2021-11-24 16:39:50 +01:00
@cors_allowed
2021-02-02 18:09:28 +01:00
def release(package: Package, id: int):
release = PackageRelease.query.get(id)
if release is None or release.package != package:
error(404, "Release not found")
return jsonify(release.getAsDictionary())
@bp.route("/api/packages/<author>/<name>/releases/<int:id>/", methods=["DELETE"])
@csrf.exempt
@is_package_page
@is_api_authd
2021-11-24 16:39:50 +01:00
@cors_allowed
2021-02-02 18:09:28 +01:00
def delete_release(token: APIToken, package: Package, id: int):
release = PackageRelease.query.get(id)
if release is None or release.package != package:
error(404, "Release not found")
if not token:
error(401, "Authentication needed")
if not token.canOperateOnPackage(package):
error(403, "API token does not have access to the package")
if not release.checkPerm(token.owner, Permission.DELETE_RELEASE):
error(403, "Unable to delete the release, make sure there's a newer release available")
db.session.delete(release)
db.session.commit()
return jsonify({"success": True})
2021-02-02 18:09:23 +01:00
2021-02-02 18:09:25 +01:00
@bp.route("/api/packages/<author>/<name>/screenshots/")
@is_package_page
2021-11-24 16:39:50 +01:00
@cors_allowed
2021-02-02 18:09:25 +01:00
def list_screenshots(package):
screenshots = package.screenshots.all()
return jsonify([ss.getAsDictionary(current_app.config["BASE_URL"]) for ss in screenshots])
2021-02-02 18:09:23 +01:00
@bp.route("/api/packages/<author>/<name>/screenshots/new/", methods=["POST"])
@csrf.exempt
@is_package_page
@is_api_authd
2021-11-24 16:39:50 +01:00
@cors_allowed
2021-02-02 18:09:23 +01:00
def create_screenshot(token: APIToken, package: Package):
if not token:
error(401, "Authentication needed")
if not package.checkPerm(token.owner, Permission.ADD_SCREENSHOTS):
error(403, "You do not have the permission to create screenshots")
data = request.form
if "title" not in data:
error(400, "Title is required in the POST data")
file = request.files.get("file")
if file is None:
error(400, "Missing 'file' in multipart body")
return api_create_screenshot(token, package, data["title"], file)
2021-02-02 18:09:25 +01:00
@bp.route("/api/packages/<author>/<name>/screenshots/<int:id>/")
@is_package_page
2021-11-24 16:39:50 +01:00
@cors_allowed
2021-02-02 18:09:25 +01:00
def screenshot(package, id):
ss = PackageScreenshot.query.get(id)
if ss is None or ss.package != package:
error(404, "Screenshot not found")
return jsonify(ss.getAsDictionary(current_app.config["BASE_URL"]))
@bp.route("/api/packages/<author>/<name>/screenshots/<int:id>/", methods=["DELETE"])
@csrf.exempt
@is_package_page
@is_api_authd
2021-11-24 16:39:50 +01:00
@cors_allowed
2021-02-02 18:09:25 +01:00
def delete_screenshot(token: APIToken, package: Package, id: int):
ss = PackageScreenshot.query.get(id)
if ss is None or ss.package != package:
error(404, "Screenshot not found")
if not token:
error(401, "Authentication needed")
if not package.checkPerm(token.owner, Permission.ADD_SCREENSHOTS):
error(403, "You do not have the permission to delete screenshots")
if not token.canOperateOnPackage(package):
error(403, "API token does not have access to the package")
if package.cover_image == ss:
package.cover_image = None
db.session.merge(package)
db.session.delete(ss)
db.session.commit()
return jsonify({ "success": True })
@bp.route("/api/packages/<author>/<name>/screenshots/order/", methods=["POST"])
@csrf.exempt
@is_package_page
@is_api_authd
2021-11-24 16:39:50 +01:00
@cors_allowed
2021-02-02 18:09:25 +01:00
def order_screenshots(token: APIToken, package: Package):
if not token:
error(401, "Authentication needed")
if not package.checkPerm(token.owner, Permission.ADD_SCREENSHOTS):
error(403, "You do not have the permission to delete screenshots")
if not token.canOperateOnPackage(package):
error(403, "API token does not have access to the package")
json = request.json
if json is None or not isinstance(json, list):
error(400, "Expected order body to be array")
return api_order_screenshots(token, package, request.json)
2021-02-02 23:41:48 +01:00
2021-11-24 17:33:37 +01:00
@bp.route("/api/packages/<author>/<name>/reviews/")
@is_package_page
@cors_allowed
def list_reviews(package):
reviews = package.reviews
return jsonify([review.getAsDictionary() for review in reviews])
@bp.route("/api/reviews/")
@cors_allowed
def list_all_reviews():
2021-11-26 15:33:17 +01:00
page = get_int_or_abort(request.args.get("page"), 1)
num = min(get_int_or_abort(request.args.get("n"), 100), 100)
query = PackageReview.query
query = query.options(joinedload(PackageReview.author), joinedload(PackageReview.package))
if request.args.get("author"):
2021-12-20 22:07:12 +01:00
query = query.filter(PackageReview.author.has(User.username == request.args.get("author")))
2021-11-26 15:33:17 +01:00
if request.args.get("is_positive"):
query = query.filter(PackageReview.recommends == isYes(request.args.get("is_positive")))
q = request.args.get("q")
if q:
query = query.filter(PackageReview.thread.has(Thread.title.ilike(f"%{q}%")))
pagination: flask_sqlalchemy.Pagination = query.paginate(page, num, True)
return jsonify({
"page": pagination.page,
2021-11-26 15:56:01 +01:00
"per_page": pagination.per_page,
"page_count": math.ceil(pagination.total / pagination.per_page),
"total": pagination.total,
2021-11-26 15:33:17 +01:00
"urls": {
2021-11-26 15:56:01 +01:00
"previous": abs_url(url_set_query(page=page - 1)) if pagination.has_prev else None,
"next": abs_url(url_set_query(page=page + 1)) if pagination.has_next else None,
2021-11-26 15:33:17 +01:00
},
2021-11-26 15:34:37 +01:00
"items": [review.getAsDictionary(True) for review in pagination.items],
2021-11-26 15:33:17 +01:00
})
2021-11-24 17:33:37 +01:00
2021-02-02 23:41:48 +01:00
@bp.route("/api/scores/")
2021-11-24 16:39:50 +01:00
@cors_allowed
2021-02-02 23:41:48 +01:00
def package_scores():
qb = QueryBuilder(request.args)
query = qb.buildPackageQuery()
pkgs = [package.getScoreDict() for package in query.all()]
return jsonify(pkgs)
@bp.route("/api/tags/")
2021-11-24 16:39:50 +01:00
@cors_allowed
2021-02-02 23:41:48 +01:00
def tags():
return jsonify([tag.getAsDictionary() for tag in Tag.query.all() ])
2021-02-03 00:58:59 +01:00
@bp.route("/api/content_warnings/")
2021-11-24 16:39:50 +01:00
@cors_allowed
2021-02-03 00:58:59 +01:00
def content_warnings():
return jsonify([warning.getAsDictionary() for warning in ContentWarning.query.all() ])
2021-02-02 23:41:48 +01:00
@bp.route("/api/licenses/")
2021-11-24 16:39:50 +01:00
@cors_allowed
2021-02-02 23:41:48 +01:00
def licenses():
return jsonify([ { "name": license.name, "is_foss": license.is_foss } \
for license in License.query.order_by(db.asc(License.name)).all() ])
@bp.route("/api/homepage/")
2021-11-24 16:39:50 +01:00
@cors_allowed
2021-02-02 23:41:48 +01:00
def homepage():
query = Package.query.filter_by(state=PackageState.APPROVED)
count = query.count()
2021-07-22 15:05:59 +02:00
featured = query.filter(Package.tags.any(name="featured")).order_by(
func.random()).limit(6).all()
2021-02-02 23:41:48 +01:00
new = query.order_by(db.desc(Package.approved_at)).limit(4).all()
pop_mod = query.filter_by(type=PackageType.MOD).order_by(db.desc(Package.score)).limit(8).all()
pop_gam = query.filter_by(type=PackageType.GAME).order_by(db.desc(Package.score)).limit(8).all()
pop_txp = query.filter_by(type=PackageType.TXP).order_by(db.desc(Package.score)).limit(8).all()
high_reviewed = query.order_by(db.desc(Package.score - Package.score_downloads)) \
.filter(Package.reviews.any()).limit(4).all()
updated = db.session.query(Package).select_from(PackageRelease).join(Package) \
.filter_by(state=PackageState.APPROVED) \
.order_by(db.desc(PackageRelease.releaseDate)) \
.limit(20).all()
updated = updated[:4]
downloads_result = db.session.query(func.sum(Package.downloads)).one_or_none()
downloads = 0 if not downloads_result or not downloads_result[0] else downloads_result[0]
2021-11-25 11:35:31 +01:00
def mapPackages(packages: List[Package]):
return [pkg.getAsDictionaryShort(current_app.config["BASE_URL"]) for pkg in packages]
2021-02-02 23:41:48 +01:00
return jsonify({
2021-02-02 23:41:48 +01:00
"count": count,
"downloads": downloads,
2021-07-22 15:04:08 +02:00
"featured": mapPackages(featured),
2021-02-02 23:41:48 +01:00
"new": mapPackages(new),
"updated": mapPackages(updated),
"pop_mod": mapPackages(pop_mod),
"pop_txp": mapPackages(pop_txp),
"pop_game": mapPackages(pop_gam),
"high_reviewed": mapPackages(high_reviewed)
})
2021-02-02 23:41:48 +01:00
2022-01-30 04:35:02 +01:00
@bp.route("/api/welcome/v1/")
@cors_allowed
def welcome_v1():
featured = Package.query \
.filter(Package.type == PackageType.GAME, Package.state == PackageState.APPROVED,
Package.tags.any(name="featured")) \
.order_by(func.random()) \
.limit(5).all()
mtg = Package.query.filter(Package.author.has(username="Minetest"), Package.name == "minetest_game").one()
featured.insert(2, mtg)
def map_packages(packages: List[Package]):
return [pkg.getAsDictionaryShort(current_app.config["BASE_URL"]) for pkg in packages]
return jsonify({
"featured": map_packages(featured),
})
2021-02-02 23:41:48 +01:00
@bp.route("/api/minetest_versions/")
2021-11-24 16:39:50 +01:00
@cors_allowed
2021-02-02 23:41:48 +01:00
def versions():
protocol_version = request.args.get("protocol_version")
engine_version = request.args.get("engine_version")
if protocol_version or engine_version:
rel = MinetestRelease.get(engine_version, get_int_or_abort(protocol_version))
if rel is None:
error(404, "No releases found")
return jsonify(rel.getAsDictionary())
2021-02-02 23:41:48 +01:00
return jsonify([rel.getAsDictionary() \
for rel in MinetestRelease.query.all() if rel.getActual() is not None])
2022-01-12 18:08:18 +01:00
@bp.route("/api/dependencies/")
@cors_allowed
def all_deps():
qb = QueryBuilder(request.args)
query = qb.buildPackageQuery()
def format_pkg(pkg: Package):
return {
"type": pkg.type.toName(),
"author": pkg.author.username,
"name": pkg.name,
"provides": [x.name for x in pkg.provides],
"depends": [str(x) for x in pkg.dependencies if not x.optional],
"optional_depends": [str(x) for x in pkg.dependencies if x.optional],
}
page = get_int_or_abort(request.args.get("page"), 1)
num = min(get_int_or_abort(request.args.get("n"), 100), 300)
2022-01-12 18:08:18 +01:00
pagination: flask_sqlalchemy.Pagination = query.paginate(page, num, True)
return jsonify({
"page": pagination.page,
"per_page": pagination.per_page,
"page_count": math.ceil(pagination.total / pagination.per_page),
"total": pagination.total,
"urls": {
"previous": abs_url(url_set_query(page=page - 1)) if pagination.has_prev else None,
"next": abs_url(url_set_query(page=page + 1)) if pagination.has_next else None,
},
"items": [format_pkg(pkg) for pkg in pagination.items],
})