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 import enum, datetime
  19
  20 from app import app, gravatar
  21 from urllib.parse import urlparse
  22
  23 from flask import Flask, url_for
  24 from flask_sqlalchemy import SQLAlchemy, BaseQuery
  25 from flask_migrate import Migrate
  26 from flask_user import login_required, UserManager, UserMixin
  27 from sqlalchemy import func, CheckConstraint
  28 from sqlalchemy_searchable import SearchQueryMixin
  29 from sqlalchemy_utils.types import TSVectorType
  30 from sqlalchemy_searchable import make_searchable
  31
  32
  33 # Initialise database
  34 db = SQLAlchemy(app)
  35 migrate = Migrate(app, db)
  36 make_searchable(db.metadata)
  37
  38
  39 class ArticleQuery(BaseQuery, SearchQueryMixin):
  40         pass
  41
  42
  43 class UserRank(enum.Enum):
  44         BANNED         = 0
  45         NOT_JOINED     = 1
  46         NEW_MEMBER     = 2
  47         MEMBER         = 3
  48         TRUSTED_MEMBER = 4
  49         EDITOR         = 5
  50         MODERATOR      = 6
  51         ADMIN          = 7
  52
  53         def atLeast(self, min):
  54                 return self.value >= min.value
  55
  56         def getTitle(self):
  57                 return self.name.replace("_", " ").title()
  58
  59         def toName(self):
  60                 return self.name.lower()
  61
  62         def __str__(self):
  63                 return self.name
  64
  65         @classmethod
  66         def choices(cls):
  67                 return [(choice, choice.getTitle()) for choice in cls]
  68
  69         @classmethod
  70         def coerce(cls, item):
  71                 return item if type(item) == UserRank else UserRank[item]
  72
  73
  74 class Permission(enum.Enum):
  75         EDIT_PACKAGE       = "EDIT_PACKAGE"
  76         APPROVE_CHANGES    = "APPROVE_CHANGES"
  77         DELETE_PACKAGE     = "DELETE_PACKAGE"
  78         CHANGE_AUTHOR      = "CHANGE_AUTHOR"
  79         CHANGE_NAME        = "CHANGE_NAME"
  80         MAKE_RELEASE       = "MAKE_RELEASE"
  81         DELETE_RELEASE     = "DELETE_RELEASE"
  82         ADD_SCREENSHOTS    = "ADD_SCREENSHOTS"
  83         APPROVE_SCREENSHOT = "APPROVE_SCREENSHOT"
  84         APPROVE_RELEASE    = "APPROVE_RELEASE"
  85         APPROVE_NEW        = "APPROVE_NEW"
  86         CHANGE_RELEASE_URL = "CHANGE_RELEASE_URL"
  87         CHANGE_DNAME       = "CHANGE_DNAME"
  88         CHANGE_RANK        = "CHANGE_RANK"
  89         CHANGE_EMAIL       = "CHANGE_EMAIL"
  90         EDIT_EDITREQUEST   = "EDIT_EDITREQUEST"
  91         SEE_THREAD         = "SEE_THREAD"
  92         CREATE_THREAD      = "CREATE_THREAD"
  93         UNAPPROVE_PACKAGE  = "UNAPPROVE_PACKAGE"
  94         TOPIC_DISCARD      = "TOPIC_DISCARD"
  95         CREATE_TOKEN       = "CREATE_TOKEN"
  96         EDIT_MAINTAINERS   = "EDIT_MAINTAINERS"
  97         CHANGE_PROFILE_URLS = "CHANGE_PROFILE_URLS"
  98
  99         # Only return true if the permission is valid for *all* contexts
 100         # See Package.checkPerm for package-specific contexts
 101         def check(self, user):
 102                 if not user.is_authenticated:
 103                         return False
 104
 105                 if self == Permission.APPROVE_NEW or \
 106                                 self == Permission.APPROVE_CHANGES    or \
 107                                 self == Permission.APPROVE_RELEASE    or \
 108                                 self == Permission.APPROVE_SCREENSHOT or \
 109                                 self == Permission.SEE_THREAD:
 110                         return user.rank.atLeast(UserRank.EDITOR)
 111                 else:
 112                         raise Exception("Non-global permission checked globally. Use Package.checkPerm or User.checkPerm instead.")
 113
 114 def display_name_default(context):
 115     return context.get_current_parameters()["username"]
 116
 117 class User(db.Model, UserMixin):
 118         id           = db.Column(db.Integer, primary_key=True)
 119
 120         # User authentication information
 121         username     = db.Column(db.String(50, collation="NOCASE"), nullable=False, unique=True, index=True)
 122         password     = db.Column(db.String(255), nullable=False, server_default="")
 123         reset_password_token = db.Column(db.String(100), nullable=False, server_default="")
 124
 125         rank         = db.Column(db.Enum(UserRank))
 126
 127         # Account linking
 128         github_username = db.Column(db.String(50, collation="NOCASE"), nullable=True, unique=True)
 129         forums_username = db.Column(db.String(50, collation="NOCASE"), nullable=True, unique=True)
 130
 131         # Access token for webhook setup
 132         github_access_token = db.Column(db.String(50), nullable=True, server_default=None)
 133
 134         # User email information
 135         email         = db.Column(db.String(255), nullable=True, unique=True)
 136         email_confirmed_at  = db.Column(db.DateTime())
 137
 138         # User information
 139         profile_pic   = db.Column(db.String(255), nullable=True, server_default=None)
 140         active        = db.Column("is_active", db.Boolean, nullable=False, server_default="0")
 141         display_name  = db.Column(db.String(100), nullable=False, default=display_name_default)
 142
 143         # Links
 144         website_url   = db.Column(db.String(255), nullable=True, default=None)
 145         donate_url    = db.Column(db.String(255), nullable=True, default=None)
 146
 147         # Content
 148         notifications = db.relationship("Notification", primaryjoin="User.id==Notification.user_id")
 149
 150         # causednotifs  = db.relationship("Notification", backref="causer", lazy="dynamic")
 151         packages      = db.relationship("Package", backref=db.backref("author", lazy="joined"), lazy="dynamic")
 152         requests      = db.relationship("EditRequest", backref="author", lazy="dynamic")
 153         threads       = db.relationship("Thread", backref="author", lazy="dynamic")
 154         tokens        = db.relationship("APIToken", backref="owner", lazy="dynamic")
 155         replies       = db.relationship("ThreadReply", backref="author", lazy="dynamic")
 156
 157         def __init__(self, username=None, active=False, email=None, password=""):
 158                 self.username = username
 159                 self.email_confirmed_at = datetime.datetime.now() - datetime.timedelta(days=6000)
 160                 self.display_name = username
 161                 self.active = active
 162                 self.email = email
 163                 self.password = password
 164                 self.rank = UserRank.NOT_JOINED
 165
 166         def hasPassword(self):
 167                 return self.password != ""
 168
 169         def canAccessTodoList(self):
 170                 return Permission.APPROVE_NEW.check(self) or \
 171                                 Permission.APPROVE_RELEASE.check(self) or \
 172                                 Permission.APPROVE_CHANGES.check(self)
 173
 174         def isClaimed(self):
 175                 return self.rank.atLeast(UserRank.NEW_MEMBER)
 176
 177         def getProfilePicURL(self):
 178                 if self.profile_pic:
 179                         return self.profile_pic
 180                 else:
 181                         return gravatar(self.email or "")
 182
 183         def checkPerm(self, user, perm):
 184                 if not user.is_authenticated:
 185                         return False
 186
 187                 if type(perm) == str:
 188                         perm = Permission[perm]
 189                 elif type(perm) != Permission:
 190                         raise Exception("Unknown permission given to User.checkPerm()")
 191
 192                 # Members can edit their own packages, and editors can edit any packages
 193                 if perm == Permission.CHANGE_AUTHOR:
 194                         return user.rank.atLeast(UserRank.EDITOR)
 195                 elif perm == Permission.CHANGE_RANK or perm == Permission.CHANGE_DNAME:
 196                         return user.rank.atLeast(UserRank.MODERATOR)
 197                 elif perm == Permission.CHANGE_EMAIL or perm == Permission.CHANGE_PROFILE_URLS:
 198                         return user == self or (user.rank.atLeast(UserRank.MODERATOR) and user.rank.atLeast(self.rank))
 199                 elif perm == Permission.CREATE_TOKEN:
 200                         if user == self:
 201                                 return user.rank.atLeast(UserRank.MEMBER)
 202                         else:
 203                                 return user.rank.atLeast(UserRank.MODERATOR) and user.rank.atLeast(self.rank)
 204                 else:
 205                         raise Exception("Permission {} is not related to users".format(perm.name))
 206
 207         def canCommentRL(self):
 208                 one_min_ago = datetime.datetime.utcnow() - datetime.timedelta(minutes=1)
 209                 if ThreadReply.query.filter_by(author=self) \
 210                                 .filter(ThreadReply.created_at > one_min_ago).count() >= 3:
 211                         return False
 212
 213                 hour_ago = datetime.datetime.utcnow() - datetime.timedelta(hours=1)
 214                 if ThreadReply.query.filter_by(author=self) \
 215                                 .filter(ThreadReply.created_at > hour_ago).count() >= 20:
 216                         return False
 217
 218                 return True
 219
 220         def canOpenThreadRL(self):
 221                 hour_ago = datetime.datetime.utcnow() - datetime.timedelta(hours=1)
 222                 return Thread.query.filter_by(author=self) \
 223                         .filter(Thread.created_at > hour_ago).count() < 2
 224
 225         def __eq__(self, other):
 226                 if other is None:
 227                         return False
 228
 229                 if not self.is_authenticated or not other.is_authenticated:
 230                         return False
 231
 232                 assert self.id > 0
 233                 return self.id == other.id
 234
 235 class UserEmailVerification(db.Model):
 236         id      = db.Column(db.Integer, primary_key=True)
 237         user_id = db.Column(db.Integer, db.ForeignKey("user.id"))
 238         email   = db.Column(db.String(100))
 239         token   = db.Column(db.String(32))
 240         user    = db.relationship("User", foreign_keys=[user_id])
 241
 242 class Notification(db.Model):
 243         id        = db.Column(db.Integer, primary_key=True)
 244         user_id   = db.Column(db.Integer, db.ForeignKey("user.id"))
 245         causer_id = db.Column(db.Integer, db.ForeignKey("user.id"))
 246         user      = db.relationship("User", foreign_keys=[user_id])
 247         causer    = db.relationship("User", foreign_keys=[causer_id])
 248
 249         title     = db.Column(db.String(100), nullable=False)
 250         url       = db.Column(db.String(200), nullable=True)
 251
 252         def __init__(self, us, cau, titl, ur):
 253                 if len(titl) > 100:
 254                         title = title[:99] + "…"
 255
 256                 self.user   = us
 257                 self.causer = cau
 258                 self.title  = titl
 259                 self.url    = ur
 260
 261
 262 class License(db.Model):
 263         id      = db.Column(db.Integer, primary_key=True)
 264         name    = db.Column(db.String(50), nullable=False, unique=True)
 265         is_foss = db.Column(db.Boolean,    nullable=False, default=True)
 266
 267         def __init__(self, v, is_foss=True):
 268                 self.name = v
 269                 self.is_foss = is_foss
 270
 271         def __str__(self):
 272                 return self.name
 273
 274
 275 class PackageType(enum.Enum):
 276         MOD  = "Mod"
 277         GAME = "Game"
 278         TXP  = "Texture Pack"
 279
 280         def toName(self):
 281                 return self.name.lower()
 282
 283         def __str__(self):
 284                 return self.name
 285
 286         @classmethod
 287         def get(cls, name):
 288                 try:
 289                         return PackageType[name.upper()]
 290                 except KeyError:
 291                         return None
 292
 293         @classmethod
 294         def choices(cls):
 295                 return [(choice, choice.value) for choice in cls]
 296
 297         @classmethod
 298         def coerce(cls, item):
 299                 return item if type(item) == PackageType else PackageType[item]
 300
 301
 302 class PackagePropertyKey(enum.Enum):
 303         name          = "Name"
 304         title         = "Title"
 305         short_desc     = "Short Description"
 306         desc          = "Description"
 307         type          = "Type"
 308         license       = "License"
 309         media_license = "Media License"
 310         tags          = "Tags"
 311         provides      = "Provides"
 312         repo          = "Repository"
 313         website       = "Website"
 314         issueTracker  = "Issue Tracker"
 315         forums        = "Forum Topic ID"
 316
 317         def convert(self, value):
 318                 if self == PackagePropertyKey.tags:
 319                         return ",".join([t.title for t in value])
 320                 elif self == PackagePropertyKey.provides:
 321                         return ",".join([t.name for t in value])
 322                 else:
 323                         return str(value)
 324
 325 provides = db.Table("provides",
 326         db.Column("package_id",    db.Integer, db.ForeignKey("package.id"), primary_key=True),
 327     db.Column("metapackage_id", db.Integer, db.ForeignKey("meta_package.id"), primary_key=True)
 328 )
 329
 330 tags = db.Table("tags",
 331     db.Column("tag_id", db.Integer, db.ForeignKey("tag.id"), primary_key=True),
 332     db.Column("package_id", db.Integer, db.ForeignKey("package.id"), primary_key=True)
 333 )
 334
 335 maintainers = db.Table("maintainers",
 336     db.Column("user_id", db.Integer, db.ForeignKey("user.id"), primary_key=True),
 337     db.Column("package_id", db.Integer, db.ForeignKey("package.id"), primary_key=True)
 338 )
 339
 340 class Dependency(db.Model):
 341         id              = db.Column(db.Integer, primary_key=True)
 342         depender_id     = db.Column(db.Integer, db.ForeignKey("package.id"),     nullable=True)
 343         package_id      = db.Column(db.Integer, db.ForeignKey("package.id"),     nullable=True)
 344         package         = db.relationship("Package", foreign_keys=[package_id])
 345         meta_package_id = db.Column(db.Integer, db.ForeignKey("meta_package.id"), nullable=True)
 346         optional        = db.Column(db.Boolean, nullable=False, default=False)
 347         __table_args__  = (db.UniqueConstraint("depender_id", "package_id", "meta_package_id", name="_dependency_uc"), )
 348
 349         def __init__(self, depender=None, package=None, meta=None):
 350                 if depender is None:
 351                         return
 352
 353                 self.depender = depender
 354
 355                 packageProvided = package is not None
 356                 metaProvided = meta is not None
 357
 358                 if packageProvided and not metaProvided:
 359                         self.package = package
 360                 elif metaProvided and not packageProvided:
 361                         self.meta_package = meta
 362                 else:
 363                         raise Exception("Either meta or package must be given, but not both!")
 364
 365         def getName(self):
 366                 if self.meta_package:
 367                         return self.meta_package.name
 368                 elif self.package:
 369                         return self.package.name
 370                 else:
 371                         assert False
 372
 373         def __str__(self):
 374                 if self.package is not None:
 375                         return self.package.author.username + "/" + self.package.name
 376                 elif self.meta_package is not None:
 377                         return self.meta_package.name
 378                 else:
 379                         raise Exception("Meta and package are both none!")
 380
 381         @staticmethod
 382         def SpecToList(depender, spec, cache={}):
 383                 retval = []
 384                 arr = spec.split(",")
 385
 386                 import re
 387                 pattern1 = re.compile("^([a-z0-9_]+)$")
 388                 pattern2 = re.compile("^([A-Za-z0-9_]+)/([a-z0-9_]+)$")
 389
 390                 for x in arr:
 391                         x = x.strip()
 392                         if x == "":
 393                                 continue
 394
 395                         if pattern1.match(x):
 396                                 meta = MetaPackage.GetOrCreate(x, cache)
 397                                 retval.append(Dependency(depender, meta=meta))
 398                         else:
 399                                 m = pattern2.match(x)
 400                                 username = m.group(1)
 401                                 name     = m.group(2)
 402                                 user = User.query.filter_by(username=username).first()
 403                                 if user is None:
 404                                         raise Exception("Unable to find user " + username)
 405
 406                                 package = Package.query.filter_by(author=user, name=name).first()
 407                                 if package is None:
 408                                         raise Exception("Unable to find package " + name + " by " + username)
 409
 410                                 retval.append(Dependency(depender, package=package))
 411
 412                 return retval
 413
 414
 415 class Package(db.Model):
 416         query_class  = ArticleQuery
 417
 418         id           = db.Column(db.Integer, primary_key=True)
 419
 420         # Basic details
 421         author_id    = db.Column(db.Integer, db.ForeignKey("user.id"))
 422         name         = db.Column(db.Unicode(100), nullable=False)
 423         title        = db.Column(db.Unicode(100), nullable=False)
 424         short_desc   = db.Column(db.Unicode(200), nullable=False)
 425         desc         = db.Column(db.UnicodeText, nullable=True)
 426         type         = db.Column(db.Enum(PackageType))
 427         created_at   = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
 428
 429         name_valid = db.CheckConstraint("name ~* '^[a-z0-9_]+$'")
 430
 431         search_vector = db.Column(TSVectorType("name", "title", "short_desc", "desc", \
 432                         weights={ "name": "A", "title": "B", "short_desc": "C", "desc": "D" }))
 433
 434         license_id   = db.Column(db.Integer, db.ForeignKey("license.id"), nullable=False, default=1)
 435         license      = db.relationship("License", foreign_keys=[license_id])
 436         media_license_id = db.Column(db.Integer, db.ForeignKey("license.id"), nullable=False, default=1)
 437         media_license    = db.relationship("License", foreign_keys=[media_license_id])
 438
 439         approved     = db.Column(db.Boolean, nullable=False, default=False)
 440         soft_deleted = db.Column(db.Boolean, nullable=False, default=False)
 441
 442         score        = db.Column(db.Float, nullable=False, default=0)
 443         score_downloads = db.Column(db.Float, nullable=False, default=0)
 444         downloads     = db.Column(db.Integer, nullable=False, default=0)
 445
 446         review_thread_id = db.Column(db.Integer, db.ForeignKey("thread.id"), nullable=True, default=None)
 447         review_thread    = db.relationship("Thread", foreign_keys=[review_thread_id])
 448
 449         # Downloads
 450         repo         = db.Column(db.String(200), nullable=True)
 451         website      = db.Column(db.String(200), nullable=True)
 452         issueTracker = db.Column(db.String(200), nullable=True)
 453         forums       = db.Column(db.Integer,     nullable=True)
 454
 455         provides = db.relationship("MetaPackage", \
 456                         secondary=provides, lazy="select", order_by=db.asc("name"), \
 457                         backref=db.backref("packages", lazy="dynamic", order_by=db.desc("score")))
 458
 459         dependencies = db.relationship("Dependency", backref="depender", lazy="dynamic", foreign_keys=[Dependency.depender_id])
 460
 461         tags = db.relationship("Tag", secondary=tags, lazy="select",
 462                         backref=db.backref("packages", lazy=True))
 463
 464         releases = db.relationship("PackageRelease", backref="package",
 465                         lazy="dynamic", order_by=db.desc("package_release_releaseDate"))
 466
 467         screenshots = db.relationship("PackageScreenshot", backref="package",
 468                         lazy="dynamic", order_by=db.asc("package_screenshot_id"))
 469
 470         requests = db.relationship("EditRequest", backref="package",
 471                         lazy="dynamic")
 472
 473         maintainers = db.relationship("User", secondary=maintainers, lazy="subquery")
 474
 475         def __init__(self, package=None):
 476                 if package is None:
 477                         return
 478
 479                 self.author_id = package.author_id
 480                 self.created_at = package.created_at
 481                 self.approved = package.approved
 482
 483                 for e in PackagePropertyKey:
 484                         setattr(self, e.name, getattr(package, e.name))
 485
 486         def getId(self):
 487                 return "{}/{}".format(self.author.username, self.name)
 488
 489         def getIsFOSS(self):
 490                 return self.license.is_foss and self.media_license.is_foss
 491
 492         def getIsOnGitHub(self):
 493                 if self.repo is None:
 494                         return False
 495
 496                 url = urlparse(self.repo)
 497                 return url.netloc == "github.com"
 498
 499         def getGitHubFullName(self):
 500                 if self.repo is None:
 501                         return None
 502
 503                 url = urlparse(self.repo)
 504                 if url.netloc != "github.com":
 505                         return None
 506
 507                 import re
 508                 m = re.search(r"^\/([^\/]+)\/([^\/]+)\/?$", url.path)
 509                 if m is None:
 510                         return
 511
 512                 user = m.group(1)
 513                 repo = m.group(2).replace(".git", "")
 514
 515                 return (user,repo)
 516
 517         def getSortedDependencies(self, is_hard=None):
 518                 query = self.dependencies
 519                 if is_hard is not None:
 520                         query = query.filter_by(optional=not is_hard)
 521
 522                 deps = query.all()
 523                 deps.sort(key = lambda x: x.getName())
 524                 return deps
 525
 526         def getSortedHardDependencies(self):
 527                 return self.getSortedDependencies(True)
 528
 529         def getSortedOptionalDependencies(self):
 530                 return self.getSortedDependencies(False)
 531
 532         def getState(self):
 533                 if self.approved:
 534                         return "approved"
 535                 elif self.review_thread_id:
 536                         return "thread"
 537                 elif (self.type == PackageType.GAME or \
 538                                         self.type == PackageType.TXP) and \
 539                                 self.screenshots.count() == 0:
 540                         return "wip"
 541                 elif not self.getDownloadRelease():
 542                         return "wip"
 543                 elif "Other" in self.license.name or "Other" in self.media_license.name:
 544                         return "license"
 545                 else:
 546                         return "ready"
 547
 548         def getAsDictionaryKey(self):
 549                 return {
 550                         "name": self.name,
 551                         "author": self.author.display_name,
 552                         "type": self.type.toName(),
 553                 }
 554
 555         def getAsDictionaryShort(self, base_url, version=None):
 556                 tnurl = self.getThumbnailURL(1)
 557                 release = self.getDownloadRelease(version=version)
 558                 return {
 559                         "name": self.name,
 560                         "title": self.title,
 561                         "author": self.author.username,
 562                         "short_description": self.short_desc,
 563                         "type": self.type.toName(),
 564                         "release": release and release.id,
 565                         "thumbnail": (base_url + tnurl) if tnurl is not None else None
 566                 }
 567
 568         def getAsDictionary(self, base_url, version=None):
 569                 tnurl = self.getThumbnailURL(1)
 570                 release = self.getDownloadRelease(version=version)
 571                 return {
 572                         "author": self.author.username,
 573                         "name": self.name,
 574                         "title": self.title,
 575                         "short_description": self.short_desc,
 576                         "desc": self.desc,
 577                         "type": self.type.toName(),
 578                         "created_at": self.created_at.isoformat(),
 579
 580                         "license": self.license.name,
 581                         "media_license": self.media_license.name,
 582
 583                         "repo": self.repo,
 584                         "website": self.website,
 585                         "issue_tracker": self.issueTracker,
 586                         "forums": self.forums,
 587
 588                         "provides": [x.name for x in self.provides],
 589                         "thumbnail": (base_url + tnurl) if tnurl is not None else None,
 590                         "screenshots": [base_url + ss.url for ss in self.screenshots],
 591
 592                         "url": base_url + self.getDownloadURL(),
 593                         "release": release and release.id,
 594
 595                         "score": round(self.score * 10) / 10
 596                 }
 597
 598         def getThumbnailURL(self, level=2):
 599                 screenshot = self.screenshots.filter_by(approved=True).order_by(db.asc(PackageScreenshot.id)).first()
 600                 return screenshot.getThumbnailURL(level) if screenshot is not None else None
 601
 602         def getMainScreenshotURL(self, absolute=False):
 603                 screenshot = self.screenshots.filter_by(approved=True).order_by(db.asc(PackageScreenshot.id)).first()
 604                 if screenshot is None:
 605                         return None
 606
 607                 if absolute:
 608                         from app.utils import abs_url
 609                         return abs_url(screenshot.url)
 610                 else:
 611                         return screenshot.url
 612
 613         def getDetailsURL(self, absolute=False):
 614                 if absolute:
 615                         from app.utils import abs_url_for
 616                         return abs_url_for("packages.view",
 617                                         author=self.author.username, name=self.name)
 618                 else:
 619                         return url_for("packages.view",
 620                                         author=self.author.username, name=self.name)
 621
 622         def getEditURL(self):
 623                 return url_for("packages.create_edit",
 624                                 author=self.author.username, name=self.name)
 625
 626         def getApproveURL(self):
 627                 return url_for("packages.approve",
 628                                 author=self.author.username, name=self.name)
 629
 630         def getRemoveURL(self):
 631                 return url_for("packages.remove",
 632                                 author=self.author.username, name=self.name)
 633
 634         def getNewScreenshotURL(self):
 635                 return url_for("packages.create_screenshot",
 636                                 author=self.author.username, name=self.name)
 637
 638         def getCreateReleaseURL(self):
 639                 return url_for("packages.create_release",
 640                                 author=self.author.username, name=self.name)
 641
 642         def getCreateEditRequestURL(self):
 643                 return url_for("create_edit_editrequest_page",
 644                                 author=self.author.username, name=self.name)
 645
 646         def getBulkReleaseURL(self):
 647                 return url_for("packages.bulk_change_release",
 648                         author=self.author.username, name=self.name)
 649
 650         def getDownloadURL(self):
 651                 return url_for("packages.download",
 652                                 author=self.author.username, name=self.name)
 653
 654         def getEditMaintainersURL(self):
 655                 return url_for("packages.edit_maintainers",
 656                                 author=self.author.username, name=self.name)
 657
 658         def getRemoveSelfMaintainerURL(self):
 659                 return url_for("packages.remove_self_maintainers",
 660                                 author=self.author.username, name=self.name)
 661
 662         def getDownloadRelease(self, version=None):
 663                 for rel in self.releases:
 664                         if rel.approved and (version is None or
 665                                         ((rel.min_rel is None or rel.min_rel_id <= version.id) and \
 666                                         (rel.max_rel is None or rel.max_rel_id >= version.id))):
 667                                 return rel
 668
 669                 return None
 670
 671         def checkPerm(self, user, perm):
 672                 if not user.is_authenticated:
 673                         return False
 674
 675                 if type(perm) == str:
 676                         perm = Permission[perm]
 677                 elif type(perm) != Permission:
 678                         raise Exception("Unknown permission given to Package.checkPerm()")
 679
 680                 isOwner = user == self.author
 681                 isMaintainer = isOwner or user.rank.atLeast(UserRank.EDITOR) or user in self.maintainers
 682
 683                 if perm == Permission.CREATE_THREAD:
 684                         return user.rank.atLeast(UserRank.MEMBER)
 685
 686                 # Members can edit their own packages, and editors can edit any packages
 687                 elif perm == Permission.MAKE_RELEASE or perm == Permission.ADD_SCREENSHOTS:
 688                         return isMaintainer
 689
 690                 elif perm == Permission.EDIT_PACKAGE or perm == Permission.APPROVE_CHANGES or perm == Permission.APPROVE_RELEASE:
 691                         return isMaintainer and user.rank.atLeast(UserRank.MEMBER if self.approved else UserRank.NEW_MEMBER)
 692
 693                 # Anyone can change the package name when not approved, but only editors when approved
 694                 elif perm == Permission.CHANGE_NAME:
 695                         return not self.approved or user.rank.atLeast(UserRank.EDITOR)
 696
 697                 # Editors can change authors and approve new packages
 698                 elif perm == Permission.APPROVE_NEW or perm == Permission.CHANGE_AUTHOR:
 699                         return user.rank.atLeast(UserRank.EDITOR)
 700
 701                 elif perm == Permission.APPROVE_SCREENSHOT:
 702                         return isMaintainer and user.rank.atLeast(UserRank.TRUSTED_MEMBER if self.approved else UserRank.NEW_MEMBER)
 703
 704                 elif perm == Permission.EDIT_MAINTAINERS:
 705                         return isOwner or user.rank.atLeast(UserRank.MODERATOR)
 706
 707                 # Moderators can delete packages
 708                 elif perm == Permission.DELETE_PACKAGE or perm == Permission.UNAPPROVE_PACKAGE \
 709                                 or perm == Permission.CHANGE_RELEASE_URL:
 710                         return user.rank.atLeast(UserRank.MODERATOR)
 711
 712                 else:
 713                         raise Exception("Permission {} is not related to packages".format(perm.name))
 714
 715         def setStartScore(self):
 716                 downloads = self.downloads
 717
 718                 forum_score = 0
 719                 forum_bonus = 0
 720                 topic = self.forums and ForumTopic.query.get(self.forums)
 721                 if topic:
 722                         months = (datetime.datetime.now() - topic.created_at).days / 30
 723                         years  = months / 12
 724                         forum_score = topic.views / max(years, 0.0416) + 80*min(max(months, 0.5), 6)
 725                         forum_bonus = topic.views + topic.posts
 726
 727                 self.score = max(downloads, forum_score * 0.6) + forum_bonus
 728
 729                 if self.getMainScreenshotURL() is None:
 730                         self.score *= 0.8
 731
 732                 self.recalcScore()
 733
 734         def recalcScore(self):
 735                 self.score_downloads = self.score
 736
 737
 738
 739 class MetaPackage(db.Model):
 740         id           = db.Column(db.Integer, primary_key=True)
 741         name         = db.Column(db.String(100), unique=True, nullable=False)
 742         dependencies = db.relationship("Dependency", backref="meta_package", lazy="dynamic")
 743
 744         def __init__(self, name=None):
 745                 self.name = name
 746
 747         def __str__(self):
 748                 return self.name
 749
 750         @staticmethod
 751         def ListToSpec(list):
 752                 return ",".join([str(x) for x in list])
 753
 754         @staticmethod
 755         def GetOrCreate(name, cache={}):
 756                 mp = cache.get(name)
 757                 if mp is None:
 758                         mp = MetaPackage.query.filter_by(name=name).first()
 759
 760                 if mp is None:
 761                         mp = MetaPackage(name)
 762                         db.session.add(mp)
 763
 764                 cache[name] = mp
 765                 return mp
 766
 767         @staticmethod
 768         def SpecToList(spec, cache={}):
 769                 retval = []
 770                 arr = spec.split(",")
 771
 772                 import re
 773                 pattern = re.compile("^([a-z0-9_]+)$")
 774
 775                 for x in arr:
 776                         x = x.strip()
 777                         if x == "":
 778                                 continue
 779
 780                         if not pattern.match(x):
 781                                 continue
 782
 783                         retval.append(MetaPackage.GetOrCreate(x, cache))
 784
 785                 return retval
 786
 787 class Tag(db.Model):
 788         id              = db.Column(db.Integer,    primary_key=True)
 789         name            = db.Column(db.String(100), unique=True, nullable=False)
 790         title           = db.Column(db.String(100), nullable=False)
 791         backgroundColor = db.Column(db.String(6),   nullable=False)
 792         textColor       = db.Column(db.String(6),   nullable=False)
 793
 794         def __init__(self, title, backgroundColor="000000", textColor="ffffff"):
 795                 self.title           = title
 796                 self.backgroundColor = backgroundColor
 797                 self.textColor       = textColor
 798
 799                 import re
 800                 regex = re.compile("[^a-z_]")
 801                 self.name = regex.sub("", self.title.lower().replace(" ", "_"))
 802
 803
 804 class MinetestRelease(db.Model):
 805         id       = db.Column(db.Integer, primary_key=True)
 806         name     = db.Column(db.String(100), unique=True, nullable=False)
 807         protocol = db.Column(db.Integer, nullable=False, default=0)
 808
 809         def __init__(self, name=None, protocol=0):
 810                 self.name = name
 811                 self.protocol = protocol
 812
 813         def getActual(self):
 814                 return None if self.name == "None" else self
 815
 816         @classmethod
 817         def get(cls, version, protocol_num):
 818                 if version:
 819                         parts = version.strip().split(".")
 820                         if len(parts) >= 2:
 821                                 major_minor = parts[0] + "." + parts[1]
 822                                 query = MinetestRelease.query.filter(MinetestRelease.name.like("{}%".format(major_minor)))
 823                                 if protocol_num:
 824                                         query = query.filter_by(protocol=protocol_num)
 825
 826                                 release = query.one_or_none()
 827                                 if release:
 828                                         return release
 829
 830                 if protocol_num:
 831                         return MinetestRelease.query.filter_by(protocol=protocol_num).first()
 832
 833                 return None
 834
 835
 836 class PackageRelease(db.Model):
 837         id           = db.Column(db.Integer, primary_key=True)
 838
 839         package_id   = db.Column(db.Integer, db.ForeignKey("package.id"))
 840         title        = db.Column(db.String(100), nullable=False)
 841         releaseDate  = db.Column(db.DateTime,    nullable=False)
 842         url          = db.Column(db.String(200), nullable=False)
 843         approved     = db.Column(db.Boolean, nullable=False, default=False)
 844         task_id      = db.Column(db.String(37), nullable=True)
 845         commit_hash  = db.Column(db.String(41), nullable=True, default=None)
 846         downloads    = db.Column(db.Integer, nullable=False, default=0)
 847
 848         min_rel_id = db.Column(db.Integer, db.ForeignKey("minetest_release.id"), nullable=True, server_default=None)
 849         min_rel    = db.relationship("MinetestRelease", foreign_keys=[min_rel_id])
 850
 851         max_rel_id = db.Column(db.Integer, db.ForeignKey("minetest_release.id"), nullable=True, server_default=None)
 852         max_rel    = db.relationship("MinetestRelease", foreign_keys=[max_rel_id])
 853
 854         # If the release is approved, then the task_id must be null and the url must be present
 855         CK_approval_valid = db.CheckConstraint("not approved OR (task_id IS NULL AND (url = '') IS NOT FALSE)")
 856
 857         def getAsDictionary(self):
 858                 return {
 859                         "id": self.id,
 860                         "title": self.title,
 861                         "url": self.url if self.url != "" else None,
 862                         "release_date": self.releaseDate.isoformat(),
 863                         "commit": self.commit_hash,
 864                         "downloads": self.downloads,
 865                         "min_protocol": self.min_rel and self.min_rel.protocol,
 866                         "max_protocol": self.max_rel and self.max_rel.protocol
 867                 }
 868
 869         def getEditURL(self):
 870                 return url_for("packages.edit_release",
 871                                 author=self.package.author.username,
 872                                 name=self.package.name,
 873                                 id=self.id)
 874
 875         def getDeleteURL(self):
 876                 return url_for("packages.delete_release",
 877                                 author=self.package.author.username,
 878                                 name=self.package.name,
 879                                 id=self.id)
 880
 881         def getDownloadURL(self):
 882                 return url_for("packages.download_release",
 883                                 author=self.package.author.username,
 884                                 name=self.package.name,
 885                                 id=self.id)
 886
 887         def __init__(self):
 888                 self.releaseDate = datetime.datetime.now()
 889
 890         def approve(self, user):
 891                 if not self.package.checkPerm(user, Permission.APPROVE_RELEASE):
 892                         return False
 893
 894                 assert self.task_id is None and self.url is not None and self.url != ""
 895
 896                 self.approved = True
 897                 return True
 898
 899         def checkPerm(self, user, perm):
 900                 if not user.is_authenticated:
 901                         return False
 902
 903                 if type(perm) == str:
 904                         perm = Permission[perm]
 905                 elif type(perm) != Permission:
 906                         raise Exception("Unknown permission given to PackageRelease.checkPerm()")
 907
 908                 isOwner = user == self.package.author
 909
 910                 if perm == Permission.DELETE_RELEASE:
 911                         if user.rank.atLeast(UserRank.ADMIN):
 912                                 return True
 913
 914                         if not (isOwner or user.rank.atLeast(UserRank.EDITOR)):
 915                                 return False
 916
 917                         if not self.package.approved or self.task_id is not None:
 918                                 return True
 919
 920                         count = PackageRelease.query \
 921                                         .filter_by(package_id=self.package_id) \
 922                                         .filter(PackageRelease.id > self.id) \
 923                                         .count()
 924
 925                         return count > 0
 926                 else:
 927                         raise Exception("Permission {} is not related to releases".format(perm.name))
 928
 929
 930 # class PackageReview(db.Model):
 931 #       id         = db.Column(db.Integer, primary_key=True)
 932 #       package_id = db.Column(db.Integer, db.ForeignKey("package.id"))
 933 #       thread_id  = db.Column(db.Integer, db.ForeignKey("thread.id"), nullable=False)
 934 #       recommend  = db.Column(db.Boolean, nullable=False, default=True)
 935
 936
 937 class PackageScreenshot(db.Model):
 938         id         = db.Column(db.Integer, primary_key=True)
 939         package_id = db.Column(db.Integer, db.ForeignKey("package.id"))
 940         title      = db.Column(db.String(100), nullable=False)
 941         url        = db.Column(db.String(100), nullable=False)
 942         approved   = db.Column(db.Boolean, nullable=False, default=False)
 943
 944
 945         def getEditURL(self):
 946                 return url_for("packages.edit_screenshot",
 947                                 author=self.package.author.username,
 948                                 name=self.package.name,
 949                                 id=self.id)
 950
 951         def getThumbnailURL(self, level=2):
 952                 return self.url.replace("/uploads/", ("/thumbnails/{:d}/").format(level))
 953
 954
 955 class APIToken(db.Model):
 956         id           = db.Column(db.Integer, primary_key=True)
 957         access_token = db.Column(db.String(34), unique=True)
 958
 959         name         = db.Column(db.String(100), nullable=False)
 960         owner_id     = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
 961         # owner is created using backref
 962
 963         created_at   = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
 964
 965         package_id = db.Column(db.Integer, db.ForeignKey("package.id"), nullable=True)
 966         package    = db.relationship("Package", foreign_keys=[package_id])
 967
 968         def canOperateOnPackage(self, package):
 969                 if self.package and self.package != package:
 970                         return False
 971
 972                 return package.author == self.owner
 973
 974
 975 class EditRequest(db.Model):
 976         id           = db.Column(db.Integer, primary_key=True)
 977
 978         package_id   = db.Column(db.Integer, db.ForeignKey("package.id"))
 979         author_id    = db.Column(db.Integer, db.ForeignKey("user.id"))
 980
 981         title        = db.Column(db.String(100), nullable=False)
 982         desc         = db.Column(db.String(1000), nullable=True)
 983
 984         # 0 - open
 985         # 1 - merged
 986         # 2 - rejected
 987         status       = db.Column(db.Integer, nullable=False, default=0)
 988
 989         changes = db.relationship("EditRequestChange", backref="request",
 990                         lazy="dynamic")
 991
 992         def getURL(self):
 993                 return url_for("view_editrequest_page",
 994                                 author=self.package.author.username,
 995                                 name=self.package.name,
 996                                 id=self.id)
 997
 998         def getApproveURL(self):
 999                 return url_for("approve_editrequest_page",
1000                                 author=self.package.author.username,
1001                                 name=self.package.name,
1002                                 id=self.id)
1003
1004         def getRejectURL(self):
1005                 return url_for("reject_editrequest_page",
1006                                 author=self.package.author.username,
1007                                 name=self.package.name,
1008                                 id=self.id)
1009
1010         def getEditURL(self):
1011                 return url_for("create_edit_editrequest_page",
1012                                 author=self.package.author.username,
1013                                 name=self.package.name,
1014                                 id=self.id)
1015
1016         def applyAll(self, package):
1017                 for change in self.changes:
1018                         change.apply(package)
1019
1020
1021         def checkPerm(self, user, perm):
1022                 if not user.is_authenticated:
1023                         return False
1024
1025                 if type(perm) == str:
1026                         perm = Permission[perm]
1027                 elif type(perm) != Permission:
1028                         raise Exception("Unknown permission given to EditRequest.checkPerm()")
1029
1030                 isOwner = user == self.author
1031
1032                 # Members can edit their own packages, and editors can edit any packages
1033                 if perm == Permission.EDIT_EDITREQUEST:
1034                         return isOwner or user.rank.atLeast(UserRank.EDITOR)
1035
1036                 else:
1037                         raise Exception("Permission {} is not related to packages".format(perm.name))
1038
1039
1040
1041
1042 class EditRequestChange(db.Model):
1043         id           = db.Column(db.Integer, primary_key=True)
1044
1045         request_id   = db.Column(db.Integer, db.ForeignKey("edit_request.id"))
1046         key          = db.Column(db.Enum(PackagePropertyKey), nullable=False)
1047
1048         # TODO: make diff instead
1049         oldValue     = db.Column(db.Text, nullable=True)
1050         newValue     = db.Column(db.Text, nullable=True)
1051
1052         def apply(self, package):
1053                 if self.key == PackagePropertyKey.tags:
1054                         package.tags.clear()
1055                         for tagTitle in self.newValue.split(","):
1056                                 tag = Tag.query.filter_by(title=tagTitle.strip()).first()
1057                                 package.tags.append(tag)
1058
1059                 else:
1060                         setattr(package, self.key.name, self.newValue)
1061
1062
1063 watchers = db.Table("watchers",
1064     db.Column("user_id", db.Integer, db.ForeignKey("user.id"), primary_key=True),
1065     db.Column("thread_id", db.Integer, db.ForeignKey("thread.id"), primary_key=True)
1066 )
1067
1068 class Thread(db.Model):
1069         id         = db.Column(db.Integer, primary_key=True)
1070
1071         package_id = db.Column(db.Integer, db.ForeignKey("package.id"), nullable=True)
1072         package    = db.relationship("Package", foreign_keys=[package_id])
1073
1074         review_id = db.Column(db.Integer, db.ForeignKey("package_review.id"), nullable=True)
1075         review    = db.relationship("PackageReview", foreign_keys=[review_id])
1076
1077         author_id  = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
1078         title      = db.Column(db.String(100), nullable=False)
1079         private    = db.Column(db.Boolean, server_default="0")
1080
1081         created_at = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
1082
1083         replies    = db.relationship("ThreadReply", backref="thread", lazy="dynamic")
1084
1085         watchers   = db.relationship("User", secondary=watchers, lazy="subquery", \
1086                                                 backref=db.backref("watching", lazy=True))
1087
1088
1089         def getSubscribeURL(self):
1090                 return url_for("threads.subscribe",
1091                                 id=self.id)
1092
1093         def getUnsubscribeURL(self):
1094                 return url_for("threads.unsubscribe",
1095                                 id=self.id)
1096
1097         def checkPerm(self, user, perm):
1098                 if not user.is_authenticated:
1099                         return not self.private
1100
1101                 if type(perm) == str:
1102                         perm = Permission[perm]
1103                 elif type(perm) != Permission:
1104                         raise Exception("Unknown permission given to Thread.checkPerm()")
1105
1106                 isMaintainer = user == self.author or (self.package is not None and self.package.author == user)
1107                 if self.package:
1108                         isMaintainer = isMaintainer or user in self.package.maintainers
1109
1110                 if perm == Permission.SEE_THREAD:
1111                         return not self.private or isMaintainer or user.rank.atLeast(UserRank.EDITOR)
1112
1113                 else:
1114                         raise Exception("Permission {} is not related to threads".format(perm.name))
1115
1116 class ThreadReply(db.Model):
1117         id         = db.Column(db.Integer, primary_key=True)
1118         thread_id  = db.Column(db.Integer, db.ForeignKey("thread.id"), nullable=False)
1119         comment    = db.Column(db.String(500), nullable=False)
1120         author_id  = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
1121         created_at = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
1122
1123
1124 class PackageReview(db.Model):
1125         id         = db.Column(db.Integer, primary_key=True)
1126
1127         package_id = db.Column(db.Integer, db.ForeignKey("package.id"), nullable=True)
1128         package    = db.relationship("Package", foreign_keys=[package_id], backref=db.backref("reviews", lazy=True))
1129
1130         author_id  = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
1131         author     = db.relationship("User", foreign_keys=[author_id], backref=db.backref("reviews", lazy=True))
1132
1133         recommends = db.Column(db.Boolean, nullable=False)
1134
1135         thread     = db.relationship("Thread", uselist=False, back_populates="review")
1136
1137         def getEditURL(self):
1138                 return url_for("packages.edit_review",
1139                                 author=self.package.author.username,
1140                                 name=self.package.name,
1141                                 id=self.id)
1142
1143
1144
1145 REPO_BLACKLIST = [".zip", "mediafire.com", "dropbox.com", "weebly.com", \
1146                 "minetest.net", "dropboxusercontent.com", "4shared.com", \
1147                 "digitalaudioconcepts.com", "hg.intevation.org", "www.wtfpl.net", \
1148                 "imageshack.com", "imgur.com"]
1149
1150 class ForumTopic(db.Model):
1151         topic_id  = db.Column(db.Integer, primary_key=True, autoincrement=False)
1152         author_id = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
1153         author    = db.relationship("User")
1154
1155         wip       = db.Column(db.Boolean, server_default="0")
1156         discarded = db.Column(db.Boolean, server_default="0")
1157
1158         type      = db.Column(db.Enum(PackageType), nullable=False)
1159         title     = db.Column(db.String(200), nullable=False)
1160         name      = db.Column(db.String(30), nullable=True)
1161         link      = db.Column(db.String(200), nullable=True)
1162
1163         posts     = db.Column(db.Integer, nullable=False)
1164         views     = db.Column(db.Integer, nullable=False)
1165
1166         created_at = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
1167
1168         def getRepoURL(self):
1169                 if self.link is None:
1170                         return None
1171
1172                 for item in REPO_BLACKLIST:
1173                         if item in self.link:
1174                                 return None
1175
1176                 return self.link.replace("repo.or.cz/w/", "repo.or.cz/")
1177
1178         def getAsDictionary(self):
1179                 return {
1180                         "author": self.author.username,
1181                         "name":   self.name,
1182                         "type":   self.type.toName(),
1183                         "title":  self.title,
1184                         "id":     self.topic_id,
1185                         "link":   self.link,
1186                         "posts":  self.posts,
1187                         "views":  self.views,
1188                         "is_wip": self.wip,
1189                         "discarded":  self.discarded,
1190                         "created_at": self.created_at.isoformat(),
1191                 }
1192
1193         def checkPerm(self, user, perm):
1194                 if not user.is_authenticated:
1195                         return False
1196
1197                 if type(perm) == str:
1198                         perm = Permission[perm]
1199                 elif type(perm) != Permission:
1200                         raise Exception("Unknown permission given to ForumTopic.checkPerm()")
1201
1202                 if perm == Permission.TOPIC_DISCARD:
1203                         return self.author == user or user.rank.atLeast(UserRank.EDITOR)
1204
1205                 else:
1206                         raise Exception("Permission {} is not related to topics".format(perm.name))
1207
1208
1209 # Setup Flask-User
1210 user_manager = UserManager(app, db, User)
1211
1212 if app.config.get("LOG_SQL"):
1213         import logging
1214         logging.basicConfig()
1215         logging.getLogger('sqlalchemy.engine').setLevel(logging.INFO)