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