app/blueprints/packages/packages.py

   1 # ContentDB
   2 # Copyright (C) 2018  rubenwardy
   3 #
   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.
   8 #
   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.
  13 #
  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/>.
  16
  17
  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
  21
  22 from . import bp
  23
  24 from app.models import *
  25 from app.querybuilder import QueryBuilder
  26 from app.tasks.importtasks import importRepoScreenshot, updateMetaFromRelease
  27 from app.utils import *
  28
  29 from flask_wtf import FlaskForm
  30 from wtforms import *
  31 from wtforms.validators import *
  32 from wtforms.ext.sqlalchemy.fields import QuerySelectField, QuerySelectMultipleField
  33 from sqlalchemy import or_, func
  34 from sqlalchemy.orm import joinedload, subqueryload
  35
  36 from celery import uuid
  37
  38
  39 @menu.register_menu(bp, ".mods", "Mods", order=11, endpoint_arguments_constructor=lambda: { 'type': 'mod' })
  40 @menu.register_menu(bp, ".games", "Games", order=12, endpoint_arguments_constructor=lambda: { 'type': 'game' })
  41 @menu.register_menu(bp, ".txp", "Texture Packs", order=13, endpoint_arguments_constructor=lambda: { 'type': 'txp' })
  42 @menu.register_menu(bp, ".random", "Random", order=14, endpoint_arguments_constructor=lambda: { 'random': '1', 'lucky': '1' })
  43 @bp.route("/packages/")
  44 def list_all():
  45         qb    = QueryBuilder(request.args)
  46         query = qb.buildPackageQuery()
  47         title = qb.title
  48
  49         query = query.options( \
  50                         joinedload(Package.license), \
  51                         joinedload(Package.media_license), \
  52                         subqueryload(Package.tags))
  53
  54         if qb.lucky:
  55                 package = query.first()
  56                 if package:
  57                         return redirect(package.getDetailsURL())
  58
  59                 topic = qb.buildTopicQuery().first()
  60                 if qb.search and topic:
  61                         return redirect("https://forum.minetest.net/viewtopic.php?t=" + str(topic.topic_id))
  62
  63         page  = get_int_or_abort(request.args.get("page"), 1)
  64         num   = min(40, get_int_or_abort(request.args.get("n"), 100))
  65         query = query.paginate(page, num, True)
  66
  67         search = request.args.get("q")
  68         type_name = request.args.get("type")
  69
  70         authors = []
  71         if search:
  72                 authors = User.query \
  73                         .filter(or_(*[func.lower(User.username) == name.lower().strip() for name in search.split(" ")])) \
  74                         .all()
  75
  76                 authors = [(author.username, search.lower().replace(author.username.lower(), "")) for author in authors]
  77
  78         topics = None
  79         if qb.search and not query.has_next:
  80                 qb.show_discarded = True
  81                 topics = qb.buildTopicQuery().all()
  82
  83         tags = Tag.query.all()
  84         return render_template("packages/list.html", \
  85                         title=title, packages=query.items, topics=topics, \
  86                         query=search, tags=tags, type=type_name, \
  87                         authors=authors, packages_count=query.total, \
  88                         pagination=query)
  89
  90
  91 def getReleases(package):
  92         if package.checkPerm(current_user, Permission.MAKE_RELEASE):
  93                 return package.releases.limit(5)
  94         else:
  95                 return package.releases.filter_by(approved=True).limit(5)
  96
  97
  98 @bp.route("/packages/<author>/<name>/")
  99 @is_package_page
 100 def view(package):
 101         alternatives = None
 102         if package.type == PackageType.MOD:
 103                 alternatives = Package.query \
 104                         .filter_by(name=package.name, type=PackageType.MOD, soft_deleted=False) \
 105                         .filter(Package.id != package.id) \
 106                         .order_by(db.desc(Package.score)) \
 107                         .all()
 108
 109
 110         show_similar_topics = current_user == package.author or \
 111                         package.checkPerm(current_user, Permission.APPROVE_NEW)
 112
 113         similar_topics = None if not show_similar_topics else \
 114                         ForumTopic.query \
 115                                 .filter_by(name=package.name) \
 116                                 .filter(ForumTopic.topic_id != package.forums) \
 117                                 .filter(~ db.exists().where(Package.forums==ForumTopic.topic_id)) \
 118                                 .order_by(db.asc(ForumTopic.name), db.asc(ForumTopic.title)) \
 119                                 .all()
 120
 121         releases = getReleases(package)
 122         requests = [r for r in package.requests if r.status == 0]
 123
 124         review_thread = package.review_thread
 125         if review_thread is not None and not review_thread.checkPerm(current_user, Permission.SEE_THREAD):
 126                 review_thread = None
 127
 128         topic_error = None
 129         topic_error_lvl = "warning"
 130         if not package.approved and package.forums is not None:
 131                 errors = []
 132                 if Package.query.filter_by(forums=package.forums, soft_deleted=False).count() > 1:
 133                         errors.append("<b>Error: Another package already uses this forum topic!</b>")
 134                         topic_error_lvl = "danger"
 135
 136                 topic = ForumTopic.query.get(package.forums)
 137                 if topic is not None:
 138                         if topic.author != package.author:
 139                                 errors.append("<b>Error: Forum topic author doesn't match package author.</b>")
 140                                 topic_error_lvl = "danger"
 141
 142                         if topic.wip:
 143                                 errors.append("Warning: Forum topic is in WIP section, make sure package meets playability standards.")
 144                 elif package.type != PackageType.TXP:
 145                         errors.append("Warning: Forum topic not found. This may happen if the topic has only just been created.")
 146
 147                 topic_error = "<br />".join(errors)
 148
 149
 150         threads = Thread.query.filter_by(package_id=package.id, review_id=None)
 151         if not current_user.is_authenticated:
 152                 threads = threads.filter_by(private=False)
 153         elif not current_user.rank.atLeast(UserRank.EDITOR) and not current_user == package.author:
 154                 threads = threads.filter(or_(Thread.private == False, Thread.author == current_user))
 155
 156         has_review = current_user.is_authenticated and PackageReview.query.filter_by(package=package, author=current_user).count() > 0
 157
 158         return render_template("packages/view.html", \
 159                         package=package, releases=releases, requests=requests, \
 160                         alternatives=alternatives, similar_topics=similar_topics, \
 161                         review_thread=review_thread, topic_error=topic_error, topic_error_lvl=topic_error_lvl, \
 162                         threads=threads.all(), has_review=has_review)
 163
 164
 165 @bp.route("/packages/<author>/<name>/download/")
 166 @is_package_page
 167 def download(package):
 168         release = package.getDownloadRelease()
 169
 170         if release is None:
 171                 if "application/zip" in request.accept_mimetypes and \
 172                                 not "text/html" in request.accept_mimetypes:
 173                         return "", 204
 174                 else:
 175                         flash("No download available.", "danger")
 176                         return redirect(package.getDetailsURL())
 177         else:
 178                 return redirect(release.getDownloadURL(), code=302)
 179
 180
 181 class PackageForm(FlaskForm):
 182         name          = StringField("Name (Technical)", [InputRequired(), Length(1, 100), Regexp("^[a-z0-9_]+$", 0, "Lower case letters (a-z), digits (0-9), and underscores (_) only")])
 183         title         = StringField("Title (Human-readable)", [InputRequired(), Length(3, 100)])
 184         short_desc     = StringField("Short Description (Plaintext)", [InputRequired(), Length(1,200)])
 185         desc          = TextAreaField("Long Description (Markdown)", [Optional(), Length(0,10000)])
 186         type          = SelectField("Type", [InputRequired()], choices=PackageType.choices(), coerce=PackageType.coerce, default=PackageType.MOD)
 187         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)
 188         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)
 189         provides_str  = StringField("Provides (mods included in package)", [Optional()])
 190         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)
 191         harddep_str   = StringField("Hard Dependencies", [Optional()])
 192         softdep_str   = StringField("Soft Dependencies", [Optional()])
 193         repo          = StringField("VCS Repository URL", [Optional(), URL()], filters = [lambda x: x or None])
 194         website       = StringField("Website URL", [Optional(), URL()], filters = [lambda x: x or None])
 195         issueTracker  = StringField("Issue Tracker URL", [Optional(), URL()], filters = [lambda x: x or None])
 196         forums        = IntegerField("Forum Topic ID", [Optional(), NumberRange(0,999999)])
 197         submit        = SubmitField("Save")
 198
 199 @bp.route("/packages/new/", methods=["GET", "POST"])
 200 @bp.route("/packages/<author>/<name>/edit/", methods=["GET", "POST"])
 201 @login_required
 202 def create_edit(author=None, name=None):
 203         package = None
 204         form = None
 205         if author is None:
 206                 form = PackageForm(formdata=request.form)
 207                 author = request.args.get("author")
 208                 if author is None or author == current_user.username:
 209                         author = current_user
 210                 else:
 211                         author = User.query.filter_by(username=author).first()
 212                         if author is None:
 213                                 flash("Unable to find that user", "danger")
 214                                 return redirect(url_for("packages.create_edit"))
 215
 216                         if not author.checkPerm(current_user, Permission.CHANGE_AUTHOR):
 217                                 flash("Permission denied", "danger")
 218                                 return redirect(url_for("packages.create_edit"))
 219
 220         else:
 221                 package = getPackageByInfo(author, name)
 222                 if not package.checkPerm(current_user, Permission.EDIT_PACKAGE):
 223                         return redirect(package.getDetailsURL())
 224
 225                 author = package.author
 226
 227                 form = PackageForm(formdata=request.form, obj=package)
 228
 229         # Initial form class from post data and default data
 230         if request.method == "GET":
 231                 if package is None:
 232                         form.name.data   = request.args.get("bname")
 233                         form.title.data  = request.args.get("title")
 234                         form.repo.data   = request.args.get("repo")
 235                         form.forums.data = request.args.get("forums")
 236                         form.license.data = None
 237                         form.media_license.data = None
 238                 else:
 239                         form.harddep_str.data  = ",".join([str(x) for x in package.getSortedHardDependencies() ])
 240                         form.softdep_str.data  = ",".join([str(x) for x in package.getSortedOptionalDependencies() ])
 241                         form.provides_str.data = MetaPackage.ListToSpec(package.provides)
 242                         form.tags.data         = list(package.tags)
 243
 244         if request.method == "POST" and form.validate():
 245                 wasNew = False
 246                 if not package:
 247                         package = Package.query.filter_by(name=form["name"].data, author_id=author.id).first()
 248                         if package is not None:
 249                                 if package.soft_deleted:
 250                                         Package.query.filter_by(name=form["name"].data, author_id=author.id).delete()
 251                                 else:
 252                                         flash("Package already exists!", "danger")
 253                                         return redirect(url_for("packages.create_edit"))
 254
 255                         package = Package()
 256                         package.author = author
 257                         package.maintainers.append(author)
 258                         wasNew = True
 259
 260                 elif package.approved and package.name != form.name.data and \
 261                                 not package.checkPerm(current_user, Permission.CHANGE_NAME):
 262                         flash("Unable to change package name", "danger")
 263                         return redirect(url_for("packages.create_edit", author=author, name=name))
 264
 265                 else:
 266                         msg = "Edited {}".format(package.title)
 267
 268                         addNotification(package.maintainers, current_user,
 269                                         msg, package.getDetailsURL(), package)
 270
 271                         severity = AuditSeverity.NORMAL if current_user in package.maintainers else AuditSeverity.EDITOR
 272                         addAuditLog(severity, current_user, msg, package.getDetailsURL(), package)
 273
 274                 form.populate_obj(package) # copy to row
 275
 276                 if package.type== PackageType.TXP:
 277                         package.license = package.media_license
 278
 279                 mpackage_cache = {}
 280                 package.provides.clear()
 281                 mpackages = MetaPackage.SpecToList(form.provides_str.data, mpackage_cache)
 282                 for m in mpackages:
 283                         package.provides.append(m)
 284
 285                 Dependency.query.filter_by(depender=package).delete()
 286                 deps = Dependency.SpecToList(package, form.harddep_str.data, mpackage_cache)
 287                 for dep in deps:
 288                         dep.optional = False
 289                         db.session.add(dep)
 290
 291                 deps = Dependency.SpecToList(package, form.softdep_str.data, mpackage_cache)
 292                 for dep in deps:
 293                         dep.optional = True
 294                         db.session.add(dep)
 295
 296                 if wasNew and package.type == PackageType.MOD and not package.name in mpackage_cache:
 297                         m = MetaPackage.GetOrCreate(package.name, mpackage_cache)
 298                         package.provides.append(m)
 299
 300                 package.tags.clear()
 301                 for tag in form.tags.raw_data:
 302                         package.tags.append(Tag.query.get(tag))
 303
 304                 db.session.commit() # save
 305
 306                 next_url = package.getDetailsURL()
 307                 if wasNew and package.repo is not None:
 308                         task = importRepoScreenshot.delay(package.id)
 309                         next_url = url_for("tasks.check", id=task.id, r=next_url)
 310
 311                 if wasNew and ("WTFPL" in package.license.name or "WTFPL" in package.media_license.name):
 312                         next_url = url_for("flatpage", path="help/wtfpl", r=next_url)
 313
 314                 return redirect(next_url)
 315
 316         package_query = Package.query.filter_by(approved=True, soft_deleted=False)
 317         if package is not None:
 318                 package_query = package_query.filter(Package.id != package.id)
 319
 320         enableWizard = name is None and request.method != "POST"
 321         return render_template("packages/create_edit.html", package=package, \
 322                         form=form, author=author, enable_wizard=enableWizard, \
 323                         packages=package_query.all(), \
 324                         mpackages=MetaPackage.query.order_by(db.asc(MetaPackage.name)).all())
 325
 326 @bp.route("/packages/<author>/<name>/approve/", methods=["POST"])
 327 @login_required
 328 @is_package_page
 329 def approve(package):
 330         if not package.checkPerm(current_user, Permission.APPROVE_NEW):
 331                 flash("You don't have permission to do that.", "danger")
 332
 333         elif package.approved:
 334                 flash("Package has already been approved", "danger")
 335
 336         else:
 337                 package.approved = True
 338
 339                 screenshots = PackageScreenshot.query.filter_by(package=package, approved=False).all()
 340                 for s in screenshots:
 341                         s.approved = True
 342
 343                 msg = "Approved {}".format(package.title)
 344                 addNotification(package.maintainers, current_user, msg, package.getDetailsURL(), package)
 345                 severity = AuditSeverity.NORMAL if current_user == package.author else AuditSeverity.EDITOR
 346                 addAuditLog(severity, current_user, msg, package.getDetailsURL(), package)
 347                 db.session.commit()
 348
 349         return redirect(package.getDetailsURL())
 350
 351
 352 @bp.route("/packages/<author>/<name>/remove/", methods=["GET", "POST"])
 353 @login_required
 354 @is_package_page
 355 def remove(package):
 356         if request.method == "GET":
 357                 return render_template("packages/remove.html", package=package)
 358
 359         if "delete" in request.form:
 360                 if not package.checkPerm(current_user, Permission.DELETE_PACKAGE):
 361                         flash("You don't have permission to do that.", "danger")
 362                         return redirect(package.getDetailsURL())
 363
 364                 package.soft_deleted = True
 365
 366                 url = url_for("users.profile", username=package.author.username)
 367                 msg = "Deleted {}".format(package.title)
 368                 addNotification(package.maintainers, current_user, msg, url, package)
 369                 addAuditLog(AuditSeverity.EDITOR, current_user, msg, url)
 370                 db.session.commit()
 371
 372                 flash("Deleted package", "success")
 373
 374                 return redirect(url)
 375         elif "unapprove" in request.form:
 376                 if not package.checkPerm(current_user, Permission.UNAPPROVE_PACKAGE):
 377                         flash("You don't have permission to do that.", "danger")
 378                         return redirect(package.getDetailsURL())
 379
 380                 package.approved = False
 381
 382                 msg = "Unapproved {}".format(package.title)
 383                 addNotification(package.maintainers, current_user, msg, package.getDetailsURL(), package)
 384                 addAuditLog(AuditSeverity.EDITOR, current_user, msg, package.getDetailsURL(), package)
 385
 386                 db.session.commit()
 387
 388                 flash("Unapproved package", "success")
 389
 390                 return redirect(package.getDetailsURL())
 391         else:
 392                 abort(400)
 393
 394
 395
 396 class PackageMaintainersForm(FlaskForm):
 397         maintainers_str  = StringField("Maintainers (Comma-separated)", [Optional()])
 398         submit        = SubmitField("Save")
 399
 400
 401 @bp.route("/packages/<author>/<name>/edit-maintainers/", methods=["GET", "POST"])
 402 @login_required
 403 @is_package_page
 404 def edit_maintainers(package):
 405         if not package.checkPerm(current_user, Permission.EDIT_MAINTAINERS):
 406                 flash("You do not have permission to edit maintainers", "danger")
 407                 return redirect(package.getDetailsURL())
 408
 409         form = PackageMaintainersForm(formdata=request.form)
 410         if request.method == "GET":
 411                 form.maintainers_str.data = ", ".join([ x.username for x in package.maintainers if x != package.author ])
 412
 413         if request.method == "POST" and form.validate():
 414                 usernames = [x.strip().lower() for x in form.maintainers_str.data.split(",")]
 415                 users = User.query.filter(func.lower(User.username).in_(usernames)).all()
 416
 417                 for user in users:
 418                         if not user in package.maintainers:
 419                                 addNotification(user, current_user,
 420                                                 "Added you as a maintainer of {}".format(package.title), package.getDetailsURL(), package)
 421
 422                 for user in package.maintainers:
 423                         if user != package.author and not user in users:
 424                                 addNotification(user, current_user,
 425                                                 "Removed you as a maintainer of {}".format(package.title), package.getDetailsURL(), package)
 426
 427                 package.maintainers.clear()
 428                 package.maintainers.extend(users)
 429                 if package.author not in package.maintainers:
 430                         package.maintainers.append(package.author)
 431
 432                 msg = "Edited {} maintainers".format(package.title)
 433                 addNotification(package.author, current_user, msg, package.getDetailsURL(), package)
 434                 severity = AuditSeverity.NORMAL if current_user == package.author else AuditSeverity.MODERATION
 435                 addAuditLog(severity, current_user, msg, package.getDetailsURL(), package)
 436
 437                 db.session.commit()
 438
 439                 return redirect(package.getDetailsURL())
 440
 441         users = User.query.filter(User.rank >= UserRank.NEW_MEMBER).order_by(db.asc(User.username)).all()
 442
 443         return render_template("packages/edit_maintainers.html", \
 444                         package=package, form=form, users=users)
 445
 446
 447 @bp.route("/packages/<author>/<name>/remove-self-maintainer/", methods=["POST"])
 448 @login_required
 449 @is_package_page
 450 def remove_self_maintainers(package):
 451         if not current_user in package.maintainers:
 452                 flash("You are not a maintainer", "danger")
 453
 454         elif current_user == package.author:
 455                 flash("Package owners cannot remove themselves as maintainers", "danger")
 456
 457         else:
 458                 package.maintainers.remove(current_user)
 459
 460                 addNotification(package.author, current_user,
 461                                 "Removed themself as a maintainer of {}".format(package.title), package.getDetailsURL(), package)
 462
 463                 db.session.commit()
 464
 465         return redirect(package.getDetailsURL())
 466
 467
 468 @bp.route("/packages/<author>/<name>/import-meta/", methods=["POST"])
 469 @login_required
 470 @is_package_page
 471 def update_from_release(package):
 472         if not package.checkPerm(current_user, Permission.REIMPORT_META):
 473                 flash("You don't have permission to reimport meta", "danger")
 474                 return redirect(package.getDetailsURL())
 475
 476         release = package.releases.first()
 477         if not release:
 478                 flash("Release needed", "danger")
 479                 return redirect(package.getDetailsURL())
 480
 481         msg = "Updated meta from latest release"
 482         addNotification(package.maintainers, current_user,
 483                         msg, package.getDetailsURL(), package)
 484         severity = AuditSeverity.NORMAL if current_user in package.maintainers else AuditSeverity.EDITOR
 485         addAuditLog(severity, current_user, msg, package.getDetailsURL(), package)
 486
 487         db.session.commit()
 488
 489         task_id = uuid()
 490         zippath = release.url.replace("/uploads/", app.config["UPLOAD_DIR"])
 491         updateMetaFromRelease.apply_async((release.id, zippath), task_id=task_id)
 492
 493         return redirect(url_for("tasks.check", id=task_id, r=package.getEditURL()))