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