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 packages = db.relationship("Package", backref="license", lazy="dynamic")
191 def __init__(self, v):
198 class PackageType(enum.Enum):
204 return self.name.lower()
211 return [(choice, choice.value) for choice in cls]
214 def coerce(cls, item):
215 return item if type(item) == PackageType else PackageType[item]
218 class PackagePropertyKey(enum.Enum):
221 shortDesc = "Short Description"
226 provides = "Provides"
229 issueTracker = "Issue Tracker"
230 forums = "Forum Topic ID"
232 def convert(self, value):
233 if self == PackagePropertyKey.tags:
234 return ",".join([t.title for t in value])
235 elif self == PackagePropertyKey.provides:
236 return ",".join([t.name for t in value])
240 provides = db.Table("provides",
241 db.Column("package_id", db.Integer, db.ForeignKey("package.id"), primary_key=True),
242 db.Column("metapackage_id", db.Integer, db.ForeignKey("meta_package.id"), primary_key=True)
245 tags = db.Table("tags",
246 db.Column("tag_id", db.Integer, db.ForeignKey("tag.id"), primary_key=True),
247 db.Column("package_id", db.Integer, db.ForeignKey("package.id"), primary_key=True)
250 class Dependency(db.Model):
251 id = db.Column(db.Integer, primary_key=True)
252 depender_id = db.Column(db.Integer, db.ForeignKey("package.id"), nullable=True)
253 package_id = db.Column(db.Integer, db.ForeignKey("package.id"), nullable=True)
254 package = db.relationship("Package", foreign_keys=[package_id])
255 meta_package_id = db.Column(db.Integer, db.ForeignKey("meta_package.id"), nullable=True)
256 optional = db.Column(db.Boolean, nullable=False, default=False)
257 __table_args__ = (db.UniqueConstraint('depender_id', 'package_id', 'meta_package_id', name='_dependency_uc'), )
259 def __init__(self, depender=None, package=None, meta=None):
263 self.depender = depender
265 packageProvided = package is not None
266 metaProvided = meta is not None
268 if packageProvided and not metaProvided:
269 self.package = package
270 elif metaProvided and not packageProvided:
271 self.meta_package = meta
273 raise Exception("Either meta or package must be given, but not both!")
276 if self.package is not None:
277 return self.package.author.username + "/" + self.package.name
278 elif self.meta_package is not None:
279 return self.meta_package.name
281 raise Exception("Meta and package are both none!")
284 def SpecToList(depender, spec, cache={}):
286 arr = spec.split(",")
289 pattern1 = re.compile("^([a-z0-9_]+)$")
290 pattern2 = re.compile("^([A-Za-z0-9_]+)/([a-z0-9_]+)$")
297 if pattern1.match(x):
298 meta = MetaPackage.GetOrCreate(x, cache)
299 retval.append(Dependency(depender, meta=meta))
301 m = pattern2.match(x)
302 username = m.group(1)
304 user = User.query.filter_by(username=username).first()
306 raise Exception("Unable to find user " + username)
308 package = Package.query.filter_by(author=user, name=name).first()
310 raise Exception("Unable to find package " + name + " by " + username)
312 retval.append(Dependency(depender, package=package))
318 class Package(db.Model):
319 id = db.Column(db.Integer, primary_key=True)
322 author_id = db.Column(db.Integer, db.ForeignKey("user.id"))
323 name = db.Column(db.String(100), nullable=False)
324 title = db.Column(db.String(100), nullable=False)
325 shortDesc = db.Column(db.String(200), nullable=False)
326 desc = db.Column(db.Text, nullable=True)
327 type = db.Column(db.Enum(PackageType))
328 created_at = db.Column(db.DateTime, nullable=False, default=datetime.utcnow)
330 license_id = db.Column(db.Integer, db.ForeignKey("license.id"))
332 approved = db.Column(db.Boolean, nullable=False, default=False)
333 soft_deleted = db.Column(db.Boolean, nullable=False, default=False)
336 repo = db.Column(db.String(200), nullable=True)
337 website = db.Column(db.String(200), nullable=True)
338 issueTracker = db.Column(db.String(200), nullable=True)
339 forums = db.Column(db.Integer, nullable=True)
341 provides = db.relationship("MetaPackage", secondary=provides, lazy="subquery",
342 backref=db.backref("packages", lazy="dynamic"))
344 dependencies = db.relationship("Dependency", backref="depender", lazy="dynamic", foreign_keys=[Dependency.depender_id])
346 tags = db.relationship("Tag", secondary=tags, lazy="subquery",
347 backref=db.backref("packages", lazy=True))
349 releases = db.relationship("PackageRelease", backref="package",
350 lazy="dynamic", order_by=db.desc("package_release_releaseDate"))
352 screenshots = db.relationship("PackageScreenshot", backref="package",
355 requests = db.relationship("EditRequest", backref="package",
358 def __init__(self, package=None):
362 self.author_id = package.author_id
363 self.created_at = package.created_at
364 self.approved = package.approved
366 for e in PackagePropertyKey:
367 setattr(self, e.name, getattr(package, e.name))
369 def getAsDictionary(self, base_url):
373 "author": self.author.display_name,
374 "shortDesc": self.shortDesc,
375 "type": self.type.toName(),
376 "license": self.license.name,
378 "url": base_url + self.getDownloadURL(),
379 "release": self.getDownloadRelease().id if self.getDownloadRelease() is not None else None,
380 "screenshots": [base_url + ss.url for ss in self.screenshots],
381 "thumbnail": base_url + self.getThumbnailURL()
384 def getThumbnailURL(self):
385 screenshot = self.screenshots.filter_by(approved=True).first()
386 return screenshot.getThumbnailURL() if screenshot is not None else None
388 def getMainScreenshotURL(self):
389 screenshot = self.screenshots.filter_by(approved=True).first()
390 return screenshot.url if screenshot is not None else None
392 def getDetailsURL(self):
393 return url_for("package_page",
394 author=self.author.username, name=self.name)
396 def getEditURL(self):
397 return url_for("create_edit_package_page",
398 author=self.author.username, name=self.name)
400 def getApproveURL(self):
401 return url_for("approve_package_page",
402 author=self.author.username, name=self.name)
404 def getDeleteURL(self):
405 return url_for("delete_package_page",
406 author=self.author.username, name=self.name)
408 def getNewScreenshotURL(self):
409 return url_for("create_screenshot_page",
410 author=self.author.username, name=self.name)
412 def getCreateReleaseURL(self):
413 return url_for("create_release_page",
414 author=self.author.username, name=self.name)
416 def getCreateEditRequestURL(self):
417 return url_for("create_edit_editrequest_page",
418 author=self.author.username, name=self.name)
420 def getDownloadURL(self):
421 return url_for("package_download_page",
422 author=self.author.username, name=self.name)
424 def getDownloadRelease(self):
425 for rel in self.releases:
431 def canImportScreenshot(self):
432 if self.repo is None:
435 url = urlparse(self.repo)
436 if url.netloc == "github.com":
441 def canMakeReleaseFromVCS(self):
442 if self.repo is None:
445 url = urlparse(self.repo)
446 if url.netloc == "github.com":
451 def checkPerm(self, user, perm):
452 if not user.is_authenticated:
455 if type(perm) == str:
456 perm = Permission[perm]
457 elif type(perm) != Permission:
458 raise Exception("Unknown permission given to Package.checkPerm()")
460 isOwner = user == self.author
462 # Members can edit their own packages, and editors can edit any packages
463 if perm == Permission.MAKE_RELEASE or perm == Permission.ADD_SCREENSHOTS:
464 return isOwner or user.rank.atLeast(UserRank.EDITOR)
466 if perm == Permission.EDIT_PACKAGE or perm == Permission.APPROVE_CHANGES:
468 return user.rank.atLeast(UserRank.MEMBER if self.approved else UserRank.NEW_MEMBER)
470 return user.rank.atLeast(UserRank.EDITOR)
472 # Editors can change authors
473 elif perm == Permission.CHANGE_AUTHOR:
474 return user.rank.atLeast(UserRank.EDITOR)
476 elif perm == Permission.APPROVE_NEW or perm == Permission.APPROVE_RELEASE \
477 or perm == Permission.APPROVE_SCREENSHOT:
478 return user.rank.atLeast(UserRank.TRUSTED_MEMBER if isOwner else UserRank.EDITOR)
480 # Moderators can delete packages
481 elif perm == Permission.DELETE_PACKAGE or perm == Permission.CHANGE_RELEASE_URL:
482 return user.rank.atLeast(UserRank.MODERATOR)
485 raise Exception("Permission {} is not related to packages".format(perm.name))
487 class MetaPackage(db.Model):
488 id = db.Column(db.Integer, primary_key=True)
489 name = db.Column(db.String(100), unique=True, nullable=False)
490 dependencies = db.relationship("Dependency", backref="meta_package", lazy="dynamic")
492 def __init__(self, name=None):
499 def ListToSpec(list):
500 return ",".join([str(x) for x in list])
503 def GetOrCreate(name, cache={}):
506 mp = MetaPackage.query.filter_by(name=name).first()
509 mp = MetaPackage(name)
516 def SpecToList(spec, cache={}):
518 arr = spec.split(",")
521 pattern = re.compile("^([a-z0-9_]+)$")
528 if not pattern.match(x):
531 retval.append(MetaPackage.GetOrCreate(x, cache))
536 id = db.Column(db.Integer, primary_key=True)
537 name = db.Column(db.String(100), unique=True, nullable=False)
538 title = db.Column(db.String(100), nullable=False)
539 backgroundColor = db.Column(db.String(6), nullable=False)
540 textColor = db.Column(db.String(6), nullable=False)
542 def __init__(self, title, backgroundColor="000000", textColor="ffffff"):
544 self.backgroundColor = backgroundColor
545 self.textColor = textColor
548 regex = re.compile("[^a-z_]")
549 self.name = regex.sub("", self.title.lower().replace(" ", "_"))
551 class PackageRelease(db.Model):
552 id = db.Column(db.Integer, primary_key=True)
554 package_id = db.Column(db.Integer, db.ForeignKey("package.id"))
555 title = db.Column(db.String(100), nullable=False)
556 releaseDate = db.Column(db.DateTime, nullable=False)
557 url = db.Column(db.String(200), nullable=False)
558 approved = db.Column(db.Boolean, nullable=False, default=False)
559 task_id = db.Column(db.String(37), nullable=True)
562 def getEditURL(self):
563 return url_for("edit_release_page",
564 author=self.package.author.username,
565 name=self.package.name,
569 self.releaseDate = datetime.now()
571 class PackageScreenshot(db.Model):
572 id = db.Column(db.Integer, primary_key=True)
573 package_id = db.Column(db.Integer, db.ForeignKey("package.id"))
574 title = db.Column(db.String(100), nullable=False)
575 url = db.Column(db.String(100), nullable=False)
576 approved = db.Column(db.Boolean, nullable=False, default=False)
579 def getEditURL(self):
580 return url_for("edit_screenshot_page",
581 author=self.package.author.username,
582 name=self.package.name,
585 def getThumbnailURL(self):
586 return self.url.replace("/uploads/", "/thumbnails/350x233/")
588 class EditRequest(db.Model):
589 id = db.Column(db.Integer, primary_key=True)
591 package_id = db.Column(db.Integer, db.ForeignKey("package.id"))
592 author_id = db.Column(db.Integer, db.ForeignKey("user.id"))
594 title = db.Column(db.String(100), nullable=False)
595 desc = db.Column(db.String(1000), nullable=True)
600 status = db.Column(db.Integer, nullable=False, default=0)
602 changes = db.relationship("EditRequestChange", backref="request",
606 return url_for("view_editrequest_page",
607 author=self.package.author.username,
608 name=self.package.name,
611 def getApproveURL(self):
612 return url_for("approve_editrequest_page",
613 author=self.package.author.username,
614 name=self.package.name,
617 def getRejectURL(self):
618 return url_for("reject_editrequest_page",
619 author=self.package.author.username,
620 name=self.package.name,
623 def getEditURL(self):
624 return url_for("create_edit_editrequest_page",
625 author=self.package.author.username,
626 name=self.package.name,
629 def applyAll(self, package):
630 for change in self.changes:
631 change.apply(package)
634 def checkPerm(self, user, perm):
635 if not user.is_authenticated:
638 if type(perm) == str:
639 perm = Permission[perm]
640 elif type(perm) != Permission:
641 raise Exception("Unknown permission given to EditRequest.checkPerm()")
643 isOwner = user == self.author
645 # Members can edit their own packages, and editors can edit any packages
646 if perm == Permission.EDIT_EDITREQUEST:
647 return isOwner or user.rank.atLeast(UserRank.EDITOR)
650 raise Exception("Permission {} is not related to packages".format(perm.name))
655 class EditRequestChange(db.Model):
656 id = db.Column(db.Integer, primary_key=True)
658 request_id = db.Column(db.Integer, db.ForeignKey("edit_request.id"))
659 key = db.Column(db.Enum(PackagePropertyKey), nullable=False)
661 # TODO: make diff instead
662 oldValue = db.Column(db.Text, nullable=True)
663 newValue = db.Column(db.Text, nullable=True)
665 def apply(self, package):
666 if self.key == PackagePropertyKey.tags:
668 for tagTitle in self.newValue.split(","):
669 tag = Tag.query.filter_by(title=tagTitle.strip()).first()
670 package.tags.append(tag)
673 setattr(package, self.key.name, self.newValue)
676 db_adapter = SQLAlchemyAdapter(db, User) # Register the User model
677 user_manager = UserManager(db_adapter, app) # Initialize Flask-User