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