app/views/packages.py

   1 # Content DB
   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 *
  19 from flask_user import *
  20 from flask.ext import menu
  21 from app import app
  22 from app.models import *
  23 from app.tasks.importtasks import importRepoScreenshot, makeVCSRelease
  24
  25 from app.utils import *
  26
  27 from celery import uuid
  28 from urllib.parse import urlparse
  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
  34
  35 # TODO: the following could be made into one route, except I"m not sure how
  36 # to do the menu
  37
  38 @menu.register_menu(app, ".mods", "Mods", order=11, endpoint_arguments_constructor=lambda: { 'type': 'mod' })
  39 @menu.register_menu(app, ".games", "Games", order=12, endpoint_arguments_constructor=lambda: { 'type': 'game' })
  40 @menu.register_menu(app, ".txp", "Texture Packs", order=13, endpoint_arguments_constructor=lambda: { 'type': 'txp' })
  41 @app.route("/packages/")
  42 def packages_page():
  43         type = request.args.get("type")
  44         if type is not None:
  45                 type = PackageType[type.upper()]
  46
  47         title = "Packages"
  48         query = Package.query
  49
  50         if type is not None:
  51                 title = type.value + "s"
  52                 query = query.filter_by(type=type, approved=True)
  53
  54         search = request.args.get("q")
  55         if search is not None:
  56                 query = query.filter(Package.title.contains(search))
  57
  58         if shouldReturnJson():
  59                 pkgs = [package.getAsDictionary(app.config["BASE_URL"]) \
  60                                 for package in query.all() if package.getDownloadRelease() is not None]
  61                 return jsonify(pkgs)
  62         else:
  63                 tags = Tag.query.all()
  64                 return render_template("packages/list.html", title=title, packages=query.all(), \
  65                                 query=search, tags=tags, type=None if type is None else type.toName())
  66
  67 @app.route("/todo/")
  68 @login_required
  69 def todo_page():
  70         canApproveNew = Permission.APPROVE_NEW.check(current_user)
  71         canApproveRel = Permission.APPROVE_RELEASE.check(current_user)
  72
  73         packages = None
  74         if canApproveNew:
  75                 packages = Package.query.filter_by(approved=False).all()
  76
  77         releases = None
  78         if canApproveRel:
  79                 releases = PackageRelease.query.filter_by(approved=False).all()
  80
  81         return render_template("todo.html", title="Reports and Work Queue",
  82                 approve_new=packages, releases=releases,
  83                 canApproveNew=canApproveNew, canApproveRel=canApproveRel)
  84
  85 def getReleases(package):
  86         if package.checkPerm(current_user, Permission.MAKE_RELEASE):
  87                 return package.releases
  88         else:
  89                 return [rel for rel in package.releases if rel.approved]
  90
  91
  92 @app.route("/packages/<author>/<name>/")
  93 @is_package_page
  94 def package_page(package):
  95         if shouldReturnJson():
  96                 return jsonify(package.getAsDictionary(app.config["BASE_URL"]))
  97         else:
  98                 clearNotifications(package.getDetailsURL())
  99
 100                 releases = getReleases(package)
 101                 requests = [r for r in package.requests if r.status == 0]
 102                 return render_template("packages/view.html", package=package, releases=releases, requests=requests)
 103
 104
 105 @app.route("/packages/<author>/<name>/download/")
 106 @is_package_page
 107 def package_download_page(package):
 108         release = package.getDownloadRelease()
 109
 110         if release is None:
 111                 if "application/zip" in request.accept_mimetypes and \
 112                                 not "text/html" in request.accept_mimetypes:
 113                         return "", 204
 114                 else:
 115                         flash("No download available.", "error")
 116                         return redirect(package.getDetailsURL())
 117         else:
 118                 return redirect(release.url, code=302)
 119
 120
 121 class PackageForm(FlaskForm):
 122         name          = StringField("Name", [InputRequired(), Length(1, 20), Regexp("^[a-z0-9_]", 0, "Lower case letters (a-z), digits (0-9), and underscores (_) only")])
 123         title         = StringField("Title", [InputRequired(), Length(3, 50)])
 124         shortDesc     = StringField("Short Description", [InputRequired(), Length(1,200)])
 125         desc          = TextAreaField("Long Description", [Optional(), Length(0,10000)])
 126         type          = SelectField("Type", [InputRequired()], choices=PackageType.choices(), coerce=PackageType.coerce, default=PackageType.MOD)
 127         license       = QuerySelectField("License", [InputRequired()], query_factory=lambda: License.query, get_pk=lambda a: a.id, get_label=lambda a: a.name)
 128         tags          = QuerySelectMultipleField('Tags', query_factory=lambda: Tag.query, get_pk=lambda a: a.id, get_label=lambda a: a.title)
 129         harddeps      = QuerySelectMultipleField('Dependencies', query_factory=lambda: Package.query, get_pk=lambda a: a.id, get_label=lambda a: a.title + " by " + a.author.display_name)
 130         softdeps      = QuerySelectMultipleField('Soft Dependencies', query_factory=lambda: Package.query, get_pk=lambda a: a.id, get_label=lambda a: a.title + " by " + a.author.display_name)
 131         repo          = StringField("Repo URL", [Optional(), URL()])
 132         website       = StringField("Website URL", [Optional(), URL()])
 133         issueTracker  = StringField("Issue Tracker URL", [Optional(), URL()])
 134         forums        = IntegerField("Forum Topic ID", [Optional(), NumberRange(0,999999)])
 135         submit        = SubmitField("Save")
 136
 137 @app.route("/packages/new/", methods=["GET", "POST"])
 138 @app.route("/packages/<author>/<name>/edit/", methods=["GET", "POST"])
 139 @login_required
 140 def create_edit_package_page(author=None, name=None):
 141         package = None
 142         form = None
 143         if author is None:
 144                 form = PackageForm(formdata=request.form)
 145                 author = request.args.get("author")
 146                 if author is None or author == current_user.username:
 147                         author = current_user
 148                 else:
 149                         author = User.query.filter_by(username=author).first()
 150                         if author is None:
 151                                 flash("Unable to find that user", "error")
 152                                 return redirect(url_for("create_edit_package_page"))
 153
 154                         if not author.checkPerm(current_user, Permission.CHANGE_AUTHOR):
 155                                 flash("Permission denied", "error")
 156                                 return redirect(url_for("create_edit_package_page"))
 157
 158         else:
 159                 package = getPackageByInfo(author, name)
 160                 if not package.checkPerm(current_user, Permission.EDIT_PACKAGE):
 161                         return redirect(package.getDetailsURL())
 162
 163                 author = package.author
 164
 165                 form = PackageForm(formdata=request.form, obj=package)
 166
 167         # Initial form class from post data and default data
 168         if request.method == "POST" and form.validate():
 169                 wasNew = False
 170                 if not package:
 171                         package = Package()
 172                         package.author = author
 173                         wasNew = True
 174                 else:
 175                         triggerNotif(package.author, current_user,
 176                                         "{} edited".format(package.title), package.getDetailsURL())
 177
 178                 form.populate_obj(package) # copy to row
 179
 180                 package.tags.clear()
 181                 for tag in form.tags.raw_data:
 182                         package.tags.append(Tag.query.get(tag))
 183
 184                 db.session.commit() # save
 185
 186                 if wasNew:
 187                         url = urlparse(package.repo)
 188                         if url.netloc == "github.com":
 189                                 task = importRepoScreenshot.delay(package.id)
 190                                 return redirect(url_for("check_task", id=task.id, r=package.getDetailsURL()))
 191
 192                 return redirect(package.getDetailsURL())
 193
 194         return render_template("packages/create_edit.html", package=package, form=form, author=author)
 195
 196 @app.route("/packages/<author>/<name>/approve/", methods=["POST"])
 197 @login_required
 198 @is_package_page
 199 def approve_package_page(package):
 200         if not package.checkPerm(current_user, Permission.APPROVE_NEW):
 201                 flash("You don't have permission to do that.", "error")
 202
 203         elif package.approved:
 204                 flash("Package has already been approved", "error")
 205
 206         else:
 207                 package.approved = True
 208
 209                 triggerNotif(package.author, current_user,
 210                                 "{} approved".format(package.title), package.getDetailsURL())
 211                 db.session.commit()
 212
 213         return redirect(package.getDetailsURL())
 214
 215 class CreateScreenshotForm(FlaskForm):
 216         title      = StringField("Title/Caption", [Optional()])
 217         fileUpload = FileField("File Upload", [InputRequired()])
 218         submit     = SubmitField("Save")
 219
 220 @app.route("/packages/<author>/<name>/screenshots/new/", methods=["GET", "POST"])
 221 @login_required
 222 @is_package_page
 223 def create_screenshot_page(package):
 224         if not package.checkPerm(current_user, Permission.MAKE_RELEASE):
 225                 return redirect(package.getDetailsURL())
 226
 227         # Initial form class from post data and default data
 228         form = CreateScreenshotForm()
 229         if request.method == "POST" and form.validate():
 230                 uploadedPath = doFileUpload(form.fileUpload.data, ["png", "jpg", "jpeg"],
 231                                 "a PNG or JPG image file")
 232                 if uploadedPath is not None:
 233                         ss = PackageScreenshot()
 234                         ss.package = package
 235                         ss.title   = form["title"].data
 236                         ss.url     = uploadedPath
 237                         db.session.add(ss)
 238
 239                         msg = "{}: Screenshot added {}" \
 240                                         .format(package.title, ss.title)
 241                         triggerNotif(package.author, current_user, msg, package.getDetailsURL())
 242                         db.session.commit()
 243                         return redirect(package.getDetailsURL())
 244
 245         return render_template("packages/screenshot_new.html", package=package, form=form)
 246
 247
 248 class EditRequestForm(PackageForm):
 249         edit_title = StringField("Edit Title", [InputRequired(), Length(1, 100)])
 250         edit_desc  = TextField("Edit Description", [Optional()])
 251
 252 @app.route("/packages/<author>/<name>/requests/new/", methods=["GET","POST"])
 253 @app.route("/packages/<author>/<name>/requests/<id>/edit/", methods=["GET","POST"])
 254 @login_required
 255 @is_package_page
 256 def create_edit_editrequest_page(package, id=None):
 257         edited_package = package
 258
 259         erequest = None
 260         if id is not None:
 261                 erequest = EditRequest.query.get(id)
 262                 if erequest.package != package:
 263                         abort(404)
 264
 265                 from copy import copy
 266                 edited_package = copy(package)
 267                 erequest.applyAll(edited_package)
 268
 269                 if not erequest.checkPerm(current_user, Permission.EDIT_EDITREQUEST):
 270                         abort(403)
 271
 272                 if erequest.status != 0:
 273                         flash("Can't edit EditRequest, it has already been merged or rejected", "error")
 274                         return redirect(erequest.getURL())
 275
 276
 277         form = EditRequestForm(request.form, obj=edited_package)
 278         if request.method == "POST" and form.validate():
 279                 if erequest is None:
 280                         erequest = EditRequest()
 281                         erequest.package = package
 282                         erequest.author  = current_user
 283
 284                 erequest.title   = form["edit_title"].data
 285                 erequest.desc    = form["edit_desc"].data
 286                 db.session.add(erequest)
 287
 288                 EditRequestChange.query.filter_by(request=erequest).delete()
 289
 290                 wasChangeMade = False
 291                 for e in PackagePropertyKey:
 292                         newValue = form[e.name].data
 293                         oldValue = getattr(package, e.name)
 294
 295                         newValueComp = newValue
 296                         oldValueComp = oldValue
 297                         if type(newValue) is str:
 298                                 newValue = newValue.replace("\r\n", "\n")
 299                                 newValueComp = newValue.strip()
 300                                 oldValueComp = "" if oldValue is None else oldValue.strip()
 301
 302                         if newValueComp != oldValueComp:
 303                                 change = EditRequestChange()
 304                                 change.request = erequest
 305                                 change.key = e
 306                                 change.oldValue = e.convert(oldValue)
 307                                 change.newValue = e.convert(newValue)
 308                                 db.session.add(change)
 309                                 wasChangeMade = True
 310
 311                 if wasChangeMade:
 312                         msg = "{}: Edit request #{} {}" \
 313                                         .format(package.title, erequest.id, "created" if id is None else "edited")
 314                         triggerNotif(package.author, current_user, msg, erequest.getURL())
 315                         triggerNotif(erequest.author, current_user, msg, erequest.getURL())
 316                         db.session.commit()
 317                         return redirect(erequest.getURL())
 318                 else:
 319                         flash("No changes detected", "warning")
 320         elif erequest is not None:
 321                 form["edit_title"].data = erequest.title
 322                 form["edit_desc"].data  = erequest.desc
 323
 324         return render_template("packages/editrequest_create_edit.html", package=package, form=form)
 325
 326
 327 @app.route("/packages/<author>/<name>/requests/<id>/")
 328 @is_package_page
 329 def view_editrequest_page(package, id):
 330         erequest = EditRequest.query.get(id)
 331         if erequest is None or erequest.package != package:
 332                 abort(404)
 333
 334         clearNotifications(erequest.getURL())
 335         return render_template("packages/editrequest_view.html", package=package, request=erequest)
 336
 337
 338 @app.route("/packages/<author>/<name>/requests/<id>/approve/", methods=["POST"])
 339 @is_package_page
 340 def approve_editrequest_page(package, id):
 341         if not package.checkPerm(current_user, Permission.APPROVE_CHANGES):
 342                 flash("You don't have permission to do that.", "error")
 343                 return redirect(package.getDetailsURL())
 344
 345         erequest = EditRequest.query.get(id)
 346         if erequest is None or erequest.package != package:
 347                 abort(404)
 348
 349         if erequest.status != 0:
 350                 flash("Edit request has already been resolved", "error")
 351
 352         else:
 353                 erequest.status = 1
 354                 erequest.applyAll(package)
 355
 356                 msg = "{}: Edit request #{} merged".format(package.title, erequest.id)
 357                 triggerNotif(erequest.author, current_user, msg, erequest.getURL())
 358                 triggerNotif(package.author, current_user, msg, erequest.getURL())
 359                 db.session.commit()
 360
 361         return redirect(package.getDetailsURL())
 362
 363 @app.route("/packages/<author>/<name>/requests/<id>/reject/", methods=["POST"])
 364 @is_package_page
 365 def reject_editrequest_page(package, id):
 366         if not package.checkPerm(current_user, Permission.APPROVE_CHANGES):
 367                 flash("You don't have permission to do that.", "error")
 368                 return redirect(package.getDetailsURL())
 369
 370         erequest = EditRequest.query.get(id)
 371         if erequest is None or erequest.package != package:
 372                 abort(404)
 373
 374         if erequest.status != 0:
 375                 flash("Edit request has already been resolved", "error")
 376
 377         else:
 378                 erequest.status = 2
 379
 380                 msg = "{}: Edit request #{} rejected".format(package.title, erequest.id)
 381                 triggerNotif(erequest.author, current_user, msg, erequest.getURL())
 382                 triggerNotif(package.author, current_user, msg, erequest.getURL())
 383                 db.session.commit()
 384
 385         return redirect(package.getDetailsURL())
 386
 387
 388 class CreatePackageReleaseForm(FlaskForm):
 389         name       = StringField("Name")
 390         title      = StringField("Title")
 391         uploadOpt  = RadioField ("File", choices=[("vcs", "From VCS Commit or Branch"), ("upload", "File Upload")])
 392         vcsLabel   = StringField("VCS Commit or Branch", default="master")
 393         fileUpload = FileField("File Upload")
 394         submit     = SubmitField("Save")
 395
 396 class EditPackageReleaseForm(FlaskForm):
 397         name     = StringField("Name")
 398         title    = StringField("Title")
 399         url      = StringField("URL", [URL])
 400         task_id  = StringField("Task ID")
 401         approved = BooleanField("Is Approved")
 402         submit   = SubmitField("Save")
 403
 404 @app.route("/packages/<author>/<name>/releases/new/", methods=["GET", "POST"])
 405 @login_required
 406 @is_package_page
 407 def create_release_page(package):
 408         if not package.checkPerm(current_user, Permission.MAKE_RELEASE):
 409                 return redirect(package.getDetailsURL())
 410
 411         # Initial form class from post data and default data
 412         form = CreatePackageReleaseForm()
 413         if request.method == "POST" and form.validate():
 414                 if form["uploadOpt"].data == "vcs":
 415                         rel = PackageRelease()
 416                         rel.package = package
 417                         rel.title   = form["title"].data
 418                         rel.url     = ""
 419                         rel.task_id = uuid()
 420                         db.session.commit()
 421
 422                         makeVCSRelease.apply_async((rel.id, form["vcsLabel"].data), task_id=rel.task_id)
 423
 424                         msg = "{}: Release {} created".format(package.title, rel.title)
 425                         triggerNotif(package.author, current_user, msg, rel.getEditURL())
 426                         db.session.commit()
 427
 428                         return redirect(url_for("check_task", id=rel.task_id, r=rel.getEditURL()))
 429                 else:
 430                         uploadedPath = doFileUpload(form.fileUpload.data, ["zip"], "a zip file")
 431                         if uploadedPath is not None:
 432                                 rel = PackageRelease()
 433                                 rel.package = package
 434                                 rel.title = form["title"].data
 435                                 rel.url = uploadedPath
 436                                 db.session.add(rel)
 437
 438                                 msg = "{}: Release {} created".format(package.title, rel.title)
 439                                 triggerNotif(package.author, current_user, msg, rel.getEditURL())
 440                                 db.session.commit()
 441                                 return redirect(package.getDetailsURL())
 442
 443         return render_template("packages/release_new.html", package=package, form=form)
 444
 445 @app.route("/packages/<author>/<name>/releases/<id>/", methods=["GET", "POST"])
 446 @login_required
 447 @is_package_page
 448 def edit_release_page(package, id):
 449         release = PackageRelease.query.get(id)
 450         if release is None or release.package != package:
 451                 abort(404)
 452
 453         clearNotifications(release.getEditURL())
 454
 455         canEdit = package.checkPerm(current_user, Permission.MAKE_RELEASE)
 456         canApprove = package.checkPerm(current_user, Permission.APPROVE_RELEASE)
 457         if not (canEdit or canApprove):
 458                 return redirect(package.getDetailsURL())
 459
 460         # Initial form class from post data and default data
 461         form = EditPackageReleaseForm(formdata=request.form, obj=release)
 462         if request.method == "POST" and form.validate():
 463                 wasApproved = release.approved
 464                 if canEdit:
 465                         release.title = form["title"].data
 466
 467                 if package.checkPerm(current_user, Permission.CHANGE_RELEASE_URL):
 468                         release.url = form["url"].data
 469                         release.task_id = form["task_id"].data
 470                         if release.task_id.strip() == "":
 471                                 release.task_id = None
 472
 473                 if canApprove:
 474                         release.approved = form["approved"].data
 475                 else:
 476                         release.approved = wasApproved
 477
 478                 db.session.commit()
 479                 return redirect(package.getDetailsURL())
 480
 481         return render_template("packages/release_edit.html", package=package, release=release, form=form)