2 # Copyright (C) 2018 rubenwardy
4 # This program is free software: you can redistribute it and/or modify
5 # it under the terms of the GNU General Public License as published by
6 # the Free Software Foundation, either version 3 of the License, or
7 # (at your option) any later version.
9 # This program is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 # GNU General Public License for more details.
14 # You should have received a copy of the GNU General Public License
15 # along with this program. If not, see <https://www.gnu.org/licenses/>.
18 from flask import render_template, abort, request, redirect, url_for, flash
19 from flask_user import current_user
20 import flask_menu as menu
24 from app.models import *
25 from app.querybuilder import QueryBuilder
26 from app.tasks.importtasks import importRepoScreenshot, updateMetaFromRelease
27 from app.rediscache import has_key, set_key
28 from app.utils import *
30 from flask_wtf import FlaskForm
32 from wtforms.validators import *
33 from wtforms.ext.sqlalchemy.fields import QuerySelectField, QuerySelectMultipleField
34 from sqlalchemy import or_, func
35 from sqlalchemy.orm import joinedload, subqueryload
36 from urllib.parse import quote as urlescape
38 from celery import uuid
41 @menu.register_menu(bp, ".mods", "Mods", order=11, endpoint_arguments_constructor=lambda: { 'type': 'mod' })
42 @menu.register_menu(bp, ".games", "Games", order=12, endpoint_arguments_constructor=lambda: { 'type': 'game' })
43 @menu.register_menu(bp, ".txp", "Texture Packs", order=13, endpoint_arguments_constructor=lambda: { 'type': 'txp' })
44 @menu.register_menu(bp, ".random", "Random", order=14, endpoint_arguments_constructor=lambda: { 'random': '1', 'lucky': '1' })
45 @bp.route("/packages/")
47 qb = QueryBuilder(request.args)
48 query = qb.buildPackageQuery()
51 query = query.options( \
52 joinedload(Package.license), \
53 joinedload(Package.media_license), \
54 subqueryload(Package.tags))
56 ip = request.headers.get("X-Forwarded-For") or request.remote_addr
57 if ip is not None and not is_user_bot():
61 key = "tag/{}/{}".format(ip, tag.name)
64 Tag.query.filter_by(id=tag.id).update({
65 "views": Tag.views + 1
72 package = query.first()
74 return redirect(package.getDetailsURL())
76 topic = qb.buildTopicQuery().first()
77 if qb.search and topic:
78 return redirect("https://forum.minetest.net/viewtopic.php?t=" + str(topic.topic_id))
80 page = get_int_or_abort(request.args.get("page"), 1)
81 num = min(40, get_int_or_abort(request.args.get("n"), 100))
82 query = query.paginate(page, num, True)
84 search = request.args.get("q")
85 type_name = request.args.get("type")
89 authors = User.query \
90 .filter(or_(*[func.lower(User.username) == name.lower().strip() for name in search.split(" ")])) \
93 authors = [(author.username, search.lower().replace(author.username.lower(), "")) for author in authors]
96 if qb.search and not query.has_next:
97 qb.show_discarded = True
98 topics = qb.buildTopicQuery().all()
100 tags_query = db.session.query(func.count(Tags.c.tag_id), Tag) \
101 .select_from(Tag).join(Tags).join(Package).group_by(Tag.id).order_by(db.asc(Tag.title))
102 tags = qb.filterPackageQuery(tags_query).all()
104 selected_tags = set(qb.tags)
106 return render_template("packages/list.html", \
107 title=title, packages=query.items, pagination=query, \
108 query=search, tags=tags, selected_tags=selected_tags, type=type_name, \
109 authors=authors, packages_count=query.total, topics=topics)
112 def getReleases(package):
113 if package.checkPerm(current_user, Permission.MAKE_RELEASE):
114 return package.releases.limit(5)
116 return package.releases.filter_by(approved=True).limit(5)
119 @bp.route("/packages/<author>/<name>/")
123 if package.type == PackageType.MOD:
124 alternatives = Package.query \
125 .filter_by(name=package.name, type=PackageType.MOD, soft_deleted=False) \
126 .filter(Package.id != package.id) \
127 .order_by(db.desc(Package.score)) \
131 show_similar_topics = current_user == package.author or \
132 package.checkPerm(current_user, Permission.APPROVE_NEW)
134 similar_topics = None if not show_similar_topics else \
136 .filter_by(name=package.name) \
137 .filter(ForumTopic.topic_id != package.forums) \
138 .filter(~ db.exists().where(Package.forums==ForumTopic.topic_id)) \
139 .order_by(db.asc(ForumTopic.name), db.asc(ForumTopic.title)) \
142 releases = getReleases(package)
143 requests = [r for r in package.requests if r.status == 0]
145 review_thread = package.review_thread
146 if review_thread is not None and not review_thread.checkPerm(current_user, Permission.SEE_THREAD):
150 topic_error_lvl = "warning"
151 if not package.approved and package.forums is not None:
153 if Package.query.filter_by(forums=package.forums, soft_deleted=False).count() > 1:
154 errors.append("<b>Error: Another package already uses this forum topic!</b>")
155 topic_error_lvl = "danger"
157 topic = ForumTopic.query.get(package.forums)
158 if topic is not None:
159 if topic.author != package.author:
160 errors.append("<b>Error: Forum topic author doesn't match package author.</b>")
161 topic_error_lvl = "danger"
164 errors.append("Warning: Forum topic is in WIP section, make sure package meets playability standards.")
165 elif package.type != PackageType.TXP:
166 errors.append("Warning: Forum topic not found. This may happen if the topic has only just been created.")
168 topic_error = "<br />".join(errors)
171 threads = Thread.query.filter_by(package_id=package.id, review_id=None)
172 if not current_user.is_authenticated:
173 threads = threads.filter_by(private=False)
174 elif not current_user.rank.atLeast(UserRank.EDITOR) and not current_user == package.author:
175 threads = threads.filter(or_(Thread.private == False, Thread.author == current_user))
177 has_review = current_user.is_authenticated and PackageReview.query.filter_by(package=package, author=current_user).count() > 0
179 return render_template("packages/view.html", \
180 package=package, releases=releases, requests=requests, \
181 alternatives=alternatives, similar_topics=similar_topics, \
182 review_thread=review_thread, topic_error=topic_error, topic_error_lvl=topic_error_lvl, \
183 threads=threads.all(), has_review=has_review)
186 @bp.route("/packages/<author>/<name>/shields/<type>/")
188 def shield(package, type):
190 url = "https://img.shields.io/badge/ContentDB-{}-{}" \
191 .format(urlescape(package.title), urlescape("#375a7f"))
192 elif type == "downloads":
193 #api_url = abs_url_for("api.package", author=package.author.username, name=package.name)
194 api_url = "https://content.minetest.net" + url_for("api.package", author=package.author.username, name=package.name)
195 url = "https://img.shields.io/badge/dynamic/json?color={}&label=ContentDB&query=downloads&suffix=+downloads&url={}" \
196 .format(urlescape("#375a7f"), urlescape(api_url))
204 @bp.route("/packages/<author>/<name>/download/")
206 def download(package):
207 release = package.getDownloadRelease()
210 if "application/zip" in request.accept_mimetypes and \
211 not "text/html" in request.accept_mimetypes:
214 flash("No download available.", "danger")
215 return redirect(package.getDetailsURL())
217 return redirect(release.getDownloadURL(), code=302)
222 return "{}: {}".format(obj.title, obj.description)
226 class PackageForm(FlaskForm):
227 name = StringField("Name (Technical)", [InputRequired(), Length(1, 100), Regexp("^[a-z0-9_]+$", 0, "Lower case letters (a-z), digits (0-9), and underscores (_) only")])
228 title = StringField("Title (Human-readable)", [InputRequired(), Length(3, 100)])
229 short_desc = StringField("Short Description (Plaintext)", [InputRequired(), Length(1,200)])
230 desc = TextAreaField("Long Description (Markdown)", [Optional(), Length(0,10000)])
231 type = SelectField("Type", [InputRequired()], choices=PackageType.choices(), coerce=PackageType.coerce, default=PackageType.MOD)
232 license = QuerySelectField("License", [DataRequired()], allow_blank=True, query_factory=lambda: License.query.order_by(db.asc(License.name)), get_pk=lambda a: a.id, get_label=lambda a: a.name)
233 media_license = QuerySelectField("Media License", [DataRequired()], allow_blank=True, query_factory=lambda: License.query.order_by(db.asc(License.name)), get_pk=lambda a: a.id, get_label=lambda a: a.name)
234 provides_str = StringField("Provides (mods included in package)", [Optional()])
235 tags = QuerySelectMultipleField('Tags', query_factory=lambda: Tag.query.order_by(db.asc(Tag.name)), get_pk=lambda a: a.id, get_label=makeLabel)
236 content_warnings = QuerySelectMultipleField('Content Warnings', query_factory=lambda: ContentWarning.query.order_by(db.asc(ContentWarning.name)), get_pk=lambda a: a.id, get_label=makeLabel)
237 harddep_str = StringField("Hard Dependencies", [Optional()])
238 softdep_str = StringField("Soft Dependencies", [Optional()])
239 repo = StringField("VCS Repository URL", [Optional(), URL()], filters = [lambda x: x or None])
240 website = StringField("Website URL", [Optional(), URL()], filters = [lambda x: x or None])
241 issueTracker = StringField("Issue Tracker URL", [Optional(), URL()], filters = [lambda x: x or None])
242 forums = IntegerField("Forum Topic ID", [Optional(), NumberRange(0,999999)])
243 submit = SubmitField("Save")
246 @bp.route("/packages/new/", methods=["GET", "POST"])
247 @bp.route("/packages/<author>/<name>/edit/", methods=["GET", "POST"])
249 def create_edit(author=None, name=None):
253 form = PackageForm(formdata=request.form)
254 author = request.args.get("author")
255 if author is None or author == current_user.username:
256 author = current_user
258 author = User.query.filter_by(username=author).first()
260 flash("Unable to find that user", "danger")
261 return redirect(url_for("packages.create_edit"))
263 if not author.checkPerm(current_user, Permission.CHANGE_AUTHOR):
264 flash("Permission denied", "danger")
265 return redirect(url_for("packages.create_edit"))
268 package = getPackageByInfo(author, name)
271 if not package.checkPerm(current_user, Permission.EDIT_PACKAGE):
272 return redirect(package.getDetailsURL())
274 author = package.author
276 form = PackageForm(formdata=request.form, obj=package)
278 # Initial form class from post data and default data
279 if request.method == "GET":
281 form.name.data = request.args.get("bname")
282 form.title.data = request.args.get("title")
283 form.repo.data = request.args.get("repo")
284 form.forums.data = request.args.get("forums")
285 form.license.data = None
286 form.media_license.data = None
288 form.harddep_str.data = ",".join([str(x) for x in package.getSortedHardDependencies() ])
289 form.softdep_str.data = ",".join([str(x) for x in package.getSortedOptionalDependencies() ])
290 form.provides_str.data = MetaPackage.ListToSpec(package.provides)
291 form.tags.data = list(package.tags)
292 form.content_warnings.data = list(package.content_warnings)
294 if request.method == "POST" and form.validate():
297 package = Package.query.filter_by(name=form["name"].data, author_id=author.id).first()
298 if package is not None:
299 if package.soft_deleted:
300 Package.query.filter_by(name=form["name"].data, author_id=author.id).delete()
302 flash("Package already exists!", "danger")
303 return redirect(url_for("packages.create_edit"))
306 package.author = author
307 package.maintainers.append(author)
310 elif package.approved and package.name != form.name.data and \
311 not package.checkPerm(current_user, Permission.CHANGE_NAME):
312 flash("Unable to change package name", "danger")
313 return redirect(url_for("packages.create_edit", author=author, name=name))
316 msg = "Edited {}".format(package.title)
318 addNotification(package.maintainers, current_user,
319 msg, package.getDetailsURL(), package)
321 severity = AuditSeverity.NORMAL if current_user in package.maintainers else AuditSeverity.EDITOR
322 addAuditLog(severity, current_user, msg, package.getDetailsURL(), package)
324 form.populate_obj(package) # copy to row
326 if package.type == PackageType.TXP:
327 package.license = package.media_license
330 package.provides.clear()
331 mpackages = MetaPackage.SpecToList(form.provides_str.data, mpackage_cache)
333 package.provides.append(m)
335 Dependency.query.filter_by(depender=package).delete()
336 deps = Dependency.SpecToList(package, form.harddep_str.data, mpackage_cache)
341 deps = Dependency.SpecToList(package, form.softdep_str.data, mpackage_cache)
346 if wasNew and package.type == PackageType.MOD and not package.name in mpackage_cache:
347 m = MetaPackage.GetOrCreate(package.name, mpackage_cache)
348 package.provides.append(m)
351 for tag in form.tags.raw_data:
352 package.tags.append(Tag.query.get(tag))
354 package.content_warnings.clear()
355 for warning in form.content_warnings.raw_data:
356 package.content_warnings.append(ContentWarning.query.get(warning))
358 db.session.commit() # save
360 next_url = package.getDetailsURL()
361 if wasNew and package.repo is not None:
362 task = importRepoScreenshot.delay(package.id)
363 next_url = url_for("tasks.check", id=task.id, r=next_url)
365 if wasNew and ("WTFPL" in package.license.name or "WTFPL" in package.media_license.name):
366 next_url = url_for("flatpage", path="help/wtfpl", r=next_url)
368 return redirect(next_url)
370 package_query = Package.query.filter_by(approved=True, soft_deleted=False)
371 if package is not None:
372 package_query = package_query.filter(Package.id != package.id)
374 enableWizard = name is None and request.method != "POST"
375 return render_template("packages/create_edit.html", package=package, \
376 form=form, author=author, enable_wizard=enableWizard, \
377 packages=package_query.all(), \
378 mpackages=MetaPackage.query.order_by(db.asc(MetaPackage.name)).all())
380 @bp.route("/packages/<author>/<name>/approve/", methods=["POST"])
383 def approve(package):
384 if not package.checkPerm(current_user, Permission.APPROVE_NEW):
385 flash("You don't have permission to do that.", "danger")
387 elif package.approved:
388 flash("Package has already been approved", "danger")
391 package.approved = True
392 if not package.approved_at:
393 package.approved_at = datetime.datetime.now()
395 screenshots = PackageScreenshot.query.filter_by(package=package, approved=False).all()
396 for s in screenshots:
399 msg = "Approved {}".format(package.title)
400 addNotification(package.maintainers, current_user, msg, package.getDetailsURL(), package)
401 severity = AuditSeverity.NORMAL if current_user == package.author else AuditSeverity.EDITOR
402 addAuditLog(severity, current_user, msg, package.getDetailsURL(), package)
405 return redirect(package.getDetailsURL())
408 @bp.route("/packages/<author>/<name>/remove/", methods=["GET", "POST"])
412 if request.method == "GET":
413 return render_template("packages/remove.html", package=package)
415 if "delete" in request.form:
416 if not package.checkPerm(current_user, Permission.DELETE_PACKAGE):
417 flash("You don't have permission to do that.", "danger")
418 return redirect(package.getDetailsURL())
420 package.soft_deleted = True
422 url = url_for("users.profile", username=package.author.username)
423 msg = "Deleted {}".format(package.title)
424 addNotification(package.maintainers, current_user, msg, url, package)
425 addAuditLog(AuditSeverity.EDITOR, current_user, msg, url)
428 flash("Deleted package", "success")
431 elif "unapprove" in request.form:
432 if not package.checkPerm(current_user, Permission.UNAPPROVE_PACKAGE):
433 flash("You don't have permission to do that.", "danger")
434 return redirect(package.getDetailsURL())
436 package.approved = False
438 msg = "Unapproved {}".format(package.title)
439 addNotification(package.maintainers, current_user, msg, package.getDetailsURL(), package)
440 addAuditLog(AuditSeverity.EDITOR, current_user, msg, package.getDetailsURL(), package)
444 flash("Unapproved package", "success")
446 return redirect(package.getDetailsURL())
452 class PackageMaintainersForm(FlaskForm):
453 maintainers_str = StringField("Maintainers (Comma-separated)", [Optional()])
454 submit = SubmitField("Save")
457 @bp.route("/packages/<author>/<name>/edit-maintainers/", methods=["GET", "POST"])
460 def edit_maintainers(package):
461 if not package.checkPerm(current_user, Permission.EDIT_MAINTAINERS):
462 flash("You do not have permission to edit maintainers", "danger")
463 return redirect(package.getDetailsURL())
465 form = PackageMaintainersForm(formdata=request.form)
466 if request.method == "GET":
467 form.maintainers_str.data = ", ".join([ x.username for x in package.maintainers if x != package.author ])
469 if request.method == "POST" and form.validate():
470 usernames = [x.strip().lower() for x in form.maintainers_str.data.split(",")]
471 users = User.query.filter(func.lower(User.username).in_(usernames)).all()
474 if not user in package.maintainers:
475 addNotification(user, current_user,
476 "Added you as a maintainer of {}".format(package.title), package.getDetailsURL(), package)
478 for user in package.maintainers:
479 if user != package.author and not user in users:
480 addNotification(user, current_user,
481 "Removed you as a maintainer of {}".format(package.title), package.getDetailsURL(), package)
483 package.maintainers.clear()
484 package.maintainers.extend(users)
485 if package.author not in package.maintainers:
486 package.maintainers.append(package.author)
488 msg = "Edited {} maintainers".format(package.title)
489 addNotification(package.author, current_user, msg, package.getDetailsURL(), package)
490 severity = AuditSeverity.NORMAL if current_user == package.author else AuditSeverity.MODERATION
491 addAuditLog(severity, current_user, msg, package.getDetailsURL(), package)
495 return redirect(package.getDetailsURL())
497 users = User.query.filter(User.rank >= UserRank.NEW_MEMBER).order_by(db.asc(User.username)).all()
499 return render_template("packages/edit_maintainers.html", \
500 package=package, form=form, users=users)
503 @bp.route("/packages/<author>/<name>/remove-self-maintainer/", methods=["POST"])
506 def remove_self_maintainers(package):
507 if not current_user in package.maintainers:
508 flash("You are not a maintainer", "danger")
510 elif current_user == package.author:
511 flash("Package owners cannot remove themselves as maintainers", "danger")
514 package.maintainers.remove(current_user)
516 addNotification(package.author, current_user,
517 "Removed themself as a maintainer of {}".format(package.title), package.getDetailsURL(), package)
521 return redirect(package.getDetailsURL())
524 @bp.route("/packages/<author>/<name>/import-meta/", methods=["POST"])
527 def update_from_release(package):
528 if not package.checkPerm(current_user, Permission.REIMPORT_META):
529 flash("You don't have permission to reimport meta", "danger")
530 return redirect(package.getDetailsURL())
532 release = package.releases.first()
534 flash("Release needed", "danger")
535 return redirect(package.getDetailsURL())
537 msg = "Updated meta from latest release"
538 addNotification(package.maintainers, current_user,
539 msg, package.getDetailsURL(), package)
540 severity = AuditSeverity.NORMAL if current_user in package.maintainers else AuditSeverity.EDITOR
541 addAuditLog(severity, current_user, msg, package.getDetailsURL(), package)
546 zippath = release.url.replace("/uploads/", app.config["UPLOAD_DIR"])
547 updateMetaFromRelease.apply_async((release.id, zippath), task_id=task_id)
549 return redirect(url_for("tasks.check", id=task_id, r=package.getEditURL()))