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