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=False, server_default="")
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):
127 self.username = username
128 self.confirmed_at = datetime.datetime.now() - datetime.timedelta(days=6000)
129 self.display_name = username
130 self.rank = UserRank.NOT_JOINED
132 def canAccessTodoList(self):
133 return Permission.APPROVE_NEW.check(self) or \
134 Permission.APPROVE_RELEASE.check(self) or \
135 Permission.APPROVE_CHANGES.check(self)
138 return self.rank.atLeast(UserRank.NEW_MEMBER)
140 def checkPerm(self, user, perm):
141 if not user.is_authenticated:
144 if type(perm) == str:
145 perm = Permission[perm]
146 elif type(perm) != Permission:
147 raise Exception("Unknown permission given to User.checkPerm()")
149 # Members can edit their own packages, and editors can edit any packages
150 if perm == Permission.CHANGE_AUTHOR:
151 return user.rank.atLeast(UserRank.EDITOR)
152 elif perm == Permission.CHANGE_RANK or perm == Permission.CHANGE_DNAME:
153 return user.rank.atLeast(UserRank.MODERATOR)
154 elif perm == Permission.CHANGE_EMAIL:
155 return user == self or (user.rank.atLeast(UserRank.MODERATOR) and user.rank.atLeast(self.rank))
157 raise Exception("Permission {} is not related to users".format(perm.name))
159 class UserEmailVerification(db.Model):
160 id = db.Column(db.Integer, primary_key=True)
161 user_id = db.Column(db.Integer, db.ForeignKey("user.id"))
162 email = db.Column(db.String(100))
163 token = db.Column(db.String(32))
164 user = db.relationship("User", foreign_keys=[user_id])
166 class Notification(db.Model):
167 id = db.Column(db.Integer, primary_key=True)
168 user_id = db.Column(db.Integer, db.ForeignKey("user.id"))
169 causer_id = db.Column(db.Integer, db.ForeignKey("user.id"))
170 user = db.relationship("User", foreign_keys=[user_id])
171 causer = db.relationship("User", foreign_keys=[causer_id])
173 title = db.Column(db.String(100), nullable=False)
174 url = db.Column(db.String(200), nullable=True)
176 def __init__(self, us, cau, titl, ur):
183 class License(db.Model):
184 id = db.Column(db.Integer, primary_key=True)
185 name = db.Column(db.String(50), nullable=False, unique=True)
186 packages = db.relationship("Package", backref="license", lazy="dynamic")
188 def __init__(self, v):
195 class PackageType(enum.Enum):
201 return self.name.lower()
208 return [(choice, choice.value) for choice in cls]
211 def coerce(cls, item):
212 return item if type(item) == PackageType else PackageType[item]
215 class PackagePropertyKey(enum.Enum):
218 shortDesc = "Short Description"
223 provides = "Provides"
226 issueTracker = "Issue Tracker"
227 forums = "Forum Topic ID"
229 def convert(self, value):
230 if self == PackagePropertyKey.tags:
231 return ",".join([t.title for t in value])
232 elif self == PackagePropertyKey.provides:
233 return ",".join([t.name for t in value])
237 provides = db.Table("provides",
238 db.Column("package_id", db.Integer, db.ForeignKey("package.id"), primary_key=True),
239 db.Column("metapackage_id", db.Integer, db.ForeignKey("meta_package.id"), primary_key=True)
242 tags = db.Table("tags",
243 db.Column("tag_id", db.Integer, db.ForeignKey("tag.id"), primary_key=True),
244 db.Column("package_id", db.Integer, db.ForeignKey("package.id"), primary_key=True)
247 class Dependency(db.Model):
248 id = db.Column(db.Integer, primary_key=True)
249 depender_id = db.Column(db.Integer, db.ForeignKey("package.id"), nullable=True)
250 package_id = db.Column(db.Integer, db.ForeignKey("package.id"), nullable=True)
251 package = db.relationship("Package", foreign_keys=[package_id])
252 meta_package_id = db.Column(db.Integer, db.ForeignKey("meta_package.id"), nullable=True)
253 optional = db.Column(db.Boolean, nullable=False, default=False)
254 __table_args__ = (db.UniqueConstraint('depender_id', 'package_id', 'meta_package_id', name='_dependency_uc'), )
256 def __init__(self, depender=None, package=None, meta=None):
260 self.depender = depender
262 packageProvided = package is not None
263 metaProvided = meta is not None
265 if packageProvided and not metaProvided:
266 self.package = package
267 elif metaProvided and not packageProvided:
268 self.meta_package = meta
270 raise Exception("Either meta or package must be given, but not both!")
273 if self.package is not None:
274 return self.package.author.username + "/" + self.package.name
275 elif self.meta_package is not None:
276 return self.meta_package.name
278 raise Exception("Meta and package are both none!")
281 def SpecToList(depender, spec, cache={}):
283 arr = spec.split(",")
286 pattern1 = re.compile("^([a-z0-9_]+)$")
287 pattern2 = re.compile("^([A-Za-z0-9_]+)/([a-z0-9_]+)$")
294 if pattern1.match(x):
295 meta = MetaPackage.GetOrCreate(x, cache)
296 retval.append(Dependency(depender, meta=meta))
298 m = pattern2.match(x)
299 username = m.group(1)
301 user = User.query.filter_by(username=username).first()
303 raise Exception("Unable to find user " + username)
305 package = Package.query.filter_by(author=user, name=name).first()
307 raise Exception("Unable to find package " + name + " by " + username)
309 retval.append(Dependency(depender, package=package))
315 class Package(db.Model):
316 id = db.Column(db.Integer, primary_key=True)
319 author_id = db.Column(db.Integer, db.ForeignKey("user.id"))
320 name = db.Column(db.String(100), nullable=False)
321 title = db.Column(db.String(100), nullable=False)
322 shortDesc = db.Column(db.String(200), nullable=False)
323 desc = db.Column(db.Text, nullable=True)
324 type = db.Column(db.Enum(PackageType))
325 created_at = db.Column(db.DateTime, nullable=False, default=datetime.utcnow)
327 license_id = db.Column(db.Integer, db.ForeignKey("license.id"))
329 approved = db.Column(db.Boolean, nullable=False, default=False)
330 soft_deleted = db.Column(db.Boolean, nullable=False, default=False)
333 repo = db.Column(db.String(200), nullable=True)
334 website = db.Column(db.String(200), nullable=True)
335 issueTracker = db.Column(db.String(200), nullable=True)
336 forums = db.Column(db.Integer, nullable=True)
338 provides = db.relationship("MetaPackage", secondary=provides, lazy="subquery",
339 backref=db.backref("packages", lazy=True))
341 dependencies = db.relationship("Dependency", backref="depender", lazy="dynamic", foreign_keys=[Dependency.depender_id])
343 tags = db.relationship("Tag", secondary=tags, lazy="subquery",
344 backref=db.backref("packages", lazy=True))
346 releases = db.relationship("PackageRelease", backref="package",
347 lazy="dynamic", order_by=db.desc("package_release_releaseDate"))
349 screenshots = db.relationship("PackageScreenshot", backref="package",
352 requests = db.relationship("EditRequest", backref="package",
355 def __init__(self, package=None):
359 self.author_id = package.author_id
360 self.created_at = package.created_at
361 self.approved = package.approved
363 for e in PackagePropertyKey:
364 setattr(self, e.name, getattr(package, e.name))
366 def getAsDictionary(self, base_url):
370 "author": self.author.display_name,
371 "shortDesc": self.shortDesc,
372 "type": self.type.toName(),
373 "license": self.license.name,
375 "url": base_url + self.getDownloadURL(),
376 "release": self.getDownloadRelease().id if self.getDownloadRelease() is not None else None,
377 "screenshots": [base_url + ss.url for ss in self.screenshots],
378 "thumbnail": base_url + self.getThumbnailURL()
381 def getThumbnailURL(self):
382 screenshot = self.screenshots.filter_by(approved=True).first()
383 return screenshot.getThumbnailURL() if screenshot is not None else None
385 def getMainScreenshotURL(self):
386 screenshot = self.screenshots.filter_by(approved=True).first()
387 return screenshot.url if screenshot is not None else None
389 def getDetailsURL(self):
390 return url_for("package_page",
391 author=self.author.username, name=self.name)
393 def getEditURL(self):
394 return url_for("create_edit_package_page",
395 author=self.author.username, name=self.name)
397 def getApproveURL(self):
398 return url_for("approve_package_page",
399 author=self.author.username, name=self.name)
401 def getDeleteURL(self):
402 return url_for("delete_package_page",
403 author=self.author.username, name=self.name)
405 def getNewScreenshotURL(self):
406 return url_for("create_screenshot_page",
407 author=self.author.username, name=self.name)
409 def getCreateReleaseURL(self):
410 return url_for("create_release_page",
411 author=self.author.username, name=self.name)
413 def getCreateEditRequestURL(self):
414 return url_for("create_edit_editrequest_page",
415 author=self.author.username, name=self.name)
417 def getDownloadURL(self):
418 return url_for("package_download_page",
419 author=self.author.username, name=self.name)
421 def getDownloadRelease(self):
422 for rel in self.releases:
428 def canImportScreenshot(self):
429 if self.repo is None:
432 url = urlparse(self.repo)
433 if url.netloc == "github.com":
438 def canMakeReleaseFromVCS(self):
439 if self.repo is None:
442 url = urlparse(self.repo)
443 if url.netloc == "github.com":
448 def checkPerm(self, user, perm):
449 if not user.is_authenticated:
452 if type(perm) == str:
453 perm = Permission[perm]
454 elif type(perm) != Permission:
455 raise Exception("Unknown permission given to Package.checkPerm()")
457 isOwner = user == self.author
459 # Members can edit their own packages, and editors can edit any packages
460 if perm == Permission.MAKE_RELEASE or perm == Permission.ADD_SCREENSHOTS:
461 return isOwner or user.rank.atLeast(UserRank.EDITOR)
463 if perm == Permission.EDIT_PACKAGE or perm == Permission.APPROVE_CHANGES:
465 return user.rank.atLeast(UserRank.MEMBER if self.approved else UserRank.NEW_MEMBER)
467 return user.rank.atLeast(UserRank.EDITOR)
469 # Editors can change authors
470 elif perm == Permission.CHANGE_AUTHOR:
471 return user.rank.atLeast(UserRank.EDITOR)
473 elif perm == Permission.APPROVE_NEW or perm == Permission.APPROVE_RELEASE \
474 or perm == Permission.APPROVE_SCREENSHOT:
475 return user.rank.atLeast(UserRank.TRUSTED_MEMBER if isOwner else UserRank.EDITOR)
477 # Moderators can delete packages
478 elif perm == Permission.DELETE_PACKAGE or perm == Permission.CHANGE_RELEASE_URL:
479 return user.rank.atLeast(UserRank.MODERATOR)
482 raise Exception("Permission {} is not related to packages".format(perm.name))
484 class MetaPackage(db.Model):
485 id = db.Column(db.Integer, primary_key=True)
486 name = db.Column(db.String(100), unique=True, nullable=False)
487 dependencies = db.relationship("Dependency", backref="meta_package", lazy="dynamic")
489 def __init__(self, name=None):
496 def ListToSpec(list):
497 return ",".join([str(x) for x in list])
500 def GetOrCreate(name, cache={}):
503 mp = MetaPackage.query.filter_by(name=name).first()
506 mp = MetaPackage(name)
513 def SpecToList(spec, cache={}):
515 arr = spec.split(",")
518 pattern = re.compile("^([a-z0-9_]+)$")
525 if not pattern.match(x):
528 retval.append(MetaPackage.GetOrCreate(x, cache))
533 id = db.Column(db.Integer, primary_key=True)
534 name = db.Column(db.String(100), unique=True, nullable=False)
535 title = db.Column(db.String(100), nullable=False)
536 backgroundColor = db.Column(db.String(6), nullable=False)
537 textColor = db.Column(db.String(6), nullable=False)
539 def __init__(self, title, backgroundColor="000000", textColor="ffffff"):
541 self.backgroundColor = backgroundColor
542 self.textColor = textColor
545 regex = re.compile("[^a-z_]")
546 self.name = regex.sub("", self.title.lower().replace(" ", "_"))
548 class PackageRelease(db.Model):
549 id = db.Column(db.Integer, primary_key=True)
551 package_id = db.Column(db.Integer, db.ForeignKey("package.id"))
552 title = db.Column(db.String(100), nullable=False)
553 releaseDate = db.Column(db.DateTime, nullable=False)
554 url = db.Column(db.String(200), nullable=False)
555 approved = db.Column(db.Boolean, nullable=False, default=False)
556 task_id = db.Column(db.String(37), nullable=True)
559 def getEditURL(self):
560 return url_for("edit_release_page",
561 author=self.package.author.username,
562 name=self.package.name,
566 self.releaseDate = datetime.now()
568 class PackageScreenshot(db.Model):
569 id = db.Column(db.Integer, primary_key=True)
570 package_id = db.Column(db.Integer, db.ForeignKey("package.id"))
571 title = db.Column(db.String(100), nullable=False)
572 url = db.Column(db.String(100), nullable=False)
573 approved = db.Column(db.Boolean, nullable=False, default=False)
576 def getEditURL(self):
577 return url_for("edit_screenshot_page",
578 author=self.package.author.username,
579 name=self.package.name,
582 def getThumbnailURL(self):
583 return self.url.replace("/uploads/", "/thumbnails/350x233/")
585 class EditRequest(db.Model):
586 id = db.Column(db.Integer, primary_key=True)
588 package_id = db.Column(db.Integer, db.ForeignKey("package.id"))
589 author_id = db.Column(db.Integer, db.ForeignKey("user.id"))
591 title = db.Column(db.String(100), nullable=False)
592 desc = db.Column(db.String(1000), nullable=True)
597 status = db.Column(db.Integer, nullable=False, default=0)
599 changes = db.relationship("EditRequestChange", backref="request",
603 return url_for("view_editrequest_page",
604 author=self.package.author.username,
605 name=self.package.name,
608 def getApproveURL(self):
609 return url_for("approve_editrequest_page",
610 author=self.package.author.username,
611 name=self.package.name,
614 def getRejectURL(self):
615 return url_for("reject_editrequest_page",
616 author=self.package.author.username,
617 name=self.package.name,
620 def getEditURL(self):
621 return url_for("create_edit_editrequest_page",
622 author=self.package.author.username,
623 name=self.package.name,
626 def applyAll(self, package):
627 for change in self.changes:
628 change.apply(package)
631 def checkPerm(self, user, perm):
632 if not user.is_authenticated:
635 if type(perm) == str:
636 perm = Permission[perm]
637 elif type(perm) != Permission:
638 raise Exception("Unknown permission given to EditRequest.checkPerm()")
640 isOwner = user == self.author
642 # Members can edit their own packages, and editors can edit any packages
643 if perm == Permission.EDIT_EDITREQUEST:
644 return isOwner or user.rank.atLeast(UserRank.EDITOR)
647 raise Exception("Permission {} is not related to packages".format(perm.name))
652 class EditRequestChange(db.Model):
653 id = db.Column(db.Integer, primary_key=True)
655 request_id = db.Column(db.Integer, db.ForeignKey("edit_request.id"))
656 key = db.Column(db.Enum(PackagePropertyKey), nullable=False)
658 # TODO: make diff instead
659 oldValue = db.Column(db.Text, nullable=True)
660 newValue = db.Column(db.Text, nullable=True)
662 def apply(self, package):
663 if self.key == PackagePropertyKey.tags:
665 for tagTitle in self.newValue.split(","):
666 tag = Tag.query.filter_by(title=tagTitle.strip()).first()
667 package.tags.append(tag)
670 setattr(package, self.key.name, self.newValue)
673 db_adapter = SQLAlchemyAdapter(db, User) # Register the User model
674 user_manager = UserManager(db_adapter, app) # Initialize Flask-User