app/models.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 Flask, url_for
  19 from flask_sqlalchemy import SQLAlchemy
  20 from flask_migrate import Migrate
  21 from urllib.parse import urlparse
  22 from app import app, gravatar
  23 from sqlalchemy.orm import validates
  24 from flask_user import login_required, UserManager, UserMixin, SQLAlchemyAdapter
  25 import enum, datetime
  26
  27 # Initialise database
  28 db = SQLAlchemy(app)
  29 migrate = Migrate(app, db)
  30
  31
  32 class UserRank(enum.Enum):
  33         BANNED         = 0
  34         NOT_JOINED     = 1
  35         NEW_MEMBER     = 2
  36         MEMBER         = 3
  37         TRUSTED_MEMBER = 4
  38         EDITOR         = 5
  39         MODERATOR      = 6
  40         ADMIN          = 7
  41
  42         def atLeast(self, min):
  43                 return self.value >= min.value
  44
  45         def getTitle(self):
  46                 return self.name.replace("_", " ").title()
  47
  48         def toName(self):
  49                 return self.name.lower()
  50
  51         def __str__(self):
  52                 return self.name
  53
  54         @classmethod
  55         def choices(cls):
  56                 return [(choice, choice.getTitle()) for choice in cls]
  57
  58         @classmethod
  59         def coerce(cls, item):
  60                 return item if type(item) == UserRank else UserRank[item]
  61
  62
  63 class Permission(enum.Enum):
  64         EDIT_PACKAGE       = "EDIT_PACKAGE"
  65         APPROVE_CHANGES    = "APPROVE_CHANGES"
  66         DELETE_PACKAGE     = "DELETE_PACKAGE"
  67         CHANGE_AUTHOR      = "CHANGE_AUTHOR"
  68         MAKE_RELEASE       = "MAKE_RELEASE"
  69         ADD_SCREENSHOTS    = "ADD_SCREENSHOTS"
  70         APPROVE_SCREENSHOT = "APPROVE_SCREENSHOT"
  71         APPROVE_RELEASE    = "APPROVE_RELEASE"
  72         APPROVE_NEW        = "APPROVE_NEW"
  73         CHANGE_RELEASE_URL = "CHANGE_RELEASE_URL"
  74         CHANGE_DNAME       = "CHANGE_DNAME"
  75         CHANGE_RANK        = "CHANGE_RANK"
  76         CHANGE_EMAIL       = "CHANGE_EMAIL"
  77         EDIT_EDITREQUEST   = "EDIT_EDITREQUEST"
  78         SEE_THREAD         = "SEE_THREAD"
  79         CREATE_THREAD      = "CREATE_THREAD"
  80         UNAPPROVE_PACKAGE  = "UNAPPROVE_PACKAGE"
  81         TOPIC_DISCARD      = "TOPIC_DISCARD"
  82
  83         # Only return true if the permission is valid for *all* contexts
  84         # See Package.checkPerm for package-specific contexts
  85         def check(self, user):
  86                 if not user.is_authenticated:
  87                         return False
  88
  89                 if self == Permission.APPROVE_NEW or \
  90                                 self == Permission.APPROVE_CHANGES    or \
  91                                 self == Permission.APPROVE_RELEASE    or \
  92                                 self == Permission.APPROVE_SCREENSHOT or \
  93                                 self == Permission.SEE_THREAD:
  94                         return user.rank.atLeast(UserRank.EDITOR)
  95                 else:
  96                         raise Exception("Non-global permission checked globally. Use Package.checkPerm or User.checkPerm instead.")
  97
  98 class User(db.Model, UserMixin):
  99         id           = db.Column(db.Integer, primary_key=True)
 100
 101         # User authentication information
 102         username     = db.Column(db.String(50, collation="NOCASE"), nullable=False, unique=True, index=True)
 103         password     = db.Column(db.String(255), nullable=True)
 104         reset_password_token = db.Column(db.String(100), nullable=False, server_default="")
 105
 106         rank         = db.Column(db.Enum(UserRank))
 107
 108         # Account linking
 109         github_username = db.Column(db.String(50, collation="NOCASE"), nullable=True, unique=True)
 110         forums_username = db.Column(db.String(50, collation="NOCASE"), nullable=True, unique=True)
 111
 112         # User email information
 113         email         = db.Column(db.String(255), nullable=True, unique=True)
 114         confirmed_at  = db.Column(db.DateTime())
 115
 116         # User information
 117         profile_pic   = db.Column(db.String(255), nullable=True, server_default=None)
 118         active        = db.Column("is_active", db.Boolean, nullable=False, server_default="0")
 119         display_name  = db.Column(db.String(100), nullable=False, server_default="")
 120
 121         # Content
 122         notifications = db.relationship("Notification", primaryjoin="User.id==Notification.user_id")
 123
 124         # causednotifs  = db.relationship("Notification", backref="causer", lazy="dynamic")
 125         packages      = db.relationship("Package", backref="author", lazy="dynamic")
 126         requests      = db.relationship("EditRequest", backref="author", lazy="dynamic")
 127         threads       = db.relationship("Thread", backref="author", lazy="dynamic")
 128         replies       = db.relationship("ThreadReply", backref="author", lazy="dynamic")
 129
 130         def __init__(self, username, active=False, email=None, password=None):
 131                 self.username = username
 132                 self.confirmed_at = datetime.datetime.now() - datetime.timedelta(days=6000)
 133                 self.display_name = username
 134                 self.active = active
 135                 self.email = email
 136                 self.password = password
 137                 self.rank = UserRank.NOT_JOINED
 138
 139         def canAccessTodoList(self):
 140                 return Permission.APPROVE_NEW.check(self) or \
 141                                 Permission.APPROVE_RELEASE.check(self) or \
 142                                 Permission.APPROVE_CHANGES.check(self)
 143
 144         def isClaimed(self):
 145                 return self.rank.atLeast(UserRank.NEW_MEMBER)
 146
 147         def getProfilePicURL(self):
 148                 if self.profile_pic:
 149                         return self.profile_pic
 150                 else:
 151                         return gravatar(self.email or "")
 152
 153         def checkPerm(self, user, perm):
 154                 if not user.is_authenticated:
 155                         return False
 156
 157                 if type(perm) == str:
 158                         perm = Permission[perm]
 159                 elif type(perm) != Permission:
 160                         raise Exception("Unknown permission given to User.checkPerm()")
 161
 162                 # Members can edit their own packages, and editors can edit any packages
 163                 if perm == Permission.CHANGE_AUTHOR:
 164                         return user.rank.atLeast(UserRank.EDITOR)
 165                 elif perm == Permission.CHANGE_RANK or perm == Permission.CHANGE_DNAME:
 166                         return user.rank.atLeast(UserRank.MODERATOR)
 167                 elif perm == Permission.CHANGE_EMAIL:
 168                         return user == self or (user.rank.atLeast(UserRank.MODERATOR) and user.rank.atLeast(self.rank))
 169                 else:
 170                         raise Exception("Permission {} is not related to users".format(perm.name))
 171
 172         def canCommentRL(self):
 173                 hour_ago = datetime.datetime.utcnow() - datetime.timedelta(hours=1)
 174                 return ThreadReply.query.filter_by(author=self) \
 175                         .filter(ThreadReply.created_at > hour_ago).count() < 4
 176
 177         def canOpenThreadRL(self):
 178                 hour_ago = datetime.datetime.utcnow() - datetime.timedelta(hours=1)
 179                 return Thread.query.filter_by(author=self) \
 180                         .filter(Thread.created_at > hour_ago).count() < 2
 181
 182 class UserEmailVerification(db.Model):
 183         id      = db.Column(db.Integer, primary_key=True)
 184         user_id = db.Column(db.Integer, db.ForeignKey("user.id"))
 185         email   = db.Column(db.String(100))
 186         token   = db.Column(db.String(32))
 187         user    = db.relationship("User", foreign_keys=[user_id])
 188
 189 class Notification(db.Model):
 190         id        = db.Column(db.Integer, primary_key=True)
 191         user_id   = db.Column(db.Integer, db.ForeignKey("user.id"))
 192         causer_id = db.Column(db.Integer, db.ForeignKey("user.id"))
 193         user      = db.relationship("User", foreign_keys=[user_id])
 194         causer    = db.relationship("User", foreign_keys=[causer_id])
 195
 196         title     = db.Column(db.String(100), nullable=False)
 197         url       = db.Column(db.String(200), nullable=True)
 198
 199         def __init__(self, us, cau, titl, ur):
 200                 self.user   = us
 201                 self.causer = cau
 202                 self.title  = titl
 203                 self.url    = ur
 204
 205
 206 class License(db.Model):
 207         id      = db.Column(db.Integer, primary_key=True)
 208         name    = db.Column(db.String(50), nullable=False, unique=True)
 209         is_foss = db.Column(db.Boolean,    nullable=False, default=True)
 210
 211         def __init__(self, v, is_foss=True):
 212                 self.name = v
 213                 self.is_foss = is_foss
 214
 215         def __str__(self):
 216                 return self.name
 217
 218
 219 class PackageType(enum.Enum):
 220         MOD  = "Mod"
 221         GAME = "Game"
 222         TXP  = "Texture Pack"
 223
 224         def toName(self):
 225                 return self.name.lower()
 226
 227         def __str__(self):
 228                 return self.name
 229
 230         @classmethod
 231         def get(cls, name):
 232                 try:
 233                         return PackageType[name.upper()]
 234                 except KeyError:
 235                         return None
 236
 237         @classmethod
 238         def choices(cls):
 239                 return [(choice, choice.value) for choice in cls]
 240
 241         @classmethod
 242         def coerce(cls, item):
 243                 return item if type(item) == PackageType else PackageType[item]
 244
 245
 246 class PackagePropertyKey(enum.Enum):
 247         name          = "Name"
 248         title         = "Title"
 249         shortDesc     = "Short Description"
 250         desc          = "Description"
 251         type          = "Type"
 252         license       = "License"
 253         media_license = "Media License"
 254         tags          = "Tags"
 255         provides      = "Provides"
 256         repo          = "Repository"
 257         website       = "Website"
 258         issueTracker  = "Issue Tracker"
 259         forums        = "Forum Topic ID"
 260
 261         def convert(self, value):
 262                 if self == PackagePropertyKey.tags:
 263                         return ",".join([t.title for t in value])
 264                 elif self == PackagePropertyKey.provides:
 265                         return ",".join([t.name for t in value])
 266                 else:
 267                         return str(value)
 268
 269 provides = db.Table("provides",
 270         db.Column("package_id",    db.Integer, db.ForeignKey("package.id"), primary_key=True),
 271     db.Column("metapackage_id", db.Integer, db.ForeignKey("meta_package.id"), primary_key=True)
 272 )
 273
 274 tags = db.Table("tags",
 275     db.Column("tag_id", db.Integer, db.ForeignKey("tag.id"), primary_key=True),
 276     db.Column("package_id", db.Integer, db.ForeignKey("package.id"), primary_key=True)
 277 )
 278
 279 class Dependency(db.Model):
 280         id              = db.Column(db.Integer, primary_key=True)
 281         depender_id     = db.Column(db.Integer, db.ForeignKey("package.id"),     nullable=True)
 282         package_id      = db.Column(db.Integer, db.ForeignKey("package.id"),     nullable=True)
 283         package         = db.relationship("Package", foreign_keys=[package_id])
 284         meta_package_id = db.Column(db.Integer, db.ForeignKey("meta_package.id"), nullable=True)
 285         optional        = db.Column(db.Boolean, nullable=False, default=False)
 286         __table_args__  = (db.UniqueConstraint('depender_id', 'package_id', 'meta_package_id', name='_dependency_uc'), )
 287
 288         def __init__(self, depender=None, package=None, meta=None):
 289                 if depender is None:
 290                         return
 291
 292                 self.depender = depender
 293
 294                 packageProvided = package is not None
 295                 metaProvided = meta is not None
 296
 297                 if packageProvided and not metaProvided:
 298                         self.package = package
 299                 elif metaProvided and not packageProvided:
 300                         self.meta_package = meta
 301                 else:
 302                         raise Exception("Either meta or package must be given, but not both!")
 303
 304         def __str__(self):
 305                 if self.package is not None:
 306                         return self.package.author.username + "/" + self.package.name
 307                 elif self.meta_package is not None:
 308                         return self.meta_package.name
 309                 else:
 310                         raise Exception("Meta and package are both none!")
 311
 312         @staticmethod
 313         def SpecToList(depender, spec, cache={}):
 314                 retval = []
 315                 arr = spec.split(",")
 316
 317                 import re
 318                 pattern1 = re.compile("^([a-z0-9_]+)$")
 319                 pattern2 = re.compile("^([A-Za-z0-9_]+)/([a-z0-9_]+)$")
 320
 321                 for x in arr:
 322                         x = x.strip()
 323                         if x == "":
 324                                 continue
 325
 326                         if pattern1.match(x):
 327                                 meta = MetaPackage.GetOrCreate(x, cache)
 328                                 retval.append(Dependency(depender, meta=meta))
 329                         else:
 330                                 m = pattern2.match(x)
 331                                 username = m.group(1)
 332                                 name     = m.group(2)
 333                                 user = User.query.filter_by(username=username).first()
 334                                 if user is None:
 335                                         raise Exception("Unable to find user " + username)
 336
 337                                 package = Package.query.filter_by(author=user, name=name).first()
 338                                 if package is None:
 339                                         raise Exception("Unable to find package " + name + " by " + username)
 340
 341                                 retval.append(Dependency(depender, package=package))
 342
 343                 return retval
 344
 345
 346
 347 class Package(db.Model):
 348         id           = db.Column(db.Integer, primary_key=True)
 349
 350         # Basic details
 351         author_id    = db.Column(db.Integer, db.ForeignKey("user.id"))
 352         name         = db.Column(db.String(100), nullable=False)
 353         title        = db.Column(db.String(100), nullable=False)
 354         shortDesc    = db.Column(db.String(200), nullable=False)
 355         desc         = db.Column(db.Text, nullable=True)
 356         type         = db.Column(db.Enum(PackageType))
 357         created_at   = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
 358
 359         license_id   = db.Column(db.Integer, db.ForeignKey("license.id"), nullable=False, default=1)
 360         license      = db.relationship("License", foreign_keys=[license_id])
 361         media_license_id = db.Column(db.Integer, db.ForeignKey("license.id"), nullable=False, default=1)
 362         media_license    = db.relationship("License", foreign_keys=[media_license_id])
 363
 364         approved     = db.Column(db.Boolean, nullable=False, default=False)
 365         soft_deleted = db.Column(db.Boolean, nullable=False, default=False)
 366
 367         score        = db.Column(db.Float, nullable=False, default=0)
 368
 369         review_thread_id = db.Column(db.Integer, db.ForeignKey("thread.id"), nullable=True, default=None)
 370         review_thread    = db.relationship("Thread", foreign_keys=[review_thread_id])
 371
 372         # Downloads
 373         repo         = db.Column(db.String(200), nullable=True)
 374         website      = db.Column(db.String(200), nullable=True)
 375         issueTracker = db.Column(db.String(200), nullable=True)
 376         forums       = db.Column(db.Integer,     nullable=True)
 377
 378         provides = db.relationship("MetaPackage", secondary=provides, lazy="subquery",
 379                         backref=db.backref("packages", lazy="dynamic"))
 380
 381         dependencies = db.relationship("Dependency", backref="depender", lazy="dynamic", foreign_keys=[Dependency.depender_id])
 382
 383         tags = db.relationship("Tag", secondary=tags, lazy="subquery",
 384                         backref=db.backref("packages", lazy=True))
 385
 386         releases = db.relationship("PackageRelease", backref="package",
 387                         lazy="dynamic", order_by=db.desc("package_release_releaseDate"))
 388
 389         screenshots = db.relationship("PackageScreenshot", backref="package",
 390                         lazy="dynamic", order_by=db.asc("package_screenshot_id"))
 391
 392         requests = db.relationship("EditRequest", backref="package",
 393                         lazy="dynamic")
 394
 395         def __init__(self, package=None):
 396                 if package is None:
 397                         return
 398
 399                 self.author_id = package.author_id
 400                 self.created_at = package.created_at
 401                 self.approved = package.approved
 402
 403                 for e in PackagePropertyKey:
 404                         setattr(self, e.name, getattr(package, e.name))
 405
 406         def getAsDictionaryShort(self, base_url):
 407                 tnurl = self.getThumbnailURL(1)
 408                 return {
 409                         "name": self.name,
 410                         "title": self.title,
 411                         "author": self.author.display_name,
 412                         "short_description": self.shortDesc,
 413                         "type": self.type.toName(),
 414                         "release": self.getDownloadRelease().id if self.getDownloadRelease() is not None else None,
 415                         "thumbnail": (base_url + tnurl) if tnurl is not None else None,
 416                         "score": round(self.score * 10) / 10
 417                 }
 418
 419         def getAsDictionary(self, base_url):
 420                 tnurl = self.getThumbnailURL(1)
 421                 return {
 422                         "author": self.author.display_name,
 423                         "name": self.name,
 424                         "title": self.title,
 425                         "short_description": self.shortDesc,
 426                         "desc": self.desc,
 427                         "type": self.type.toName(),
 428                         "created_at": self.created_at,
 429
 430                         "license": self.license.name,
 431                         "media_license": self.media_license.name,
 432
 433                         "repo": self.repo,
 434                         "website": self.website,
 435                         "issue_tracker": self.issueTracker,
 436                         "forums": self.forums,
 437
 438                         "provides": [x.name for x in self.provides],
 439                         "thumbnail": (base_url + tnurl) if tnurl is not None else None,
 440                         "screenshots": [base_url + ss.url for ss in self.screenshots],
 441
 442                         "url": base_url + self.getDownloadURL(),
 443                         "release": self.getDownloadRelease().id if self.getDownloadRelease() is not None else None,
 444
 445                         "score": round(self.score * 10) / 10
 446                 }
 447
 448         def getThumbnailURL(self, level=2):
 449                 screenshot = self.screenshots.filter_by(approved=True).order_by(db.asc(PackageScreenshot.id)).first()
 450                 return screenshot.getThumbnailURL(level) if screenshot is not None else None
 451
 452         def getMainScreenshotURL(self):
 453                 screenshot = self.screenshots.filter_by(approved=True).order_by(db.asc(PackageScreenshot.id)).first()
 454                 return screenshot.url if screenshot is not None else None
 455
 456         def getDetailsURL(self):
 457                 return url_for("package_page",
 458                                 author=self.author.username, name=self.name)
 459
 460         def getEditURL(self):
 461                 return url_for("create_edit_package_page",
 462                                 author=self.author.username, name=self.name)
 463
 464         def getApproveURL(self):
 465                 return url_for("approve_package_page",
 466                                 author=self.author.username, name=self.name)
 467
 468         def getRemoveURL(self):
 469                 return url_for("remove_package_page",
 470                                 author=self.author.username, name=self.name)
 471
 472         def getNewScreenshotURL(self):
 473                 return url_for("create_screenshot_page",
 474                                 author=self.author.username, name=self.name)
 475
 476         def getCreateReleaseURL(self):
 477                 return url_for("create_release_page",
 478                                 author=self.author.username, name=self.name)
 479
 480         def getCreateEditRequestURL(self):
 481                 return url_for("create_edit_editrequest_page",
 482                                 author=self.author.username, name=self.name)
 483
 484         def getDownloadURL(self):
 485                 return url_for("package_download_page",
 486                                 author=self.author.username, name=self.name)
 487
 488         def getDownloadRelease(self):
 489                 for rel in self.releases:
 490                         if rel.approved:
 491                                 return rel
 492
 493                 return None
 494
 495         def checkPerm(self, user, perm):
 496                 if not user.is_authenticated:
 497                         return False
 498
 499                 if type(perm) == str:
 500                         perm = Permission[perm]
 501                 elif type(perm) != Permission:
 502                         raise Exception("Unknown permission given to Package.checkPerm()")
 503
 504                 isOwner = user == self.author
 505
 506                 if perm == Permission.CREATE_THREAD:
 507                         return user.rank.atLeast(UserRank.MEMBER)
 508
 509                 # Members can edit their own packages, and editors can edit any packages
 510                 if perm == Permission.MAKE_RELEASE or perm == Permission.ADD_SCREENSHOTS:
 511                         return isOwner or user.rank.atLeast(UserRank.EDITOR)
 512
 513                 if perm == Permission.EDIT_PACKAGE or perm == Permission.APPROVE_CHANGES:
 514                         if isOwner:
 515                                 return user.rank.atLeast(UserRank.MEMBER if self.approved else UserRank.NEW_MEMBER)
 516                         else:
 517                                 return user.rank.atLeast(UserRank.EDITOR)
 518
 519                 # Editors can change authors and approve new packages
 520                 elif perm == Permission.APPROVE_NEW or perm == Permission.CHANGE_AUTHOR:
 521                         return user.rank.atLeast(UserRank.EDITOR)
 522
 523                 elif perm == Permission.APPROVE_RELEASE or perm == Permission.APPROVE_SCREENSHOT:
 524                         return user.rank.atLeast(UserRank.TRUSTED_MEMBER if isOwner else UserRank.EDITOR)
 525
 526                 # Moderators can delete packages
 527                 elif perm == Permission.DELETE_PACKAGE or perm == Permission.UNAPPROVE_PACKAGE \
 528                                 or perm == Permission.CHANGE_RELEASE_URL:
 529                         return user.rank.atLeast(UserRank.MODERATOR)
 530
 531                 else:
 532                         raise Exception("Permission {} is not related to packages".format(perm.name))
 533
 534         def recalcScore(self):
 535                 self.score = 10
 536
 537                 if self.forums is not None:
 538                         topic = ForumTopic.query.get(self.forums)
 539                         if topic:
 540                                 days   = (datetime.datetime.now() - topic.created_at).days
 541                                 months = days / 30
 542                                 years  = days / 365
 543                                 self.score = topic.views / max(years, 0.0416) + 80*min(max(months, 0.5), 6)
 544
 545                 if self.getMainScreenshotURL() is None:
 546                         self.score *= 0.8
 547
 548                 if not self.license.is_foss or not self.media_license.is_foss:
 549                         self.score *= 0.1
 550
 551 class MetaPackage(db.Model):
 552         id           = db.Column(db.Integer, primary_key=True)
 553         name         = db.Column(db.String(100), unique=True, nullable=False)
 554         dependencies = db.relationship("Dependency", backref="meta_package", lazy="dynamic")
 555
 556         def __init__(self, name=None):
 557                 self.name = name
 558
 559         def __str__(self):
 560                 return self.name
 561
 562         @staticmethod
 563         def ListToSpec(list):
 564                 return ",".join([str(x) for x in list])
 565
 566         @staticmethod
 567         def GetOrCreate(name, cache={}):
 568                 mp = cache.get(name)
 569                 if mp is None:
 570                         mp = MetaPackage.query.filter_by(name=name).first()
 571
 572                 if mp is None:
 573                         mp = MetaPackage(name)
 574                         db.session.add(mp)
 575
 576                 cache[name] = mp
 577                 return mp
 578
 579         @staticmethod
 580         def SpecToList(spec, cache={}):
 581                 retval = []
 582                 arr = spec.split(",")
 583
 584                 import re
 585                 pattern = re.compile("^([a-z0-9_]+)$")
 586
 587                 for x in arr:
 588                         x = x.strip()
 589                         if x == "":
 590                                 continue
 591
 592                         if not pattern.match(x):
 593                                 continue
 594
 595                         retval.append(MetaPackage.GetOrCreate(x, cache))
 596
 597                 return retval
 598
 599 class Tag(db.Model):
 600         id              = db.Column(db.Integer,    primary_key=True)
 601         name            = db.Column(db.String(100), unique=True, nullable=False)
 602         title           = db.Column(db.String(100), nullable=False)
 603         backgroundColor = db.Column(db.String(6),   nullable=False)
 604         textColor       = db.Column(db.String(6),   nullable=False)
 605
 606         def __init__(self, title, backgroundColor="000000", textColor="ffffff"):
 607                 self.title           = title
 608                 self.backgroundColor = backgroundColor
 609                 self.textColor       = textColor
 610
 611                 import re
 612                 regex = re.compile("[^a-z_]")
 613                 self.name = regex.sub("", self.title.lower().replace(" ", "_"))
 614
 615
 616 class MinetestRelease(db.Model):
 617         id       = db.Column(db.Integer, primary_key=True)
 618         name     = db.Column(db.String(100), unique=True, nullable=False)
 619         protocol = db.Column(db.Integer, nullable=False, default=0)
 620
 621         def __init__(self, name=None):
 622                 self.name = name
 623
 624         def getActual(self):
 625                 return None if self.name == "None" else self
 626
 627
 628 class PackageRelease(db.Model):
 629         id           = db.Column(db.Integer, primary_key=True)
 630
 631         package_id   = db.Column(db.Integer, db.ForeignKey("package.id"))
 632         title        = db.Column(db.String(100), nullable=False)
 633         releaseDate  = db.Column(db.DateTime,    nullable=False)
 634         url          = db.Column(db.String(200), nullable=False)
 635         approved     = db.Column(db.Boolean, nullable=False, default=False)
 636         task_id      = db.Column(db.String(37), nullable=True)
 637         commit_hash  = db.Column(db.String(41), nullable=True, default=None)
 638
 639         min_rel_id = db.Column(db.Integer, db.ForeignKey("minetest_release.id"), nullable=True, server_default=None)
 640         min_rel    = db.relationship("MinetestRelease", foreign_keys=[min_rel_id])
 641
 642         max_rel_id = db.Column(db.Integer, db.ForeignKey("minetest_release.id"), nullable=True, server_default=None)
 643         max_rel    = db.relationship("MinetestRelease", foreign_keys=[max_rel_id])
 644
 645
 646         def getEditURL(self):
 647                 return url_for("edit_release_page",
 648                                 author=self.package.author.username,
 649                                 name=self.package.name,
 650                                 id=self.id)
 651
 652         def getDownloadURL(self):
 653                 return url_for("download_release_page",
 654                                 author=self.package.author.username,
 655                                 name=self.package.name,
 656                                 id=self.id)
 657
 658
 659         def __init__(self):
 660                 self.releaseDate = datetime.datetime.now()
 661
 662
 663 class PackageReview(db.Model):
 664         id         = db.Column(db.Integer, primary_key=True)
 665         package_id = db.Column(db.Integer, db.ForeignKey("package.id"))
 666         thread_id  = db.Column(db.Integer, db.ForeignKey("thread.id"), nullable=False)
 667         recommend  = db.Column(db.Boolean, nullable=False, default=True)
 668
 669
 670 class PackageScreenshot(db.Model):
 671         id         = db.Column(db.Integer, primary_key=True)
 672         package_id = db.Column(db.Integer, db.ForeignKey("package.id"))
 673         title      = db.Column(db.String(100), nullable=False)
 674         url        = db.Column(db.String(100), nullable=False)
 675         approved   = db.Column(db.Boolean, nullable=False, default=False)
 676
 677
 678         def getEditURL(self):
 679                 return url_for("edit_screenshot_page",
 680                                 author=self.package.author.username,
 681                                 name=self.package.name,
 682                                 id=self.id)
 683
 684         def getThumbnailURL(self, level=2):
 685                 return self.url.replace("/uploads/", ("/thumbnails/{:d}/").format(level))
 686
 687
 688
 689 class EditRequest(db.Model):
 690         id           = db.Column(db.Integer, primary_key=True)
 691
 692         package_id   = db.Column(db.Integer, db.ForeignKey("package.id"))
 693         author_id    = db.Column(db.Integer, db.ForeignKey("user.id"))
 694
 695         title        = db.Column(db.String(100), nullable=False)
 696         desc         = db.Column(db.String(1000), nullable=True)
 697
 698         # 0 - open
 699         # 1 - merged
 700         # 2 - rejected
 701         status       = db.Column(db.Integer, nullable=False, default=0)
 702
 703         changes = db.relationship("EditRequestChange", backref="request",
 704                         lazy="dynamic")
 705
 706         def getURL(self):
 707                 return url_for("view_editrequest_page",
 708                                 author=self.package.author.username,
 709                                 name=self.package.name,
 710                                 id=self.id)
 711
 712         def getApproveURL(self):
 713                 return url_for("approve_editrequest_page",
 714                                 author=self.package.author.username,
 715                                 name=self.package.name,
 716                                 id=self.id)
 717
 718         def getRejectURL(self):
 719                 return url_for("reject_editrequest_page",
 720                                 author=self.package.author.username,
 721                                 name=self.package.name,
 722                                 id=self.id)
 723
 724         def getEditURL(self):
 725                 return url_for("create_edit_editrequest_page",
 726                                 author=self.package.author.username,
 727                                 name=self.package.name,
 728                                 id=self.id)
 729
 730         def applyAll(self, package):
 731                 for change in self.changes:
 732                         change.apply(package)
 733
 734
 735         def checkPerm(self, user, perm):
 736                 if not user.is_authenticated:
 737                         return False
 738
 739                 if type(perm) == str:
 740                         perm = Permission[perm]
 741                 elif type(perm) != Permission:
 742                         raise Exception("Unknown permission given to EditRequest.checkPerm()")
 743
 744                 isOwner = user == self.author
 745
 746                 # Members can edit their own packages, and editors can edit any packages
 747                 if perm == Permission.EDIT_EDITREQUEST:
 748                         return isOwner or user.rank.atLeast(UserRank.EDITOR)
 749
 750                 else:
 751                         raise Exception("Permission {} is not related to packages".format(perm.name))
 752
 753
 754
 755
 756 class EditRequestChange(db.Model):
 757         id           = db.Column(db.Integer, primary_key=True)
 758
 759         request_id   = db.Column(db.Integer, db.ForeignKey("edit_request.id"))
 760         key          = db.Column(db.Enum(PackagePropertyKey), nullable=False)
 761
 762         # TODO: make diff instead
 763         oldValue     = db.Column(db.Text, nullable=True)
 764         newValue     = db.Column(db.Text, nullable=True)
 765
 766         def apply(self, package):
 767                 if self.key == PackagePropertyKey.tags:
 768                         package.tags.clear()
 769                         for tagTitle in self.newValue.split(","):
 770                                 tag = Tag.query.filter_by(title=tagTitle.strip()).first()
 771                                 package.tags.append(tag)
 772
 773                 else:
 774                         setattr(package, self.key.name, self.newValue)
 775
 776
 777 watchers = db.Table("watchers",
 778     db.Column("user_id", db.Integer, db.ForeignKey("user.id"), primary_key=True),
 779     db.Column("thread_id", db.Integer, db.ForeignKey("thread.id"), primary_key=True)
 780 )
 781
 782 class Thread(db.Model):
 783         id         = db.Column(db.Integer, primary_key=True)
 784
 785         package_id = db.Column(db.Integer, db.ForeignKey("package.id"), nullable=True)
 786         package    = db.relationship("Package", foreign_keys=[package_id])
 787
 788         author_id  = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
 789         title      = db.Column(db.String(100), nullable=False)
 790         private    = db.Column(db.Boolean, server_default="0")
 791
 792         created_at = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
 793
 794         replies    = db.relationship("ThreadReply", backref="thread", lazy="dynamic")
 795
 796         watchers   = db.relationship("User", secondary=watchers, lazy="subquery", \
 797                                                 backref=db.backref("watching", lazy=True))
 798
 799
 800         def getSubscribeURL(self):
 801                 return url_for("thread_subscribe_page",
 802                                 id=self.id)
 803
 804         def getUnsubscribeURL(self):
 805                 return url_for("thread_unsubscribe_page",
 806                                 id=self.id)
 807
 808         def checkPerm(self, user, perm):
 809                 if not user.is_authenticated:
 810                         return not self.private
 811
 812                 if type(perm) == str:
 813                         perm = Permission[perm]
 814                 elif type(perm) != Permission:
 815                         raise Exception("Unknown permission given to Thread.checkPerm()")
 816
 817                 isOwner = user == self.author or (self.package is not None and self.package.author == user)
 818
 819                 if perm == Permission.SEE_THREAD:
 820                         return not self.private or isOwner or user.rank.atLeast(UserRank.EDITOR)
 821
 822                 else:
 823                         raise Exception("Permission {} is not related to threads".format(perm.name))
 824
 825 class ThreadReply(db.Model):
 826         id         = db.Column(db.Integer, primary_key=True)
 827         thread_id  = db.Column(db.Integer, db.ForeignKey("thread.id"), nullable=False)
 828         comment    = db.Column(db.String(500), nullable=False)
 829         author_id  = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
 830         created_at = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
 831
 832
 833 REPO_BLACKLIST = [".zip", "mediafire.com", "dropbox.com", "weebly.com", \
 834                 "minetest.net", "dropboxusercontent.com", "4shared.com", \
 835                 "digitalaudioconcepts.com", "hg.intevation.org", "www.wtfpl.net", \
 836                 "imageshack.com", "imgur.com"]
 837
 838 class ForumTopic(db.Model):
 839         topic_id  = db.Column(db.Integer, primary_key=True, autoincrement=False)
 840         author_id = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
 841         author    = db.relationship("User")
 842
 843         wip       = db.Column(db.Boolean, server_default="0")
 844         discarded = db.Column(db.Boolean, server_default="0")
 845
 846         type      = db.Column(db.Enum(PackageType), nullable=False)
 847         title     = db.Column(db.String(200), nullable=False)
 848         name      = db.Column(db.String(30), nullable=True)
 849         link      = db.Column(db.String(200), nullable=True)
 850
 851         posts     = db.Column(db.Integer, nullable=False)
 852         views     = db.Column(db.Integer, nullable=False)
 853
 854         created_at = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
 855
 856         def getRepoURL(self):
 857                 if self.link is None:
 858                         return None
 859
 860                 for item in REPO_BLACKLIST:
 861                         if item in self.link:
 862                                 return None
 863
 864                 return self.link.replace("repo.or.cz/w/", "repo.or.cz/")
 865
 866         def getAsDictionary(self):
 867                 return {
 868                         "author": self.author.username,
 869                         "name":   self.name,
 870                         "type":   self.type.toName(),
 871                         "title":  self.title,
 872                         "id":     self.topic_id,
 873                         "link":   self.link,
 874                         "posts":  self.posts,
 875                         "views":  self.views,
 876                         "is_wip": self.wip,
 877                         "discarded":  self.discarded,
 878                         "created_at": self.created_at.isoformat(),
 879                 }
 880
 881         def checkPerm(self, user, perm):
 882                 if not user.is_authenticated:
 883                         return False
 884
 885                 if type(perm) == str:
 886                         perm = Permission[perm]
 887                 elif type(perm) != Permission:
 888                         raise Exception("Unknown permission given to ForumTopic.checkPerm()")
 889
 890                 if perm == Permission.TOPIC_DISCARD:
 891                         return self.author == user or user.rank.atLeast(UserRank.EDITOR)
 892
 893                 else:
 894                         raise Exception("Permission {} is not related to topics".format(perm.name))
 895
 896
 897 # Setup Flask-User
 898 db_adapter = SQLAlchemyAdapter(db, User)        # Register the User model
 899 user_manager = UserManager(db_adapter, app)     # Initialize Flask-User