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
27 from app.utils import *
29 from flask_wtf import FlaskForm
31 from wtforms.validators import *
32 from wtforms.ext.sqlalchemy.fields import QuerySelectField, QuerySelectMultipleField
33 from sqlalchemy import or_, func
36 @menu.register_menu(bp, ".mods", "Mods", order=11, endpoint_arguments_constructor=lambda: { 'type': 'mod' })
37 @menu.register_menu(bp, ".games", "Games", order=12, endpoint_arguments_constructor=lambda: { 'type': 'game' })
38 @menu.register_menu(bp, ".txp", "Texture Packs", order=13, endpoint_arguments_constructor=lambda: { 'type': 'txp' })
39 @menu.register_menu(bp, ".random", "Random", order=14, endpoint_arguments_constructor=lambda: { 'random': '1', 'lucky': '1' })
40 @bp.route("/packages/")
42 qb = QueryBuilder(request.args)
43 query = qb.buildPackageQuery()
47 package = query.first()
49 return redirect(package.getDetailsURL())
51 topic = qb.buildTopicQuery().first()
52 if qb.search and topic:
53 return redirect("https://forum.minetest.net/viewtopic.php?t=" + str(topic.topic_id))
55 page = get_int_or_abort(request.args.get("page"), 1)
56 num = min(40, get_int_or_abort(request.args.get("n"), 100))
57 query = query.paginate(page, num, True)
59 search = request.args.get("q")
60 type_name = request.args.get("type")
62 next_url = url_for("packages.list_all", type=type_name, q=search, page=query.next_num) \
63 if query.has_next else None
64 prev_url = url_for("packages.list_all", type=type_name, q=search, page=query.prev_num) \
65 if query.has_prev else None
69 authors = User.query \
70 .filter(or_(*[func.lower(User.username) == name.lower().strip() for name in search.split(" ")])) \
73 authors = [(author.username, search.lower().replace(author.username.lower(), "")) for author in authors]
76 if qb.search and not query.has_next:
77 qb.show_discarded = True
78 topics = qb.buildTopicQuery().all()
80 tags = Tag.query.all()
81 return render_template("packages/list.html", \
82 title=title, packages=query.items, topics=topics, \
83 query=search, tags=tags, type=type_name, \
85 next_url=next_url, prev_url=prev_url, page=page, page_max=query.pages, packages_count=query.total)
88 def getReleases(package):
89 if package.checkPerm(current_user, Permission.MAKE_RELEASE):
90 return package.releases.limit(5)
92 return package.releases.filter_by(approved=True).limit(5)
95 @bp.route("/packages/<author>/<name>/")
98 clearNotifications(package.getDetailsURL())
101 if package.type == PackageType.MOD:
102 alternatives = Package.query \
103 .filter_by(name=package.name, type=PackageType.MOD, soft_deleted=False) \
104 .filter(Package.id != package.id) \
105 .order_by(db.desc(Package.score)) \
109 show_similar_topics = current_user == package.author or \
110 package.checkPerm(current_user, Permission.APPROVE_NEW)
112 similar_topics = None if not show_similar_topics else \
114 .filter_by(name=package.name) \
115 .filter(ForumTopic.topic_id != package.forums) \
116 .filter(~ db.exists().where(Package.forums==ForumTopic.topic_id)) \
117 .order_by(db.asc(ForumTopic.name), db.asc(ForumTopic.title)) \
120 releases = getReleases(package)
121 requests = [r for r in package.requests if r.status == 0]
123 review_thread = package.review_thread
124 if review_thread is not None and not review_thread.checkPerm(current_user, Permission.SEE_THREAD):
128 topic_error_lvl = "warning"
129 if not package.approved and package.forums is not None:
131 if Package.query.filter_by(forums=package.forums, soft_deleted=False).count() > 1:
132 errors.append("<b>Error: Another package already uses this forum topic!</b>")
133 topic_error_lvl = "danger"
135 topic = ForumTopic.query.get(package.forums)
136 if topic is not None:
137 if topic.author != package.author:
138 errors.append("<b>Error: Forum topic author doesn't match package author.</b>")
139 topic_error_lvl = "danger"
142 errors.append("Warning: Forum topic is in WIP section, make sure package meets playability standards.")
143 elif package.type != PackageType.TXP:
144 errors.append("Warning: Forum topic not found. This may happen if the topic has only just been created.")
146 topic_error = "<br />".join(errors)
149 threads = Thread.query.filter_by(package_id=package.id)
150 if not current_user.is_authenticated:
151 threads = threads.filter_by(private=False)
152 elif not current_user.rank.atLeast(UserRank.EDITOR) and not current_user == package.author:
153 threads = threads.filter(or_(Thread.private == False, Thread.author == current_user))
156 return render_template("packages/view.html", \
157 package=package, releases=releases, requests=requests, \
158 alternatives=alternatives, similar_topics=similar_topics, \
159 review_thread=review_thread, topic_error=topic_error, topic_error_lvl=topic_error_lvl, \
160 threads=threads.all())
163 @bp.route("/packages/<author>/<name>/download/")
165 def download(package):
166 release = package.getDownloadRelease()
169 if "application/zip" in request.accept_mimetypes and \
170 not "text/html" in request.accept_mimetypes:
173 flash("No download available.", "danger")
174 return redirect(package.getDetailsURL())
176 return redirect(release.getDownloadURL(), code=302)
179 class PackageForm(FlaskForm):
180 name = StringField("Name (Technical)", [InputRequired(), Length(1, 100), Regexp("^[a-z0-9_]+$", 0, "Lower case letters (a-z), digits (0-9), and underscores (_) only")])
181 title = StringField("Title (Human-readable)", [InputRequired(), Length(3, 100)])
182 short_desc = StringField("Short Description (Plaintext)", [InputRequired(), Length(1,200)])
183 desc = TextAreaField("Long Description (Markdown)", [Optional(), Length(0,10000)])
184 type = SelectField("Type", [InputRequired()], choices=PackageType.choices(), coerce=PackageType.coerce, default=PackageType.MOD)
185 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)
186 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)
187 provides_str = StringField("Provides (mods included in package)", [Optional()])
188 tags = QuerySelectMultipleField('Tags', query_factory=lambda: Tag.query.order_by(db.asc(Tag.name)), get_pk=lambda a: a.id, get_label=lambda a: a.title)
189 harddep_str = StringField("Hard Dependencies", [Optional()])
190 softdep_str = StringField("Soft Dependencies", [Optional()])
191 repo = StringField("VCS Repository URL", [Optional(), URL()], filters = [lambda x: x or None])
192 website = StringField("Website URL", [Optional(), URL()], filters = [lambda x: x or None])
193 issueTracker = StringField("Issue Tracker URL", [Optional(), URL()], filters = [lambda x: x or None])
194 forums = IntegerField("Forum Topic ID", [Optional(), NumberRange(0,999999)])
195 submit = SubmitField("Save")
197 @bp.route("/packages/new/", methods=["GET", "POST"])
198 @bp.route("/packages/<author>/<name>/edit/", methods=["GET", "POST"])
200 def create_edit(author=None, name=None):
204 form = PackageForm(formdata=request.form)
205 author = request.args.get("author")
206 if author is None or author == current_user.username:
207 author = current_user
209 author = User.query.filter_by(username=author).first()
211 flash("Unable to find that user", "danger")
212 return redirect(url_for("packages.create_edit"))
214 if not author.checkPerm(current_user, Permission.CHANGE_AUTHOR):
215 flash("Permission denied", "danger")
216 return redirect(url_for("packages.create_edit"))
219 package = getPackageByInfo(author, name)
220 if not package.checkPerm(current_user, Permission.EDIT_PACKAGE):
221 return redirect(package.getDetailsURL())
223 author = package.author
225 form = PackageForm(formdata=request.form, obj=package)
227 # Initial form class from post data and default data
228 if request.method == "GET":
230 form.name.data = request.args.get("bname")
231 form.title.data = request.args.get("title")
232 form.repo.data = request.args.get("repo")
233 form.forums.data = request.args.get("forums")
234 form.license.data = None
235 form.media_license.data = None
237 form.harddep_str.data = ",".join([str(x) for x in package.getSortedHardDependencies() ])
238 form.softdep_str.data = ",".join([str(x) for x in package.getSortedOptionalDependencies() ])
239 form.provides_str.data = MetaPackage.ListToSpec(package.provides)
241 if request.method == "POST" and form.validate():
244 package = Package.query.filter_by(name=form["name"].data, author_id=author.id).first()
245 if package is not None:
246 if package.soft_deleted:
247 Package.query.filter_by(name=form["name"].data, author_id=author.id).delete()
249 flash("Package already exists!", "danger")
250 return redirect(url_for("packages.create_edit"))
253 package.author = author
256 elif package.approved and package.name != form.name.data and \
257 not package.checkPerm(current_user, Permission.CHANGE_NAME):
258 flash("Unable to change package name", "danger")
259 return redirect(url_for("packages.create_edit", author=author, name=name))
262 triggerNotif(package.author, current_user,
263 "{} edited".format(package.title), package.getDetailsURL())
265 form.populate_obj(package) # copy to row
267 if package.type== PackageType.TXP:
268 package.license = package.media_license
271 package.provides.clear()
272 mpackages = MetaPackage.SpecToList(form.provides_str.data, mpackage_cache)
274 package.provides.append(m)
276 Dependency.query.filter_by(depender=package).delete()
277 deps = Dependency.SpecToList(package, form.harddep_str.data, mpackage_cache)
282 deps = Dependency.SpecToList(package, form.softdep_str.data, mpackage_cache)
287 if wasNew and package.type == PackageType.MOD and not package.name in mpackage_cache:
288 m = MetaPackage.GetOrCreate(package.name, mpackage_cache)
289 package.provides.append(m)
292 for tag in form.tags.raw_data:
293 package.tags.append(Tag.query.get(tag))
295 db.session.commit() # save
297 next_url = package.getDetailsURL()
298 if wasNew and package.repo is not None:
299 task = importRepoScreenshot.delay(package.id)
300 next_url = url_for("tasks.check", id=task.id, r=next_url)
302 if wasNew and ("WTFPL" in package.license.name or "WTFPL" in package.media_license.name):
303 next_url = url_for("flatpage", path="help/wtfpl", r=next_url)
305 return redirect(next_url)
307 package_query = Package.query.filter_by(approved=True, soft_deleted=False)
308 if package is not None:
309 package_query = package_query.filter(Package.id != package.id)
311 enableWizard = name is None and request.method != "POST"
312 return render_template("packages/create_edit.html", package=package, \
313 form=form, author=author, enable_wizard=enableWizard, \
314 packages=package_query.all(), \
315 mpackages=MetaPackage.query.order_by(db.asc(MetaPackage.name)).all())
317 @bp.route("/packages/<author>/<name>/approve/", methods=["POST"])
320 def approve(package):
321 if not package.checkPerm(current_user, Permission.APPROVE_NEW):
322 flash("You don't have permission to do that.", "danger")
324 elif package.approved:
325 flash("Package has already been approved", "danger")
328 package.approved = True
330 screenshots = PackageScreenshot.query.filter_by(package=package, approved=False).all()
331 for s in screenshots:
334 triggerNotif(package.author, current_user,
335 "{} approved".format(package.title), package.getDetailsURL())
338 return redirect(package.getDetailsURL())
341 @bp.route("/packages/<author>/<name>/remove/", methods=["GET", "POST"])
345 if request.method == "GET":
346 return render_template("packages/remove.html", package=package)
348 if "delete" in request.form:
349 if not package.checkPerm(current_user, Permission.DELETE_PACKAGE):
350 flash("You don't have permission to do that.", "danger")
351 return redirect(package.getDetailsURL())
353 package.soft_deleted = True
355 url = url_for("users.profile", username=package.author.username)
356 triggerNotif(package.author, current_user,
357 "{} deleted".format(package.title), url)
360 flash("Deleted package", "success")
363 elif "unapprove" in request.form:
364 if not package.checkPerm(current_user, Permission.UNAPPROVE_PACKAGE):
365 flash("You don't have permission to do that.", "danger")
366 return redirect(package.getDetailsURL())
368 package.approved = False
370 triggerNotif(package.author, current_user,
371 "{} deleted".format(package.title), package.getDetailsURL())
374 flash("Unapproved package", "success")
376 return redirect(package.getDetailsURL())