event.py

# -*- coding: utf-8 -*-
'''Event model module

@author: moschlar
'''
#
## SAUCE - System for AUtomated Code Evaluation
## Copyright (C) 2013 Moritz Schlarb
##
## This program is free software: you can redistribute it and/or modify
## it under the terms of the GNU Affero General Public License as published by
## the Free Software Foundation, either version 3 of the License, or
## any later version.
##
## This program is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
## GNU Affero General Public License for more details.
##
## You should have received a copy of the GNU Affero General Public License
## along with this program.  If not, see <http://www.gnu.org/licenses/>.
#

from datetime import datetime, timedelta
from warnings import warn

from sqlalchemy import Column, ForeignKey, Index, Table, UniqueConstraint, union
from sqlalchemy.inspection import inspect
from sqlalchemy.orm import backref, relationship
from sqlalchemy.types import Boolean, DateTime, Enum, Integer, String, Unicode

from sauce.lib.helpers import link
from sauce.model import DeclarativeBase, metadata
from sauce.model.user import Team, User, event_members, lesson_members, team_members


__all__ = ('Event', 'Course', 'Contest', 'Lesson')


# secondary table for many-to-many relation
event_teachers = Table('event_teachers', metadata,
    Column('user_id', Integer, ForeignKey('users.id'), primary_key=True),
    Column('event_id', Integer, ForeignKey('events.id'), primary_key=True),
)


class Event(DeclarativeBase):
    '''An Event'''
    __tablename__ = 'events'

    id = Column(Integer, primary_key=True, nullable=False)
    type = Column(Enum('course', 'contest', name='event_type'), nullable=False)

    _url = Column('url', String(255), nullable=False, index=True, unique=True)

    name = Column(Unicode(255), nullable=False)
    description = Column(Unicode(64 * 1024), nullable=True)

    start_time = Column(DateTime, nullable=False, default=datetime.now)
    end_time = Column(DateTime, nullable=False, default=lambda: datetime.now() + timedelta(days=31))

    password = Column(Unicode(255), nullable=True,
        doc='The password students have to enter in order to enroll to an event')

    enroll = Column(Enum('event', 'lesson', 'lesson_team', 'team', 'team_new', name='event_enroll'),
        nullable=True, default=None)

    public = Column(Boolean, nullable=False, default=True,
        doc='Whether this Event is accessible for non-logged in users and non-enrolled students')

    enabled = Column(Boolean, nullable=False, default=False,
        doc='Whether this Event is administratively enabled or disabled')

    _members = relationship('User',
        secondary=event_members,
        order_by='User.user_name',
        backref=backref('_events',
            order_by=id,
        )
    )

    teachers = relationship('User',
        secondary=event_teachers,
        order_by='User.user_name',
        backref=backref('teached_events'),
    )

    _teacher_id = Column('teacher_id', Integer, ForeignKey('users.id'))
    _teacher = relationship('User',
        #backref=backref('events',
        #    cascade='all, delete-orphan'),
        doc='(Deprecated) The main teacher, displayed as contact on event details')

    @property
    def teacher(self):  # pragma: no cover
        warn('Event.teacher', DeprecationWarning, stacklevel=2)
        if self._teacher:
            return self._teacher
        elif self.teachers:
            if len(self.teachers) > 1:
                warn('len(Event.teachers) > 1', stacklevel=2)
            return self.teachers[0]
        else:
            return None

    @teacher.setter
    def teacher(self, teacher):  # pragma: no cover
        # The setter is okay to use because it makes injection in CRC easier
        #warn('Event.teacher', DeprecationWarning, stacklevel=2)
        self._teacher = teacher
        try:
            self.teachers.remove(teacher)
        except ValueError:
            pass
        finally:
            self.teachers.insert(0, teacher)

    __mapper_args__ = {
        'polymorphic_on': 'type',
        'order_by': [end_time, start_time, _url],
    }

    def __repr__(self):
        return (u'<%s: id=%r, name=%r, url=%r>'
            % (self.__class__.__name__,
                self.id, self.name, self._url)
        ).encode('utf-8')

    def __unicode__(self):
        return u'Event "%s"' % self.name

    def __contains__(self, item):
        if isinstance(item, User):
            return item in self.tutors or item in self.members

    def clone(self, i=0, recursive=True,
            teachers=False, members=False, lessons=False, teams=False):
        e = Event(**dict((attr.key, getattr(self, attr.key)) for attr in inspect(self).mapper.column_attrs
            if attr.key != 'id'))
        e._url = '%s%d' % (self._url, i + 1)  # TODO: Not uniqueness-safe
        if teachers:
            e.teachers = [t for t in self.teachers]
        if members:
            e._members = [m for m in self._members]
        if lessons:
            e.lessons = [l.clone(i=i, teams=teams) for l in self.lessons]
        if recursive:
            e.sheets = [s.clone(i=j, recursive=recursive) for j, s in enumerate(self.sheets)]
        return e

    #----------------------------------------------------------------------------
    # Properties

    @property
    def current_sheets(self):
        return [s for s in self.sheets if s.start_time < datetime.now() < s.end_time]

    @property
    def previous_sheets(self):
        return [s for s in self.sheets if s.end_time < datetime.now()]

    @property
    def future_sheets(self):
        return [s for s in self.sheets if s.start_time > datetime.now()]

    @property
    def public_sheets(self):
        return [s for s in self.sheets if s.public]

    @property
    def url(self):
        return '/events/%s' % self._url

    @property
    def link(self):
        '''Link for this event'''
        return link(self.name, self.url)

    @property
    def breadcrumbs(self):
        '''Array of links for breadcrumb navigation'''
        return [self.link]

    parent = None

    @property
    def teams(self):
        t = set()
        for l in self.lessons:
            t |= set(l.teams)
        return t

    @property
    def children(self):
        return self.sheets

    @property
    def is_active(self):
        '''If the event is active at the moment'''
        return self.start_time < datetime.now() < self.end_time

    @property
    def remaining_time(self):
        '''Remaining time for event'''
        return max(self.end_time - datetime.now(), timedelta(0))

    @property
    def tutorsandteachers(self):
        return set(self.teachers) | set(self.tutors)

    @property
    def tutors(self):
        tuts = set()
        for l in self.lessons:
            tuts |= set(l.tutors)
        return tuts
        # return [l.tutor for l in self.lessons]

    @property
    def members(self):
        studs = set(self._members)
        for l in self.lessons:
            studs |= set(l.members)
        return studs

    @property
    def students(self):  # pragma: no cover
        warn('Event.students', DeprecationWarning, stacklevel=2)
        return self.members

    def members_query(self, qry=None):
        if not qry:
            qry = User.query
        qry = qry.select_entity_from(union(
            qry.join(event_members).join(Event)
                .filter_by(id=self.id).order_by(None),
            qry.join(lesson_members).join(Lesson)
                .filter_by(event_id=self.id).order_by(None),
            qry.join(team_members).join(Team).join(Lesson)
                .filter_by(event_id=self.id).order_by(None),
        )).order_by(User.user_name)
        return qry

    def tutors_query(self, qry=None):
        if not qry:
            qry = User.query
        qry = qry.join(lesson_tutors).join(Lesson).filter_by(event_id=self.id)
        return qry

    #----------------------------------------------------------------------------
    # Classmethods

    @classmethod
    def by_url(cls, url):
        '''Return the event specified by url'''
        return cls.query.filter_by(enabled=True).filter(cls._url == url).one()

