todo.sr.ht/todosrht/types/tracker.py

129 lines
4.4 KiB
Python

import re
import sqlalchemy as sa
import sqlalchemy_utils as sau
import string
from enum import Enum
from srht.database import Base
from srht.flagtype import FlagType
from srht.validation import Validation
from todosrht.types import TicketAccess, TicketStatus, TicketResolution
name_re = re.compile(r"^[A-Za-z0-9._-]+$")
class Visibility(Enum):
PUBLIC = 'PUBLIC'
UNLISTED = 'UNLISTED'
PRIVATE = 'PRIVATE'
class Tracker(Base):
__tablename__ = 'tracker'
id = sa.Column(sa.Integer, primary_key=True)
owner_id = sa.Column(sa.Integer, sa.ForeignKey("user.id"), nullable=False)
owner = sa.orm.relationship("User", backref=sa.orm.backref("owned_trackers"))
created = sa.Column(sa.DateTime, nullable=False)
updated = sa.Column(sa.DateTime, nullable=False)
visibility = sa.Column(sau.ChoiceType(Visibility), nullable=False)
name = sa.Column(sa.Unicode(1024))
"""
May include slashes to serve as categories (nesting is supported,
builds.sr.ht style)
"""
next_ticket_id = sa.Column(sa.Integer, nullable=False, default=1)
description = sa.Column(sa.Unicode(8192))
"""Markdown"""
min_desc_length = sa.Column(sa.Integer, nullable=False, default=0)
enable_ticket_status = sa.Column(FlagType(TicketStatus),
nullable=False,
default=TicketStatus.resolved)
enable_ticket_resolution = sa.Column(FlagType(TicketStatus),
nullable=False,
default=TicketResolution.fixed | TicketResolution.duplicate)
default_access = sa.Column(FlagType(TicketAccess),
nullable=False,
default=TicketAccess.browse + TicketAccess.submit + TicketAccess.comment)
import_in_progress = sa.Column(sa.Boolean,
nullable=False, server_default='f')
@staticmethod
def create_from_request(request, user):
valid = Validation(request)
name = valid.require("name", friendly_name="Name")
visibility = valid.require("visibility", cls=Visibility)
desc = valid.optional("description")
if not valid.ok:
return None, valid
valid.expect(1 <= len(name) < 256,
"Must be between 1 and 255 characters",
field="name")
valid.expect(not valid.ok or name_re.match(name),
"Name must match [A-Za-z0-9._-]+",
field="name")
valid.expect(not valid.ok or name not in [".", ".."],
"Name cannot be '.' or '..'",
field="name")
valid.expect(not valid.ok or name not in [".git", ".hg"],
"Name must not be '.git' or '.hg'",
field="name")
valid.expect(not desc or len(desc) < 4096,
"Must be less than 4096 characters",
field="description")
if not valid.ok:
return None, valid
tracker = (Tracker.query
.filter(Tracker.owner_id == user.id)
.filter(Tracker.name.ilike(name.replace('_', '\\_')))
).first()
valid.expect(not tracker,
"A tracker by this name already exists", field="name")
if not valid.ok:
return None, valid
tracker = Tracker(owner=user,
name=name,
description=desc,
visibility=visibility)
return tracker, valid
def ref(self):
return "{}/{}".format(
self.owner.canonical_name,
self.name)
def __repr__(self):
return '<Tracker {} {}>'.format(self.id, self.name)
def to_dict(self, short=False):
def permissions(w):
if isinstance(w, int):
w = TicketAccess(w)
return [p.name for p in TicketAccess
if p in w and p not in [TicketAccess.none, TicketAccess.all]]
return {
"id": self.id,
"owner": self.owner.to_dict(short=True),
"created": self.created,
"updated": self.updated,
"name": self.name,
**({
"description": self.description,
"default_access": permissions(self.default_access),
"visibility": self.visibility,
} if not short else {})
}
def update(self, valid):
desc = valid.optional("description", default=self.description)
valid.expect(not desc or len(desc) < 4096,
"Must be less than 4096 characters",
field="description")
self.description = desc