2 # Copyright (C) 2018 rubenwardy
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.
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.
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/>.
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
23 from datetime import datetime
24 from sqlalchemy.orm import validates
25 from flask_user import login_required, UserManager, UserMixin, SQLAlchemyAdapter
30 migrate = Migrate(app, db)
33 class UserRank(enum.Enum):
43 def atLeast(self, min):
44 return self.value >= min.value
47 return self.name.replace("_", " ").title()
50 return self.name.lower()
57 return [(choice, choice.getTitle()) for choice in cls]
60 def coerce(cls, item):
61 return item if type(item) == UserRank else UserRank[item]
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"
80 # Only return true if the permission is valid for *all* contexts
81 # See Package.checkPerm for package-specific contexts
82 def check(self, user):
83 if not user.is_authenticated:
86 if self == Permission.APPROVE_NEW or \
87 self == Permission.APPROVE_CHANGES or \
88 self == Permission.APPROVE_RELEASE or \
89 self == Permission.APPROVE_SCREENSHOT:
90 return user.rank.atLeast(UserRank.EDITOR)
92 raise Exception("Non-global permission checked globally. Use Package.checkPerm or User.checkPerm instead.")
95 class User(db.Model, UserMixin):
96 id = db.Column(db.Integer, primary_key=True)
98 # User authentication information
99 username = db.Column(db.String(50), nullable=False, unique=True)
100 password = db.Column(db.String(255), nullable=True)
101 reset_password_token = db.Column(db.String(100), nullable=False, server_default="")
103 rank = db.Column(db.Enum(UserRank))
106 github_username = db.Column(db.String(50), nullable=True, unique=True)
107 forums_username = db.Column(db.String(50), nullable=True, unique=True)
109 # User email information
110 email = db.Column(db.String(255), nullable=True, unique=True)
111 confirmed_at = db.Column(db.DateTime())
114 active = db.Column("is_active", db.Boolean, nullable=False, server_default="0")
115 display_name = db.Column(db.String(100), nullable=False, server_default="")
118 notifications = db.relationship("Notification", primaryjoin="User.id==Notification.user_id")
120 # causednotifs = db.relationship("Notification", backref="causer", lazy="dynamic")
121 packages = db.relationship("Package", backref="author", lazy="dynamic")
122 requests = db.relationship("EditRequest", backref="author", lazy="dynamic")
124 def __init__(self, username, active=False, email=None, password=None):
127 self.username = username
128 self.confirmed_at = datetime.datetime.now() - datetime.timedelta(days=6000)
129 self.display_name = username
132 self.password = password
133 self.rank = UserRank.NOT_JOINED
135 def canAccessTodoList(self):
136 return Permission.APPROVE_NEW.check(self) or \
137 Permission.APPROVE_RELEASE.check(self) or \
138 Permission.APPROVE_CHANGES.check(self)
141 return self.rank.atLeast(UserRank.NEW_MEMBER)
143 def checkPerm(self, user, perm):
144 if not user.is_authenticated:
147 if type(perm) == str:
148 perm = Permission[perm]
149 elif type(perm) != Permission:
150 raise Exception("Unknown permission given to User.checkPerm()")
152 # Members can edit their own packages, and editors can edit any packages
153 if perm == Permission.CHANGE_AUTHOR:
154 return user.rank.atLeast(UserRank.EDITOR)
155 elif perm == Permission.CHANGE_RANK or perm == Permission.CHANGE_DNAME:
156 return user.rank.atLeast(UserRank.MODERATOR)
157 elif perm == Permission.CHANGE_EMAIL:
158 return user == self or (user.rank.atLeast(UserRank.MODERATOR) and user.rank.atLeast(self.rank))
160 raise Exception("Permission {} is not related to users".format(perm.name))
162 class UserEmailVerification(db.Model):
163 id = db.Column(db.Integer, primary_key=True)
164 user_id = db.Column(db.Integer, db.ForeignKey("user.id"))
165 email = db.Column(db.String(100))
166 token = db.Column(db.String(32))
167 user = db.relationship("User", foreign_keys=[user_id])
169 class Notification(db.Model):
170 id = db.Column(db.Integer, primary_key=True)
171 user_id = db.Column(db.Integer, db.ForeignKey("user.id"))
172 causer_id = db.Column(db.Integer, db.ForeignKey("user.id"))
173 user = db.relationship("User", foreign_keys=[user_id])
174 causer = db.relationship("User", foreign_keys=[causer_id])
176 title = db.Column(db.String(100), nullable=False)
177 url = db.Column(db.String(200), nullable=True)
179 def __init__(self, us, cau, titl, ur):
186 class License(db.Model):
187 id = db.Column(db.Integer, primary_key=True)
188 name = db.Column(db.String(50), nullable=False, unique=True)
189 is_foss = db.Column(db.Boolean, nullable=False, default=True)
191 def __init__(self, v, is_foss=True):
193 self.is_foss = is_foss
199 class PackageType(enum.Enum):
205 return self.name.lower()
212 return [(choice, choice.value) for choice in cls]
215 def coerce(cls, item):
216 return item if type(item) == PackageType else PackageType[item]
219 class PackagePropertyKey(enum.Enum):
222 shortDesc = "Short Description"
226 media_license = "Media License"
228 provides = "Provides"
231 issueTracker = "Issue Tracker"
232 forums = "Forum Topic ID"
234 def convert(self, value):
235 if self == PackagePropertyKey.tags:
236 return ",".join([t.title for t in value])
237 elif self == PackagePropertyKey.provides:
238 return ",".join([t.name for t in value])
242 provides = db.Table("provides",
243 db.Column("package_id", db.Integer, db.ForeignKey("package.id"), primary_key=True),
244 db.Column("metapackage_id", db.Integer, db.ForeignKey("meta_package.id"), primary_key=True)
247 tags = db.Table("tags",
248 db.Column("tag_id", db.Integer, db.ForeignKey("tag.id"), primary_key=True),
249 db.Column("package_id", db.Integer, db.ForeignKey("package.id"), primary_key=True)
252 class Dependency(db.Model):
253 id = db.Column(db.Integer, primary_key=True)
254 depender_id = db.Column(db.Integer, db.ForeignKey("package.id"), nullable=True)
255 package_id = db.Column(db.Integer, db.ForeignKey("package.id"), nullable=True)
256 package = db.relationship("Package", foreign_keys=[package_id])
257 meta_package_id = db.Column(db.Integer, db.ForeignKey("meta_package.id"), nullable=True)
258 optional = db.Column(db.Boolean, nullable=False, default=False)
259 __table_args__ = (db.UniqueConstraint('depender_id', 'package_id', 'meta_package_id', name='_dependency_uc'), )
261 def __init__(self, depender=None, package=None, meta=None):
265 self.depender = depender
267 packageProvided = package is not None
268 metaProvided = meta is not None
270 if packageProvided and not metaProvided:
271 self.package = package
272 elif metaProvided and not packageProvided:
273 self.meta_package = meta
275 raise Exception("Either meta or package must be given, but not both!")
278 if self.package is not None:
279 return self.package.author.username + "/" + self.package.name
280 elif self.meta_package is not None:
281 return self.meta_package.name
283 raise Exception("Meta and package are both none!")
286 def SpecToList(depender, spec, cache={}):
288 arr = spec.split(",")
291 pattern1 = re.compile("^([a-z0-9_]+)$")
292 pattern2 = re.compile("^([A-Za-z0-9_]+)/([a-z0-9_]+)$")
299 if pattern1.match(x):
300 meta = MetaPackage.GetOrCreate(x, cache)
301 retval.append(Dependency(depender, meta=meta))
303 m = pattern2.match(x)
304 username = m.group(1)
306 user = User.query.filter_by(username=username).first()
308 raise Exception("Unable to find user " + username)
310 package = Package.query.filter_by(author=user, name=name).first()
312 raise Exception("Unable to find package " + name + " by " + username)
314 retval.append(Dependency(depender, package=package))
320 class Package(db.Model):
321 id = db.Column(db.Integer, primary_key=True)
324 author_id = db.Column(db.Integer, db.ForeignKey("user.id"))
325 name = db.Column(db.String(100), nullable=False)
326 title = db.Column(db.String(100), nullable=False)
327 shortDesc = db.Column(db.String(200), nullable=False)
328 desc = db.Column(db.Text, nullable=True)
329 type = db.Column(db.Enum(PackageType))
330 created_at = db.Column(db.DateTime, nullable=False, default=datetime.utcnow)
332 license_id = db.Column(db.Integer, db.ForeignKey("license.id"), nullable=False, default=1)
333 license = db.relationship("License", foreign_keys=[license_id])
334 media_license_id = db.Column(db.Integer, db.ForeignKey("license.id"), nullable=False, default=1)
335 media_license = db.relationship("License", foreign_keys=[media_license_id])
337 approved = db.Column(db.Boolean, nullable=False, default=False)
338 soft_deleted = db.Column(db.Boolean, nullable=False, default=False)
341 repo = db.Column(db.String(200), nullable=True)
342 website = db.Column(db.String(200), nullable=True)
343 issueTracker = db.Column(db.String(200), nullable=True)
344 forums = db.Column(db.Integer, nullable=True)
346 provides = db.relationship("MetaPackage", secondary=provides, lazy="subquery",
347 backref=db.backref("packages", lazy="dynamic"))
349 dependencies = db.relationship("Dependency", backref="depender", lazy="dynamic", foreign_keys=[Dependency.depender_id])
351 tags = db.relationship("Tag", secondary=tags, lazy="subquery",
352 backref=db.backref("packages", lazy=True))
354 releases = db.relationship("PackageRelease", backref="package",
355 lazy="dynamic", order_by=db.desc("package_release_releaseDate"))
357 screenshots = db.relationship("PackageScreenshot", backref="package",
360 requests = db.relationship("EditRequest", backref="package",
363 def __init__(self, package=None):
367 self.author_id = package.author_id
368 self.created_at = package.created_at
369 self.approved = package.approved
371 for e in PackagePropertyKey:
372 setattr(self, e.name, getattr(package, e.name))
374 def getAsDictionary(self, base_url):
375 tnurl = self.getThumbnailURL()
379 "author": self.author.display_name,
380 "shortDesc": self.shortDesc,
381 "type": self.type.toName(),
382 "license": self.license.name,
384 "url": base_url + self.getDownloadURL(),
385 "release": self.getDownloadRelease().id if self.getDownloadRelease() is not None else None,
386 "screenshots": [base_url + ss.url for ss in self.screenshots],
387 "thumbnail": (base_url + tnurl) if tnurl is not None else None
390 def getThumbnailURL(self):
391 screenshot = self.screenshots.filter_by(approved=True).first()
392 return screenshot.getThumbnailURL() if screenshot is not None else None
394 def getMainScreenshotURL(self):
395 screenshot = self.screenshots.filter_by(approved=True).first()
396 return screenshot.url if screenshot is not None else None
398 def getDetailsURL(self):
399 return url_for("package_page",
400 author=self.author.username, name=self.name)
402 def getEditURL(self):
403 return url_for("create_edit_package_page",
404 author=self.author.username, name=self.name)
406 def getApproveURL(self):
407 return url_for("approve_package_page",
408 author=self.author.username, name=self.name)
410 def getDeleteURL(self):
411 return url_for("delete_package_page",
412 author=self.author.username, name=self.name)
414 def getNewScreenshotURL(self):
415 return url_for("create_screenshot_page",
416 author=self.author.username, name=self.name)
418 def getCreateReleaseURL(self):
419 return url_for("create_release_page",
420 author=self.author.username, name=self.name)
422 def getCreateEditRequestURL(self):
423 return url_for("create_edit_editrequest_page",
424 author=self.author.username, name=self.name)
426 def getDownloadURL(self):
427 return url_for("package_download_page",
428 author=self.author.username, name=self.name)
430 def getDownloadRelease(self):
431 for rel in self.releases:
437 def canImportScreenshot(self):
438 if self.repo is None:
441 url = urlparse(self.repo)
442 if url.netloc == "github.com":
447 def canMakeReleaseFromVCS(self):
448 if self.repo is None:
451 url = urlparse(self.repo)
452 if url.netloc == "github.com":
457 def checkPerm(self, user, perm):
458 if not user.is_authenticated:
461 if type(perm) == str:
462 perm = Permission[perm]
463 elif type(perm) != Permission:
464 raise Exception("Unknown permission given to Package.checkPerm()")
466 isOwner = user == self.author
468 # Members can edit their own packages, and editors can edit any packages
469 if perm == Permission.MAKE_RELEASE or perm == Permission.ADD_SCREENSHOTS:
470 return isOwner or user.rank.atLeast(UserRank.EDITOR)
472 if perm == Permission.EDIT_PACKAGE or perm == Permission.APPROVE_CHANGES:
474 return user.rank.atLeast(UserRank.MEMBER if self.approved else UserRank.NEW_MEMBER)
476 return user.rank.atLeast(UserRank.EDITOR)
478 # Editors can change authors
479 elif perm == Permission.CHANGE_AUTHOR:
480 return user.rank.atLeast(UserRank.EDITOR)
482 elif perm == Permission.APPROVE_NEW or perm == Permission.APPROVE_RELEASE \
483 or perm == Permission.APPROVE_SCREENSHOT:
484 return user.rank.atLeast(UserRank.TRUSTED_MEMBER if isOwner else UserRank.EDITOR)
486 # Moderators can delete packages
487 elif perm == Permission.DELETE_PACKAGE or perm == Permission.CHANGE_RELEASE_URL:
488 return user.rank.atLeast(UserRank.MODERATOR)
491 raise Exception("Permission {} is not related to packages".format(perm.name))
493 class MetaPackage(db.Model):
494 id = db.Column(db.Integer, primary_key=True)
495 name = db.Column(db.String(100), unique=True, nullable=False)
496 dependencies = db.relationship("Dependency", backref="meta_package", lazy="dynamic")
498 def __init__(self, name=None):
505 def ListToSpec(list):
506 return ",".join([str(x) for x in list])
509 def GetOrCreate(name, cache={}):
512 mp = MetaPackage.query.filter_by(name=name).first()
515 mp = MetaPackage(name)
522 def SpecToList(spec, cache={}):
524 arr = spec.split(",")
527 pattern = re.compile("^([a-z0-9_]+)$")
534 if not pattern.match(x):
537 retval.append(MetaPackage.GetOrCreate(x, cache))
542 id = db.Column(db.Integer, primary_key=True)
543 name = db.Column(db.String(100), unique=True, nullable=False)
544 title = db.Column(db.String(100), nullable=False)
545 backgroundColor = db.Column(db.String(6), nullable=False)
546 textColor = db.Column(db.String(6), nullable=False)
548 def __init__(self, title, backgroundColor="000000", textColor="ffffff"):
550 self.backgroundColor = backgroundColor
551 self.textColor = textColor
554 regex = re.compile("[^a-z_]")
555 self.name = regex.sub("", self.title.lower().replace(" ", "_"))
557 class PackageRelease(db.Model):
558 id = db.Column(db.Integer, primary_key=True)
560 package_id = db.Column(db.Integer, db.ForeignKey("package.id"))
561 title = db.Column(db.String(100), nullable=False)
562 releaseDate = db.Column(db.DateTime, nullable=False)
563 url = db.Column(db.String(200), nullable=False)
564 approved = db.Column(db.Boolean, nullable=False, default=False)
565 task_id = db.Column(db.String(37), nullable=True)
568 def getEditURL(self):
569 return url_for("edit_release_page",
570 author=self.package.author.username,
571 name=self.package.name,
575 self.releaseDate = datetime.now()
577 class PackageScreenshot(db.Model):
578 id = db.Column(db.Integer, primary_key=True)
579 package_id = db.Column(db.Integer, db.ForeignKey("package.id"))
580 title = db.Column(db.String(100), nullable=False)
581 url = db.Column(db.String(100), nullable=False)
582 approved = db.Column(db.Boolean, nullable=False, default=False)
585 def getEditURL(self):
586 return url_for("edit_screenshot_page",
587 author=self.package.author.username,
588 name=self.package.name,
591 def getThumbnailURL(self):
592 return self.url.replace("/uploads/", "/thumbnails/350x233/")
594 class EditRequest(db.Model):
595 id = db.Column(db.Integer, primary_key=True)
597 package_id = db.Column(db.Integer, db.ForeignKey("package.id"))
598 author_id = db.Column(db.Integer, db.ForeignKey("user.id"))
600 title = db.Column(db.String(100), nullable=False)
601 desc = db.Column(db.String(1000), nullable=True)
606 status = db.Column(db.Integer, nullable=False, default=0)
608 changes = db.relationship("EditRequestChange", backref="request",
612 return url_for("view_editrequest_page",
613 author=self.package.author.username,
614 name=self.package.name,
617 def getApproveURL(self):
618 return url_for("approve_editrequest_page",
619 author=self.package.author.username,
620 name=self.package.name,
623 def getRejectURL(self):
624 return url_for("reject_editrequest_page",
625 author=self.package.author.username,
626 name=self.package.name,
629 def getEditURL(self):
630 return url_for("create_edit_editrequest_page",
631 author=self.package.author.username,
632 name=self.package.name,
635 def applyAll(self, package):
636 for change in self.changes:
637 change.apply(package)
640 def checkPerm(self, user, perm):
641 if not user.is_authenticated:
644 if type(perm) == str:
645 perm = Permission[perm]
646 elif type(perm) != Permission:
647 raise Exception("Unknown permission given to EditRequest.checkPerm()")
649 isOwner = user == self.author
651 # Members can edit their own packages, and editors can edit any packages
652 if perm == Permission.EDIT_EDITREQUEST:
653 return isOwner or user.rank.atLeast(UserRank.EDITOR)
656 raise Exception("Permission {} is not related to packages".format(perm.name))
661 class EditRequestChange(db.Model):
662 id = db.Column(db.Integer, primary_key=True)
664 request_id = db.Column(db.Integer, db.ForeignKey("edit_request.id"))
665 key = db.Column(db.Enum(PackagePropertyKey), nullable=False)
667 # TODO: make diff instead
668 oldValue = db.Column(db.Text, nullable=True)
669 newValue = db.Column(db.Text, nullable=True)
671 def apply(self, package):
672 if self.key == PackagePropertyKey.tags:
674 for tagTitle in self.newValue.split(","):
675 tag = Tag.query.filter_by(title=tagTitle.strip()).first()
676 package.tags.append(tag)
679 setattr(package, self.key.name, self.newValue)
682 db_adapter = SQLAlchemyAdapter(db, User) # Register the User model
683 user_manager = UserManager(db_adapter, app) # Initialize Flask-User