#    @classmethod
#    def all_events(cls, only_public=True):
#        '''Return a 3-tuple (current, previous, future) containing all events'''
#        return (cls.current_events(only_public).all(),
#                cls.previous_events(only_public).all(),
#                cls.future_events(only_public).all())

    @classmethod
    def current_events(cls, only_public=False):
        '''Return a query for currently active events'''
        q = cls.query
        q = q.filter_by(enabled=True)
        if only_public:
            q = q.filter_by(public=True)
        q = q.filter(cls.start_time < datetime.now()).filter(cls.end_time > datetime.now())
        return q

    @classmethod
    def previous_events(cls, only_public=False):
        '''Return a query for previously active events'''
        q = cls.query
        q = q.filter_by(enabled=True)
        if only_public:
            q = q.filter_by(public=True)
        q = q.filter(cls.end_time < datetime.now())
        return q

    @classmethod
    def future_events(cls, only_public=False):
        '''Return a query for future active events'''
        q = cls.query
        q = q.filter_by(enabled=True)
        if only_public:
            q = q.filter_by(public=True)
        q = q.filter(cls.start_time > datetime.now())
        return q


class Course(Event):
    '''An Event with type course'''
    __mapper_args__ = {'polymorphic_identity': 'course'}

    def __unicode__(self):
        return u'Course "%s"' % self.name


class Contest(Event):
    '''An Event with type contest'''
    __mapper_args__ = {'polymorphic_identity': 'contest'}

    def __unicode__(self):
        return u'Contest "%s"' % self.name


