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