app/blueprints/packages/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 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
  27 from app.utils import *
  28
  29 from flask_wtf import FlaskForm
  30 from wtforms import *
  31 from wtforms.validators import *
  32 from wtforms.ext.sqlalchemy.fields import QuerySelectField, QuerySelectMultipleField
  33 from sqlalchemy import or_
  34
  35
  36 @menu.register_menu(bp, ".mods", "Mods", order=11, endpoint_arguments_constructor=lambda: { 'type': 'mod' })
  37 @menu.register_menu(bp, ".games", "Games", order=12, endpoint_arguments_constructor=lambda: { 'type': 'game' })
  38 @menu.register_menu(bp, ".txp", "Texture Packs", order=13, endpoint_arguments_constructor=lambda: { 'type': 'txp' })
  39 @menu.register_menu(bp, ".random", "Random", order=14, endpoint_arguments_constructor=lambda: { 'random': '1', 'lucky': '1' })
  40 @bp.route("/packages/")
  41 def list_all():
  42         qb    = QueryBuilder(request.args)
  43         query = qb.buildPackageQuery()
  44         title = qb.title
  45
  46         if qb.lucky:
  47                 package = query.first()
  48                 if package:
  49                         return redirect(package.getDetailsURL())
  50
  51                 topic = qb.buildTopicQuery().first()
  52                 if qb.search and topic:
  53                         return redirect("https://forum.minetest.net/viewtopic.php?t=" + str(topic.topic_id))
  54
  55         page  = get_int_or_abort(request.args.get("page"), 1)
  56         num   = min(40, get_int_or_abort(request.args.get("n"), 100))
  57         query = query.paginate(page, num, True)
  58
  59         search = request.args.get("q")
  60         type_name = request.args.get("type")
  61
  62         next_url = url_for("packages.list_all", type=type_name, q=search, page=query.next_num) \
  63                         if query.has_next else None
  64         prev_url = url_for("packages.list_all", type=type_name, q=search, page=query.prev_num) \
  65                         if query.has_prev else None
  66
  67         topics = None
  68         if qb.search and not query.has_next:
  69                 qb.show_discarded = True
  70                 topics = qb.buildTopicQuery().all()
  71
  72         tags = Tag.query.all()
  73         return render_template("packages/list.html", \
  74                         title=title, packages=query.items, topics=topics, \
  75                         query=search, tags=tags, type=type_name, \
  76                         next_url=next_url, prev_url=prev_url, page=page, page_max=query.pages, packages_count=query.total)
  77
  78
  79 def getReleases(package):
  80         if package.checkPerm(current_user, Permission.MAKE_RELEASE):
  81                 return package.releases.limit(5)
  82         else:
  83                 return package.releases.filter_by(approved=True).limit(5)
  84
  85
  86 @bp.route("/packages/<author>/<name>/")
  87 @is_package_page
  88 def view(package):
  89         clearNotifications(package.getDetailsURL())
  90
  91         alternatives = None
  92         if package.type == PackageType.MOD:
  93                 alternatives = Package.query \
  94                         .filter_by(name=package.name, type=PackageType.MOD, soft_deleted=False) \
  95                         .filter(Package.id != package.id) \
  96                         .order_by(db.desc(Package.score)) \
  97                         .all()
  98
  99
 100         show_similar_topics = current_user == package.author or \
 101                         package.checkPerm(current_user, Permission.APPROVE_NEW)
 102
 103         similar_topics = None if not show_similar_topics else \
 104                         ForumTopic.query \
 105                                 .filter_by(name=package.name) \
 106                                 .filter(ForumTopic.topic_id != package.forums) \
 107                                 .filter(~ db.exists().where(Package.forums==ForumTopic.topic_id)) \
 108                                 .order_by(db.asc(ForumTopic.name), db.asc(ForumTopic.title)) \
 109                                 .all()
 110
 111         releases = getReleases(package)
 112         requests = [r for r in package.requests if r.status == 0]
 113
 114         review_thread = package.review_thread
 115         if review_thread is not None and not review_thread.checkPerm(current_user, Permission.SEE_THREAD):
 116                 review_thread = None
 117
 118         topic_error = None
 119         topic_error_lvl = "warning"
 120         if not package.approved and package.forums is not None:
 121                 errors = []
 122                 if Package.query.filter_by(forums=package.forums, soft_deleted=False).count() > 1:
 123                         errors.append("<b>Error: Another package already uses this forum topic!</b>")
 124                         topic_error_lvl = "danger"
 125
 126                 topic = ForumTopic.query.get(package.forums)
 127                 if topic is not None:
 128                         if topic.author != package.author:
 129                                 errors.append("<b>Error: Forum topic author doesn't match package author.</b>")
 130                                 topic_error_lvl = "danger"
 131
 132                         if topic.wip:
 133                                 errors.append("Warning: Forum topic is in WIP section, make sure package meets playability standards.")
 134                 elif package.type != PackageType.TXP:
 135                         errors.append("Warning: Forum topic not found. This may happen if the topic has only just been created.")
 136
 137                 topic_error = "<br />".join(errors)
 138
 139
 140         threads = Thread.query.filter_by(package_id=package.id)
 141         if not current_user.is_authenticated:
 142                 threads = threads.filter_by(private=False)
 143         elif not current_user.rank.atLeast(UserRank.EDITOR) and not current_user == package.author:
 144                 threads = threads.filter(or_(Thread.private == False, Thread.author == current_user))
 145
 146
 147         return render_template("packages/view.html", \
 148                         package=package, releases=releases, requests=requests, \
 149                         alternatives=alternatives, similar_topics=similar_topics, \
 150                         review_thread=review_thread, topic_error=topic_error, topic_error_lvl=topic_error_lvl, \
 151                         threads=threads.all())
 152
 153
 154 @bp.route("/packages/<author>/<name>/download/")
 155 @is_package_page
 156 def download(package):
 157         release = package.getDownloadRelease()
 158
 159         if release is None:
 160                 if "application/zip" in request.accept_mimetypes and \
 161                                 not "text/html" in request.accept_mimetypes:
 162                         return "", 204
 163                 else:
 164                         flash("No download available.", "danger")
 165                         return redirect(package.getDetailsURL())
 166         else:
 167                 return redirect(release.getDownloadURL(), code=302)
 168
 169
 170 class PackageForm(FlaskForm):
 171         name          = StringField("Name (Technical)", [InputRequired(), Length(1, 20), Regexp("^[a-z0-9_]+$", 0, "Lower case letters (a-z), digits (0-9), and underscores (_) only")])
 172         title         = StringField("Title (Human-readable)", [InputRequired(), Length(3, 50)])
 173         short_desc     = StringField("Short Description (Plaintext)", [InputRequired(), Length(1,200)])
 174         desc          = TextAreaField("Long Description (Markdown)", [Optional(), Length(0,10000)])
 175         type          = SelectField("Type", [InputRequired()], choices=PackageType.choices(), coerce=PackageType.coerce, default=PackageType.MOD)
 176         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)
 177         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)
 178         provides_str  = StringField("Provides (mods included in package)", [Optional()])
 179         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)
 180         harddep_str   = StringField("Hard Dependencies", [Optional()])
 181         softdep_str   = StringField("Soft Dependencies", [Optional()])
 182         repo          = StringField("VCS Repository URL", [Optional(), URL()], filters = [lambda x: x or None])
 183         website       = StringField("Website URL", [Optional(), URL()], filters = [lambda x: x or None])
 184         issueTracker  = StringField("Issue Tracker URL", [Optional(), URL()], filters = [lambda x: x or None])
 185         forums        = IntegerField("Forum Topic ID", [Optional(), NumberRange(0,999999)])
 186         submit        = SubmitField("Save")
 187
 188 @bp.route("/packages/new/", methods=["GET", "POST"])
 189 @bp.route("/packages/<author>/<name>/edit/", methods=["GET", "POST"])
 190 @login_required
 191 def create_edit(author=None, name=None):
 192         package = None
 193         form = None
 194         if author is None:
 195                 form = PackageForm(formdata=request.form)
 196                 author = request.args.get("author")
 197                 if author is None or author == current_user.username:
 198                         author = current_user
 199                 else:
 200                         author = User.query.filter_by(username=author).first()
 201                         if author is None:
 202                                 flash("Unable to find that user", "danger")
 203                                 return redirect(url_for("packages.create_edit"))
 204
 205                         if not author.checkPerm(current_user, Permission.CHANGE_AUTHOR):
 206                                 flash("Permission denied", "danger")
 207                                 return redirect(url_for("packages.create_edit"))
 208
 209         else:
 210                 package = getPackageByInfo(author, name)
 211                 if not package.checkPerm(current_user, Permission.EDIT_PACKAGE):
 212                         return redirect(package.getDetailsURL())
 213
 214                 author = package.author
 215
 216                 form = PackageForm(formdata=request.form, obj=package)
 217
 218         # Initial form class from post data and default data
 219         if request.method == "GET":
 220                 if package is None:
 221                         form.name.data   = request.args.get("bname")
 222                         form.title.data  = request.args.get("title")
 223                         form.repo.data   = request.args.get("repo")
 224                         form.forums.data = request.args.get("forums")
 225                         form.license.data = None
 226                         form.media_license.data = None
 227                 else:
 228                         form.harddep_str.data  = ",".join([str(x) for x in package.getSortedHardDependencies() ])
 229                         form.softdep_str.data  = ",".join([str(x) for x in package.getSortedOptionalDependencies() ])
 230                         form.provides_str.data = MetaPackage.ListToSpec(package.provides)
 231
 232         if request.method == "POST" and form.validate():
 233                 wasNew = False
 234                 if not package:
 235                         package = Package.query.filter_by(name=form["name"].data, author_id=author.id).first()
 236                         if package is not None:
 237                                 if package.soft_deleted:
 238                                         Package.query.filter_by(name=form["name"].data, author_id=author.id).delete()
 239                                 else:
 240                                         flash("Package already exists!", "danger")
 241                                         return redirect(url_for("packages.create_edit"))
 242
 243                         package = Package()
 244                         package.author = author
 245                         wasNew = True
 246
 247                 elif package.approved and package.name != form.name.data and \
 248                                 not package.checkPerm(current_user, Permission.CHANGE_NAME):
 249                         flash("Unable to change package name", "danger")
 250                         return redirect(url_for("packages.create_edit", author=author, name=name))
 251
 252                 else:
 253                         triggerNotif(package.author, current_user,
 254                                         "{} edited".format(package.title), package.getDetailsURL())
 255
 256                 form.populate_obj(package) # copy to row
 257
 258                 if package.type== PackageType.TXP:
 259                         package.license = package.media_license
 260
 261                 mpackage_cache = {}
 262                 package.provides.clear()
 263                 mpackages = MetaPackage.SpecToList(form.provides_str.data, mpackage_cache)
 264                 for m in mpackages:
 265                         package.provides.append(m)
 266
 267                 Dependency.query.filter_by(depender=package).delete()
 268                 deps = Dependency.SpecToList(package, form.harddep_str.data, mpackage_cache)
 269                 for dep in deps:
 270                         dep.optional = False
 271                         db.session.add(dep)
 272
 273                 deps = Dependency.SpecToList(package, form.softdep_str.data, mpackage_cache)
 274                 for dep in deps:
 275                         dep.optional = True
 276                         db.session.add(dep)
 277
 278                 if wasNew and package.type == PackageType.MOD and not package.name in mpackage_cache:
 279                         m = MetaPackage.GetOrCreate(package.name, mpackage_cache)
 280                         package.provides.append(m)
 281
 282                 package.tags.clear()
 283                 for tag in form.tags.raw_data:
 284                         package.tags.append(Tag.query.get(tag))
 285
 286                 db.session.commit() # save
 287
 288                 next_url = package.getDetailsURL()
 289                 if wasNew and package.repo is not None:
 290                         task = importRepoScreenshot.delay(package.id)
 291                         next_url = url_for("tasks.check", id=task.id, r=next_url)
 292
 293                 if wasNew and ("WTFPL" in package.license.name or "WTFPL" in package.media_license.name):
 294                         next_url = url_for("flatpage", path="help/wtfpl", r=next_url)
 295
 296                 return redirect(next_url)
 297
 298         package_query = Package.query.filter_by(approved=True, soft_deleted=False)
 299         if package is not None:
 300                 package_query = package_query.filter(Package.id != package.id)
 301
 302         enableWizard = name is None and request.method != "POST"
 303         return render_template("packages/create_edit.html", package=package, \
 304                         form=form, author=author, enable_wizard=enableWizard, \
 305                         packages=package_query.all(), \
 306                         mpackages=MetaPackage.query.order_by(db.asc(MetaPackage.name)).all())
 307
 308 @bp.route("/packages/<author>/<name>/approve/", methods=["POST"])
 309 @login_required
 310 @is_package_page
 311 def approve(package):
 312         if not package.checkPerm(current_user, Permission.APPROVE_NEW):
 313                 flash("You don't have permission to do that.", "danger")
 314
 315         elif package.approved:
 316                 flash("Package has already been approved", "danger")
 317
 318         else:
 319                 package.approved = True
 320
 321                 screenshots = PackageScreenshot.query.filter_by(package=package, approved=False).all()
 322                 for s in screenshots:
 323                         s.approved = True
 324
 325                 triggerNotif(package.author, current_user,
 326                                 "{} approved".format(package.title), package.getDetailsURL())
 327                 db.session.commit()
 328
 329         return redirect(package.getDetailsURL())
 330
 331
 332 @bp.route("/packages/<author>/<name>/remove/", methods=["GET", "POST"])
 333 @login_required
 334 @is_package_page
 335 def remove(package):
 336         if request.method == "GET":
 337                 return render_template("packages/remove.html", package=package)
 338
 339         if "delete" in request.form:
 340                 if not package.checkPerm(current_user, Permission.DELETE_PACKAGE):
 341                         flash("You don't have permission to do that.", "danger")
 342                         return redirect(package.getDetailsURL())
 343
 344                 package.soft_deleted = True
 345
 346                 url = url_for("users.profile", username=package.author.username)
 347                 triggerNotif(package.author, current_user,
 348                                 "{} deleted".format(package.title), url)
 349                 db.session.commit()
 350
 351                 flash("Deleted package", "success")
 352
 353                 return redirect(url)
 354         elif "unapprove" in request.form:
 355                 if not package.checkPerm(current_user, Permission.UNAPPROVE_PACKAGE):
 356                         flash("You don't have permission to do that.", "danger")
 357                         return redirect(package.getDetailsURL())
 358
 359                 package.approved = False
 360
 361                 triggerNotif(package.author, current_user,
 362                                 "{} deleted".format(package.title), package.getDetailsURL())
 363                 db.session.commit()
 364
 365                 flash("Unapproved package", "success")
 366
 367                 return redirect(package.getDetailsURL())
 368         else:
 369                 abort(400)