# secondary table for many-to-many relation
lesson_tutors = Table('lesson_tutors', metadata,
    Column('user_id', Integer, ForeignKey('users.id'), primary_key=True),
    Column('lesson_id', Integer, ForeignKey('lessons.id'), primary_key=True),
)


class Lesson(DeclarativeBase):
    '''A Lesson'''
    __tablename__ = 'lessons'

    id = Column(Integer, primary_key=True, nullable=False)

    lesson_id = Column(Integer, index=True, nullable=False,
        doc='The lesson_id specific to the parent event')

#     _url = Column('url', String(255), nullable=True)
#     '''Not used right now!'''

    name = Column(Unicode(255), nullable=False)

    event_id = Column(Integer, ForeignKey('events.id'), nullable=False)
    event = relationship('Event',
        backref=backref('lessons',
            order_by=lesson_id,
            cascade='all, delete-orphan',
        )
    )

    _tutor_id = Column('tutor_id', Integer, ForeignKey('users.id'), nullable=True)
    _tutor = relationship('User',
#         backref=backref('tutored_lessons',
#             order_by=lesson_id,
#             cascade='all, delete-orphan')
        )

    tutors = relationship('User',
        secondary=lesson_tutors,
        order_by='User.user_name',
        backref=backref('tutored_lessons',
            order_by=lesson_id),
    )

    _members = relationship('User',
        secondary=lesson_members,
        order_by='User.user_name',
        backref=backref('_lessons',
            order_by=lesson_id,
        )
    )

    __mapper_args__ = {'order_by': [event_id, name]}
    __table_args__ = (
        UniqueConstraint('event_id', 'lesson_id'),
        Index('idx_event_lesson', event_id, lesson_id, unique=True),
    )

    def __repr__(self):
        return (u'<Lesson: id=%r, event_id=%r, lesson_id=%r, name=%r>'
            % (self.id, self.event_id, self.lesson_id, self.name)
        ).encode('utf-8')

    def __unicode__(self):
        return u'Lesson "%s"' % (self.name)

    def __contains__(self, item):
        return item in self.members

    def clone(self, i=0,
            tutors=False, members=False, teams=False):
        l = Lesson(**dict((attr.key, getattr(self, attr.key)) for attr in inspect(self).mapper.column_attrs
            if attr.key != 'id'))
        l.lesson_id = i + 1  # TODO: Not uniqueness-safe
        if tutors:
            l.tutors = [t for t in self.tutors]
        if members:
            l._members = [m for m in self._members]
        if teams:
            l.teams = [t.clone(i=i, members=members) for t in self.teams]
        return l

    @property
    def parent(self):
        '''Parent entity for generic hierarchy traversal'''
        return self.event

    @property
    def url(self):
        return self.event.url + '/lessons/%s' % self.lesson_id

    @property
    def link(self):
        '''Link for this lesson'''
        return link(self.name, self.url)

    @property
    def breadcrumbs(self):
        '''Array of links for breadcrumb navigation'''
        return self.event.breadcrumbs + [self.link]

    @property
    def tutor(self):  # pragma: no cover
        warn('Lesson.tutor', DeprecationWarning, stacklevel=2)
        if self._tutor:
            return self._tutor
        elif self.tutors:
            return self.tutors[0]
        else:
            return None

    @tutor.setter
    def tutor(self, tutor):  # pragma: no cover
        # The setter is okay to use because it makes injection in CRC easier
        #warn('Lesson.tutor', DeprecationWarning, stacklevel=2)
        self._tutor = tutor
        try:
            self.tutors.remove(tutor)
        except ValueError:
            pass
        finally:
            self.tutors.insert(0, tutor)

    @property
    def members(self):
        s = set(self._members)
        for t in self.teams:
            s |= set(t.members)
        return s

    def members_query(self, qry=None):
        if not qry:
            qry = User.query
        qry = qry.select_entity_from(union(
                qry.join(lesson_members).filter_by(lesson_id=self.id).order_by(None),
                qry.join(team_members).join(Team).filter_by(lesson_id=self.id).order_by(None),
            )).order_by(User.id)
        return qry

    @property
    def students(self):  # pragma: no cover
        warn('Lesson.students', DeprecationWarning, stacklevel=2)
        return self.members

    @property
    def teacher(self):  # pragma: no cover
        warn('Lesson.teachers', DeprecationWarning, stacklevel=2)
        return self.tutor

    #----------------------------------------------------------------------------
    # Classmethods

    @classmethod
    def by_lesson_id(cls, lesson_id, event):
        return cls.query.filter(cls.event_id == event.id).filter(cls.lesson_id == lesson_id).one()