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