class Folder(sqla.Model):
__tablename__ = 'folders'
__table_args__ = config.documents_table_args
id = Column(sqla.Integer, primary_key=True)
name = Column(sqla.String)
location_id = Column(sqla.Integer, sqla.ForeignKey(garfield.Location.id))
document_type = Column(document_type)
location = sqla.relationship(garfield.Location,
lazy='joined',
uselist=False,
back_populates='folders')
examinants = sqla.relationship('Examinant',
secondary=folder_examinants,
lazy='subquery',
back_populates='folders')
lectures = sqla.relationship('Lecture',
secondary=folder_lectures,
lazy='subquery',
back_populates='folders')
printed_docs = sqla.relationship('Document',
secondary=folder_docs,
back_populates='printed_in')
def __str__(self):
return self.name
class OrderDocument(sqla.Model):
__tablename__ = 'order_documents'
__table_args__ = config.odie_table_args
index = Column(sqla.Integer, primary_key=True)
order_id = Column(sqla.Integer, sqla.ForeignKey('odie.orders.id'), primary_key=True)
document_id = Column(sqla.ForeignKey('documents.documents.id', ondelete='CASCADE'), primary_key=True)
order = sqla.relationship('Order', back_populates='items')
document = sqla.relationship('Document', lazy='joined')
class User(sqla.Model):
__tablename__ = 'benutzer'
__table_args__ = config.fsmi_table_args
id = Column(sqla.Integer, name='benutzer_id', primary_key=True)
username = Column(sqla.String(255), name='benutzername', unique=True)
first_name = Column(sqla.Text, name='vorname')
last_name = Column(sqla.Text, name='nachname')
pw_hash = Column(sqla.String(255), name='passwort')
effective_permissions = sqla.relationship('Permission', secondary=acl.effective_permissions, lazy='joined')
@property
def full_name(self):
return self.first_name + ' ' + self.last_name
def has_permission(self, *perm_names):
return any(perm.name in perm_names for perm in self.effective_permissions)
@staticmethod
def authenticate(username, password):
user = User.query.filter_by(username=username).first()
if not user:
return None
if user.has_permission('homepage_login') and\
crypt.crypt(password, user.pw_hash) == user.pw_hash:
return user
else:
return None
class Examinant(sqla.Model):
__tablename__ = 'examinants'
__table_args__ = config.documents_table_args
id = Column(sqla.Integer, primary_key=True)
name = Column(sqla.String)
validated = Column(sqla.Boolean)
documents = sqla.relationship('Document',
secondary=document_examinants,
lazy='dynamic',
back_populates='examinants')
folders = sqla.relationship('Folder',
secondary=folder_examinants,
back_populates='examinants')
def __str__(self):
return self.name
class Deposit(sqla.Model):
__tablename__ = 'deposits'
__table_args__ = config.documents_table_args
id = Column(sqla.Integer, primary_key=True)
price = Column(sqla.Integer)
name = Column(sqla.String)
by_user = Column(sqla.String)
date = Column(sqla.DateTime(timezone=True), server_default=sqla.func.now())
lectures = sqla.relationship('Lecture', secondary=deposit_lectures)
class Cookie(sqla.Model):
__tablename__ = 'cookies'
__table_args__ = config.fsmi_table_args
sid = Column(sqla.Text, primary_key=True)
user_id = Column(sqla.Integer, sqla.ForeignKey('public.benutzer.benutzer_id'), name='benutzer_id')
user = sqla.relationship('User')
last_action = Column(sqla.DateTime, primary_key=True)
lifetime = Column(sqla.Integer)
def refresh(self):
if not config.LOCAL_SERVER:
# we can't use an SQL expression for this, because then sqlalchemy will try to fetch the
# result of that with a RETURNING clause, which doesn't work on this view.
# If we inform sqlalchemy of all values of the mapped instance by keeping them inside python,
# it's fine though
now = datetime.datetime.now()
sqla.session.add(Cookie(sid=self.sid, user_id=self.user_id, last_action=now, lifetime=self.lifetime))
class Location(sqla.Model):
__tablename__ = 'locations'
__table_args__ = {
'schema': 'garfield',
'info': {'bind_key': 'garfield'}
}
id = Column(sqla.Integer, name='location_id', primary_key=True)
name = Column(sqla.String, name='location_name')
description = Column(sqla.String, name='location_description')
folders = sqla.relationship('Folder', back_populates='location')
def __str__(self):
return self.name
def to_subject(self):
return 'computer science' if self.name == 'FSI' else 'mathematics'
class Order(sqla.Model):
__tablename__ = 'orders'
__table_args__ = config.odie_table_args
id = Column(sqla.Integer, primary_key=True)
name = Column(sqla.String(256))
creation_time = Column(sqla.DateTime(timezone=True), server_default=sqla.func.now())
items = sqla.relationship('OrderDocument', cascade='all', order_by=OrderDocument.index, lazy='subquery',
back_populates='order')
def __init__(self, name, document_ids, creation_time=None):
self.name = name
self.creation_time = creation_time
for idx, doc in enumerate(document_ids):
OrderDocument(order=self, document_id=doc, index=idx)
@property
def documents(self):
return [item.document for item in self.items]
class Lecture(sqla.Model):
__tablename__ = 'lectures'
__table_args__ = config.documents_table_args
early_document_until_stored_procedure_calls = [
sqla.text("""
CREATE OR REPLACE FUNCTION documents.lectures_early_document_reward_until(lec_id int, early_document_count int, grace_period_days int) RETURNS timestamptz AS $$
DECLARE
result timestamptz;
BEGIN
LOCK TABLE documents.lectures, documents.documents, documents.lecture_docs IN SHARE MODE;
IF NOT exists(SELECT 1 FROM documents.lectures WHERE id=lec_id) THEN
RAISE EXCEPTION 'Lecture % does not exist', lec_id;
END IF;
IF early_document_count <= 0 THEN
RAISE EXCEPTION 'early_document_count must be positive';
END IF;
IF grace_period_days < 0 THEN
RAISE EXCEPTION 'grace_period_days must be positive or zero';
END IF;
SELECT doc.validation_time into result
FROM documents.documents AS doc
JOIN documents.lecture_docs AS jt ON jt.document_id = doc.id
JOIN documents.lectures AS lec ON jt.lecture_id = lec.id
WHERE doc.validation_time IS NOT NULL
AND doc.document_type = 'oral'
AND lec.id = lec_id
ORDER BY doc.validation_time ASC
LIMIT 1 OFFSET (early_document_count-1);
IF NOT FOUND THEN
return null;
END IF;
return result + interval '1' day * grace_period_days;
END
$$ LANGUAGE plpgsql SECURITY DEFINER SET search_path = documents, pg_temp;
"""),
sqla.text("""
REVOKE ALL ON FUNCTION documents.lectures_early_document_reward_until(int, int, int) FROM PUBLIC;
""")
]
id = Column(sqla.Integer, primary_key=True)
name = Column(sqla.String)
aliases = Column(postgresql.ARRAY(sqla.String), server_default='{}')
comment = Column(sqla.String, server_default='')
validated = Column(sqla.Boolean)
documents = sqla.relationship('Document',
secondary=lecture_docs,
lazy='dynamic',
back_populates='lectures')
folders = sqla.relationship('Folder',
secondary=folder_lectures,
back_populates='lectures')
early_document_until = column_property(
func.documents.lectures_early_document_reward_until(
id, config.FS_CONFIG['EARLY_DOCUMENT_COUNT'],
config.FS_CONFIG['EARLY_DOCUMENT_EXTRA_DAYS']),
deferred=
True # The stored procedure is not robust in every join scenario.
# This is due to id getting set to null in some cases (ie loading a document without lectures), which correctly raises an exception
)
@property
def early_document_eligible(self):
until = self.early_document_until
return until is None or datetime.datetime.now(
reference.LocalTimezone()) <= until
def __str__(self):
return self.name
class Document(sqla.Model):
__tablename__ = 'documents'
__table_args__ = config.documents_table_args
id = Column(sqla.Integer, primary_key=True)
department = Column(
sqla.Enum('mathematics',
'computer science',
'other',
name='department',
inherit_schema=True))
date = Column(sqla.Date())
number_of_pages = Column(sqla.Integer, server_default='0')
solution = Column(sqla.Enum('official',
'inofficial',
'none',
name='solution',
inherit_schema=True),
nullable=True)
comment = Column(sqla.String, server_default='')
document_type = Column(document_type)
has_file = Column(sqla.Boolean,
server_default=sqlalchemy.sql.expression.false())
has_barcode = Column(sqla.Boolean,
server_default=sqlalchemy.sql.expression.false())
validation_time = Column(sqla.DateTime(timezone=True), nullable=True)
submitted_by = Column(sqla.String, nullable=True)
legacy_id = Column(
sqla.Integer, nullable=True
) # old id from fs-deluxe, so we can recognize the old barcodes
early_document_eligible = Column(
sqla.Boolean,
nullable=False,
server_default=sqlalchemy.sql.expression.false())
deposit_return_eligible = Column(
sqla.Boolean,
nullable=False,
server_default=sqlalchemy.sql.expression.false())
publicly_available = Column(
sqla.Boolean, server_default=sqlalchemy.sql.expression.false())
lectures = sqla.relationship('Lecture',
secondary=lecture_docs,
back_populates='documents')
examinants = sqla.relationship('Examinant',
secondary=document_examinants,
back_populates='documents')
printed_in = sqla.relationship('Folder',
secondary=folder_docs,
back_populates='printed_docs')
@property
def examinants_names(self):
return [ex.name for ex in self.examinants]
@hybrid_property
def validated(self):
return self.validation_time is not None
@validated.expression
def validated(self):
return Document.validation_time.isnot(None).label('validated')
@property
def price(self):
return config.FS_CONFIG['PRICE_PER_PAGE'] * self.number_of_pages
