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