joeni | Gitar

Add changes for course editing and management

It's not possible right now to add scores/results for students, but this problem should be handled in another way.

Author: Maarten Vangeneugden
Date: April 18, 2018, 6:41 p.m.
Hash: 197e97b68f091dd0c249af588da899a26395dee6
Parent: 7876160a509d480e11c2f0c9587aeea3abf65aaf
Modified files: administration/models.py; courses/forms.py; courses/templates/courses/edit_course_items.djhtml; courses/views.py

administration/models.py ¶

4 additions and 1 deletion.

View changes Hide changes

from django.core.exceptions import ValidationError
from django.core.validators import MaxValueValidator
from django.utils.translation import ugettext_lazy as _
from django.utils.text import slugify
from django.contrib.auth.models import AbstractUser
from joeni.constants import current_academic_year
import datetime
import os
import uuid
import courses
#from . import roster

def validate_IBAN(value):
    """ Validates if the given value qualifies as a valid IBAN number.
    This validator checks if the structure is valid, and calculates the control
    number if the structure is correct. If the control number fails, or the
    structure is invalid, a ValidationError will be raised. In that case,
    the Error will specify whether the structure is incorrect, or the control
    number is not valid.
    """
    # FIXME: This function is not complete. When there's time, implement
    # as specified at https://nl.wikipedia.org/wiki/International_Bank_Account_Number#Structuur
    if False:
        raise ValidationError(
            _('%(value)s is not a valid IBAN number.'),
            params={'value': value},)
def validate_BIC(value):
    """ Same functionality as validate_IBAN, but for BIC-codes. """
    # FIXME: This function is not complete. When there's time, implement
    # as specified at https://nl.wikipedia.org/wiki/Business_Identifier_Code
    pass

class User(AbstractUser):
    """ Replacement for the standard Django User model. """
    number = models.AutoField(
        primary_key=True,
        help_text=_("The number assigned to this user."),
        )
    created = models.DateField(auto_now_add=True)

    def __str__(self):
        user_data = UserData.objects.filter(user=self)
        if len(user_data) == 0:
            return self.username
        else:
            user_data = user_data[0]
            name = user_data.first_name +" "+ user_data.last_name
            titles = user_data.title.split()
            if len(titles) == 0:
                return name
            else:
                prefix_titles = ""
                suffix_titles = ""
                for title in titles:
                    if title in ["lic.", "prof.", "dr.", "drs.", "bc.", "bacc.", "ing.", "ir." "cand.", "mr.", "dr.h.c.mult.", "dr.h.c.", "dr.mult.", "em. prof.", "prof. em.", "lec."]:
                        prefix_titles += title + " "
                    elif title in ["MSc", "BSc", "MA", "BA", "LLM", "LLB", "PhD", "MD"]:
                        suffix_titles += title + " "
            return prefix_titles + name + " " + suffix_titles.strip()

class UserData(models.Model):
    user = models.OneToOneField("User", on_delete=models.CASCADE, related_name="user_data")
    first_name = models.CharField(max_length=64, blank=False)
    last_name = models.CharField(max_length=64, blank=False)
    title = models.CharField(
        max_length=64,
        blank=True,
        help_text=_("The academic title of this user, if applicable."),
        )
    DOB = models.DateField(
        blank=False,
        #editable=False,  # For testing purposes, decomment in deployment!
        help_text=_("The date of birth of this user."),
        )
    POB = models.CharField(
        max_length=64,
        blank=False,
        #editable=False,  # For testing purposes, decomment in deployment!
        help_text=_("The place of birth of this user."),
        )
    nationality = models.CharField(
        max_length=64,
        blank=False,
        help_text=_("The current nationality of this user."),
        default="Belg",
        )
    # XXX: What if this starts with zeros?
    national_registry_number = models.BigIntegerField(
        blank=True,  # Only possible if Belgian
        # TODO Validator!
        #editable=False,
        help_text=_("The assigned national registry number of this user."),
        )
    civil_status = models.CharField(
        max_length=32,
        choices = (
            ("Single", _("Single")),
            ("Married", _("Married")),
            ("Divorced", _("Divorced")),
            ("Widowed", _("Widowed")),
            ("Partnership", _("Partnership")),
            ),
        blank=False,
        # There may be more; consult http://www.aantrekkingskracht.com/trefwoord/burgerlijke-staat
        # for more information.
        help_text=_("The civil/marital status of the user."),
        )

    is_staff = models.BooleanField(
        default=False,
        help_text=_("Determines if this user is part of the university's staff."),
        )
    is_student = models.BooleanField(
        default=True,
        help_text=_("Indicates if this user is a student at the university."),
        )

    def current_courses(self):
        """Returns a set of all the courses this user has access to.
        For a student, the result is equal to the set of courses in his/her
        curriculum of the current year. For personnel, this equals the set of
        courses that they are connected to."""
        courses_set = set()
        if self.is_student:
            curriculum = Curriculum.objects.filter(student=self.user).get(year=current_academic_year())
            for course in curriculum.courses():
                courses_set.add(course)
        if self.is_staff:
            for course in courses.models.Course.objects.all():
                if self.user in course.course_team():
                    courses_set.add(course)
        return courses_set

    def slug_name(self):
        """Returns a slug name for this user which can be used to reference in
        URLs."""
        same_names = UserData.objects.filter(first_name=self.first_name).filter(last_name=self.last_name)
        if len(same_names) == 1 and same_names[0] == self:
            return slugify(self.first_name +"-"+ self.last_name, allow_unicode=True)
        else:
            number = self.user.number
            return slugify(self.first_name +"-"+ self.last_name +"-"+ str(number), allow_unicode=True)

    # Home address
    home_street = models.CharField(max_length=64, blank=False)
    home_number = models.PositiveSmallIntegerField(blank=False)
    home_bus = models.CharField(max_length=10, null=True, blank=True)
    home_postal_code = models.PositiveIntegerField(blank=False)
    home_city = models.CharField(max_length=64, blank=False)
    home_country = models.CharField(max_length=64, blank=False, default="België")
    home_telephone = models.CharField(
        max_length=64,
        help_text=_("The telephone number for the house address. Prefix 0 can be presented with the national call code in the system (\"32\" for Belgium)."),
        )
    # Study address
    study_street = models.CharField(max_length=64, blank=True, null=True)
    study_number = models.PositiveSmallIntegerField(blank=True, null=True)
    study_bus = models.CharField(max_length=10, null=True, blank=True)
    study_postal_code = models.PositiveSmallIntegerField(blank=True, null=True)
    study_country = models.CharField(max_length=64, blank=True, null=True)
    study_telephone = models.CharField(
        blank=True, null=True,
        max_length=64,
        help_text=_("The telephone number for the study address. Prefix 0 can be presented with the national call code in the system."),
        )
    study_cellphone = models.CharField(
        max_length=64, null=True, blank=True,
        help_text=_("The cellphone number of the person. Prefix 0 can be presented with then national call code in the system."),
        )
    # Titularis address
    # XXX: These fields are only required if this differs from the user itself.
    titularis_street = models.CharField(max_length=64, null=True, blank=True)
    titularis_number = models.PositiveSmallIntegerField(null=True, blank=True)
    titularis_bus = models.CharField(max_length=10, null=True, blank=True)
    titularis_postal_code = models.PositiveSmallIntegerField(null=True, blank=True)
    titularis_country = models.CharField(max_length=64, null=True, blank=True)
    titularis_telephone = models.CharField(
        max_length=64,
        help_text=_("The telephone number of the titularis. Prefix 0 can be presented with the national call code in the system."),
        null=True,
        blank=True,
        )

    # Financial details
    bank_account_number = models.CharField(
        max_length=34,  # Max length of all IBAN account numbers
        validators=[validate_IBAN],
        help_text=_("The IBAN of this user. No spaces!"),
        )
    BIC = models.CharField(
        max_length=11,
        validators=[validate_BIC],
        help_text=_("The BIC of this user's bank."),
        )

""" NOTE: What about all the other features that should be in the administration?
While there are a lot of things to cover, as of now, I have no way to know which
ones are still valid, which are deprecated, and so on...
Additionally, every feature may have a different set of requirements, data,
and it's very likely making an abstract class won't do any good. Thus I have
decided to postpone making additional tables and forms for these features until
I have clearance about certain aspects. """

class Curriculum(models.Model):
    """ The curriculum of a particular student.
    Every academic year, a student has to hand in a curriculum (s)he wishes to
    follow. This is then reviewed by a committee. A curriculum exists of all the
    courses one wants to partake in in a certain year. """
    student = models.ForeignKey(
        "User",
        on_delete=models.CASCADE,
        limit_choices_to={'groups': 1},  # 1 = Students group ID
        null=False,
        #editable=False,
        #unique_for_year="year",  # Only 1 curriculum per year # FIXME to work with integer!
        )
    year = models.PositiveIntegerField(
        null=False,
        default=datetime.date.today().year,
        help_text=_("The academic year for which this curriculum is. "
                    "If this field is equal to 2008, then that means "
                    "this curriculum is for the academic year "
                    "2008-2009."),
        )
    # TODO: Validate changes: A curriculum cannot undergo another change if the
    # academic year it was made in is history.
    last_modified = models.DateTimeField(
        auto_now=True,
        help_text=_("The last timestamp that this was updated."),
        )
    course_programmes = models.ManyToManyField(
        "courses.CourseProgramme",
        blank=False,  # An empty curriculum makes no sense
        help_text=_("All the course programmes included in this curriculum."),
        )
    approved = models.NullBooleanField(
        default=None,
        help_text=_("Indicates if this curriculum has been approved. If true, "
                    "that means the responsible committee has reviewed and "
                    "approved the student for this curriculum. False otherwise. "
                    "If review is still pending, the value is NULL. Modifying "
                    "the curriculum implies this setting is set to NULL again."),
        )
    note = models.TextField(
        blank=True,
        help_text=_("Additional notes regarding this curriculum. This has "
                    "multiple uses. For the student, it is used to clarify "
                    "any questions, or to motivate why (s)he wants to take a "
                    "course for which the requirements were not met. "
                    "The reviewing committee can use this field to argument "
                    "their decision, especially for when the curriculum is "
                    "denied."),
        )

    def course_programmes_results(self):
        """ Returns a dictionary, where the keys are the course_programmes
        in this curriculum, and the values are the course_results associated
        with them."""
        join_dict = dict()
        for course_program in self.course_programmes.all():
            result = CourseResult.objects.filter(
                student=self.student).filter(
                    course_programme=course_program).filter(
                        year=self.year)
            if len(result) == 0:
                join_dict[course_program] = None
            else:
                join_dict[course_program] = result[0]
        return join_dict

    def courses(self):
        """ Returns a set of all the courses that are in this curriculum.
        This is not the same as CourseProgrammes, as these can differ depending
        on which study one follows. """
        course_set = set()
        for course_programme in self.course_programmes.all():
            course_set.add(course_programme.course)
        return course_set

    def curriculum_type(self):
        """ Returns the type of this curriculum. At the moment, this is
        either a standard programme, or an individualized programme. """
        # Currently: A standard programme means: All courses are from the
        # same study, ánd from the same year. Additionally, all courses
        # from that year must've been taken.
        # FIXME: Need a way to determine what is the standard programme.
        # If not possible, make this a charfield with options or something
        pass

    def __str__(self):
        return str(self.student) +" | "+ str(self.year) +"-"+ str(self.year+1)


class CourseResult(models.Model):
    """ A student has to obtain a certain course result. These are stored here,
    together with all the appropriate information. """
    # TODO: Validate that a course programme for a student can only be made once per year for each course, if possible.
    CRED = _("Credit acquired")
    FAIL = _("Credit not acquired")
    TLRD = _("Tolerated")
    ITLR = _("Tolerance used")
    BDRG = _("Fraud committed")
    VRST = _("Exemption")
    STOP = _("Course cancelled")
    # Possible to add more in the future
    # Possible to add more in the future

    student = models.ForeignKey(
        "User",
        on_delete=models.CASCADE,
        #limit_choices_to={'is_student': True},
        null=False,
        db_index=True,
        )
    course_programme = models.ForeignKey(
        "courses.CourseProgramme",
        on_delete=models.PROTECT,
        null=False,
        )
    year = models.PositiveIntegerField(
        null=False,
        default=datetime.date.today().year,
        help_text=_("The academic year this course took place in. If 2018 is entered, "
                    "then that means academic year '2018-2019'."),
        )
    released = models.DateField(
        auto_now=True,
        help_text=_("The date that this result was last updated."),
        )
    first_score = models.PositiveSmallIntegerField(
        null=True,  # It's possible a score does not exist.
        blank=True,
        validators=[MaxValueValidator(
            20,
            _("The score mustn't be higher than 20."),
            )],
        )
    second_score = models.PositiveSmallIntegerField(
        null=True,
        blank=True,
        validators=[MaxValueValidator(
            20,
            _("The score mustn't be higher than 20."),
            )],
        )
    result = models.CharField(
        max_length=10,
        choices = (
            ("CRED", CRED),
            ("FAIL", FAIL),
            ("TLRD", TLRD),
            ("ITLR", ITLR),
            ("BDRG", BDRG),
            ("VRST", VRST),
            ("STOP", STOP),
            ),
            ),
        blank=False,
        help_text=_("The final result this record constitutes."),
        )
        help_text=_("The result this record constitutes."),
        )

    def __str__(self):
        stdnum = str(self.student.number)
        result = self.result
        if result == "CRED":
            if self.first_score < 10:
                result = "C" + str(self.first_score) + "1"
            else:
                result = "C" + str(self.second_score) + "2"
        course = str(self.course_programme.course)
        return stdnum +" ("+ result +") | "+ course

class PreRegistration(models.Model):
    """ At the beginning of the new academic year, students can register
    themselves at the university. Online, they can do a preregistration already.
    These records are stored here and can later be retrieved for the actual
    registration process.
    Note: The current system in use at Hasselt University provides a password system.
    That will be eliminated here. Just make sure that the entered details are correct.
    Should there be an error, and the same email address is used to update something,
    a mail will be sent to that address to verify this was a genuine update."""
    created = models.DateField(auto_now_add=True)
    first_name = models.CharField(max_length=64, blank=False, help_text=_("Your first name."))
    last_name = models.CharField(max_length=64, blank=False, help_text=_("Your last name."))
    additional_names = models.CharField(max_length=64, blank=True, help_text=_("Any additional names."))
    title = models.CharField(
        max_length=64,
        blank=True,
        help_text=_("Any additional titles, prefixes, ..."),
        )
    DOB = models.DateField(
        blank=False,
        #editable=False,
        help_text=_("Your date of birth."),
        )
    POB = models.CharField(
        max_length=64,
        blank=False,
        #editable=False,
        help_text=_("The place you were born."),
        )
    nationality = models.CharField(
        max_length=64,
        blank=False,
        help_text=_("Your current nationality."),
        )
    national_registry_number = models.BigIntegerField(
        null=True,
        help_text=_("If you have one, your national registry number."),
        )
    civil_status = models.CharField(
        max_length=32,
        choices = (
            ("Single", _("Single")),
            ("Married", _("Married")),
            ("Divorced", _("Divorced")),
            ("Widowed", _("Widowed")),
            ("Partnership", _("Partnership")),
            ),
        blank=False,
        # There may be more; consult http://www.aantrekkingskracht.com/trefwoord/burgerlijke-staat
        # for more information.
        help_text=_("Your civil/marital status."),
        )
    email = models.EmailField(
        blank=False,
        unique=True,
        help_text=_("The e-mail address we will use to communicate until your actual registration."),
        )
    study = models.ForeignKey(
        "courses.Study",
        on_delete=models.PROTECT,
        null=False,
        help_text=_("The study you wish to follow. Be sure to provide all legal"
                    "documents that are required for this study with this "
                    "application, or bring them with you to the final registration."),
        )
    study_type = models.CharField(
        max_length=32,
        choices = (
            ("Diplom contract", _("Diplom contract")),
            ("Exam contract", _("Exam contract")),
            ("Credit contract", _("Credit contract")),
            ),
        blank=False,
        help_text=_("The type of study contract you wish to follow."),
        )
    document = models.FileField(
        upload_to="pre-enrollment/%Y",
        help_text=_("Any legal documents regarding your enrollment."),
        )
    # XXX: If the database in production is PostgreSQL, comment document, and
    # uncomment the next column.
    """documents = models.ArrayField(
        models.FileField(upload_to="pre-enrollment/%Y"),
        help_text=_("Any legal documents regarding your enrollment."),
        )"""

    def __str__(self):
        name = self.last_name +" "+ self.first_name
        dob = self.DOB.strftime("%d/%m/%Y")
        return name +" | "+ dob


# Planning and organization related tables
class Room(models.Model):
    """ Represents a room in the university.
    Rooms can have a number of properties, which are stored in the database.
    """
    # Types of rooms
    LABORATORY = _("Laboratory")  # Chemistry/Physics equipped rooms
    CLASS_ROOM = _("Class room")  # Simple class rooms
    AUDITORIUM = _("Auditorium")  # Large rooms with ample seating and equipment for lectures
    PC_ROOM    = _("PC room"   )  # Rooms equipped for executing PC related tasks
    PUBLIC_ROOM= _("Public room") # Restaurants, restrooms, ... general public spaces
    OFFICE     = _("Office"    )  # Private offices for staff
    PRIVATE_ROOM = _("Private room")  # Rooms accessible for a limited public; cleaning cupboards, kitchens, ...
    WORKSHOP   = _("Workshop"  )  # Rooms with hardware equipment to build and work on materials
    OTHER      = _("Other"     )  # Rooms that do not fit in any other category


    name = models.CharField(
        max_length=20,
        primary_key=True,
        blank=False,
        help_text=_("The name of this room. If more appropriate, this can be the colloquial name."),
        )
    seats = models.PositiveSmallIntegerField(
        help_text=_("The amount of available seats in this room."),
        )
    wheelchair_accessible = models.BooleanField(default=True)
    exams_equipped = models.BooleanField(
        default=True,
        help_text=_("Indicates if exams can reasonably be held in this room."),
        )
    loose_tables = models.BooleanField(
        default=True,
        help_text=_("If true, the tables in this room can be moved freely. "
                    "If false, they're bolted down in their positions."),
        )
    electrical_plugs = models.PositiveSmallIntegerField(
        help_text=_("The amount of electrical plugs that are available to the "
                    "people for free use. Electrical plugs that are more or "
                    "less constantly occupied by permanent equipment (such as "
                    "computers, beamers, ...) are excluded from counting."),
        )
    exterior_window = models.BooleanField(
        default=True,
        help_text=_("Indicates if this room has a window to the outside."),
        )
    software_available = models.TextField(
        blank=True,
        help_text=_("Some software used at the university is proprietary, and "
                    "thus not available at every system. If certain "
                    "software is installed on the computers in this room that "
                    "cannot be found on other computers, list them here."),
        )
    computers_available = models.PositiveSmallIntegerField(
        default=0,
        help_text=_("Indicates how many computers are available in this room."),
        )
    projector_available = models.BooleanField(
        default=False,
        help_text=_("Indicates if a projector is available at this room."),
        )
    blackboards_available = models.PositiveSmallIntegerField(
        help_text=_("The amount of blackboards available in this room."),
        )
    whiteboards_available = models.PositiveSmallIntegerField(
        help_text=_("The amount of whiteboards available in this room."),
        )
    category = models.CharField(
        max_length=16,
        blank=False,
        choices = (
            ("LABORATORY", LABORATORY),
            ("CLASS_ROOM", CLASS_ROOM),
            ("AUDITORIUM", AUDITORIUM),
            ("PC_ROOM", PC_ROOM),
            ("PUBLIC_ROOM", PUBLIC_ROOM),
            ("OFFICE", OFFICE),
            ("PRIVATE_ROOM", PRIVATE_ROOM),
            ("WORKSHOP", WORKSHOP),
            ("OTHER", OTHER),
            ),
        help_text=_("The category that best suits the character of this room."),
        )
    reservable = models.BooleanField(
        default=True,
        help_text=_("Indicates if this room can be reserved for something."),
        )
    note = models.TextField(
        blank=True,
        help_text=_("If some additional info is required for this room, like a "
                    "characteristic property (e.g. 'Usually occupied by 2BACH "
                    "informatics'), state it here."),
        )
    # TODO: Add a campus/building field or not?

    def next_reservation(self, time):
        """ Returns the next reservation starting from the given time, or, if
        the next reservation starts on the given time, that reservation.
        Returns None if there is no reservation from this moment on."""
        reservations = RoomReservation.objects.filter(room=self).filter(begin_time__gte=time).order_by('begin_time')
        if len(reservations) == 0:
            return None
        else:
            return reservations[0]
    def next_event(self, time):
        """ Returns the next event starting from the given time, or, if
        the next event starts on the given time, that event.
        Returns None if there is no event from this moment on."""
        events = CourseEvent.objects.filter(room=self).filter(begin_time__gte=time).order_by('begin_time')
        if len(events) == 0:
            return None
        else:
            return events[0]


    def reservation_possible(self, begin, end, seats=None):
        # TODO: Include events in the check for possibilities!
        """ Returns a boolean indicating if reservating during the given time
        is possible. If the begin overlaps with a reservation's end or vice versa,
        this is regarded as possible.
        Takes seats as optional argument. If not specified, it is assumed the entire
        room has to be reserved. """
        if self.reservable is False:
            return False
        if seats is not None and seats < 0: raise ValueError(_("seats ∈ ℕ"))

        reservations = RoomReservation.objects.filter(room=self)
        for reservation in reservations:
            if reservation.end_time <= begin or reservation.begin_time >= end:
                continue  # Can be trivially skipped, no overlap here
            elif seats is None or reservation.seats is None:
                return False  # The whole room cannot be reserved -> False
            elif seats + reservation.seats > self.seats:
                    return False  # Total amount of seats exceeds the available amount -> False
        return True  # No overlappings found -> True

    def __str__(self):
        return self.name


# Validators that will be used for RoomReservations and Events
def validate_event_time(time):
    """Checks if the time is a quarter of an hour (0, 15, 30, or 45)."""
    if time.minute not in [0, 15, 30, 45] or time.second != 0:
        raise ValidationError(
            _('%(time)s is not in the quarter of an hour.'),
            params={'time': time.strftime("%H:%M")})
def validate_university_hours(value):
    """Checks if the datetime value given takes place during the opening hours
    of the university (08:00 - 20:00)."""
    if value.hour < 8 or (value.hour == 22 and value.minute != 0) or value.hour >= 23:
        raise ValidationError(
            _("All events and reservations must begin and end between 08:00 "
              "and 22:00."))
def overlaps(begin_a, end_a, begin_b, end_b):
    """Checks if timespan a and b overlap with each other. If one of them ends at
    the same time the other one begins, it does not count as an overlap.
    This function assumes the end takes place strictly /after/ the begin."""
    if end_a <= begin_b or end_b <= begin_a:
        return False
    if (
            begin_a < begin_b <= end_a or
            begin_b < begin_a <= end_b or
            begin_a <= end_b < end_a or
            begin_b <= end_a < end_b):
        return True
    else:
        return False


def general_reservation_validator(self):
    # Check for overlapping reservations
    # TODO: Try to make it possible to link to the reservator,
    # to display the reason, to show the available times that a
    # reservation can be made for that room, and so on... Make it
    # a bit more interactive.
    for reservation in RoomReservation.objects.filter(room=self.room):
        if overlaps(self.begin_time,
                    self.end_time,
                    reservation.begin_time,
                    reservation.end_time):
            if isinstance(self, RoomReservation):
                if self.room.reservation_possible(self.begin_time, self.end_time, self.seats):
                    continue  # Both reservations can take place in the same room
                raise ValidationError(
                _("It is not possible to plan this event/reservation in "
                "%(room)s from %(self_begin)s to %(end_begin)s on %(day)s. "
                "%(reservator)s has already "
                "reserved it from %(res_begin)s to %(res_end)s."),
                params={'room': str(self.room),
                        'self_begin': self.begin_time.strftime("%H:%M"),
                        'self_end': self.end_time.strftime("%H:%M"),
                        'day': self.begin_time.strftime("%A (%d/%m)"),
                        'reservator': str(reservation.reservator),
                        'res_begin': reservation.begin_time.strftime("%H:%M"),
                        'res_end': reservation.end_time.strftime("%H:%M"),
                        })
    for course_event in CourseEvent.objects.filter(room=self.room):
        if overlaps(self.begin_time,
                    self.end_time,
                    course_event.begin_time,
                    course_event.end_time):
            raise ValidationError(
                _("%(docent)s has organized a %(subject)s in %(room)s from "
                    "%(res_begin)s to %(res_end)s on %(day)s, so you cannot "
                    "place a reservation there from %(self_begin)s to "
                    "%(self_end)s."),
                params={'room': str(self.room),
                        'self_begin': self.begin_time.strftime("%H:%M"),
                        'self_end': self.end_time.strftime("%H:%M"),
                        'day': self.begin_time.strftime("%A (%d/%m)"),
                        'docent': str(course_event.docent),
                        'subject': course_event.subject,
                        'res_begin': course_event.begin_time.strftime("%H:%M"),
                        'res_end': course_event.end_time.strftime("%H:%M"),})

    # Checking for correct timings:
    if self.begin_time >= self.end_time:
        raise ValidationError(
            _("The begin time (%(begin)) must take place <em>before</em> "
                "the end time (%(end))."),
            params={'begin': self.begin_time.strftime("%H:%M"),
                    'end': self.end_time.strftime("%H:%M"),})
    """if not roster.same_day(self.begin_time, self.end_time):
        raise ValidationError(
            _("The event/reservation must begin and end on the same day."))"""


class RoomReservation(models.Model):
    """ Rooms are to be reserved from time to time. They can be reserved
    by externals, for something else, and whatnot. That is stored in this table.
    """
    room = models.ForeignKey(
        "Room",
        on_delete=models.CASCADE,
        null=False,
        #editable=False,
        db_index=True,
        limit_choices_to={"reservable": True},
        help_text=_("The room that is being reserved at this point."),
    )
    reservator = models.ForeignKey(
        "User",
        on_delete=models.CASCADE,
        null=False,
        #editable=False,
        help_text=_("The person that made the reservation (and thus responsible)."),
    )
    timestamp = models.DateTimeField(auto_now_add=True)
    begin_time = models.DateTimeField(
        null=False,
        help_text=_("The time that this reservation begin."),
        validators=[validate_event_time,validate_university_hours],
    )
    end_time = models.DateTimeField(
        null=False,
        help_text=_("The time that this reservation ends."),
        validators=[validate_event_time,validate_university_hours],
    )
    seats = models.PositiveSmallIntegerField(
        null=True,
        blank=True,
        help_text=_("Indicates how many seats are required. If this is left empty, "
                    "it is assumed the entire room has to be reserved."),
    )
    reason = models.CharField(
        max_length=64,
        blank=True,
        help_text=_("The reason for this reservation, if useful."),
    )
    note = models.TextField(
        blank=True,
        help_text=_("If some additional info is required for this reservation, "
                    "state it here."),
    )

    def __str__(self):
        start = self.start_time.strftime("%H:%M")
        end = self.end_time.strftime("%H:%M")
        return str(self.room) +" | "+ start +"-"+ end

    def clean(self):
        general_reservation_validator(self)

class Degree(models.Model):
    """ Contains all degrees that were achieved at this university.
    There are no foreign keys in this field. This allows system
    administrators to safely remove accounts from alumni, without
    the risk of breaking referential integrity or accidentally removing
    degrees.
    While keeping some fields editable that look like they shouldn't be
    (e.g. first_name), this makes it possible for alumni to have a name change
    later in their life, and still being able to get a copy of their degree. """
    """ Reason for an ID field for every degree:
    This system allows for employers to verify that a certain applicant has indeed,
    achieved the degrees (s)he proclaims to have. Because of privacy concerns,
    a university cannot disclose information about alumni.
    That's where the degree ID comes in. This ID can be printed on all future
    degrees. The employer can then visit the university's website, and simply
    enter the ID. The website will then simply print what study is attached to
    this degree, but not disclose names or anything identifiable. This strikes
    thé perfect balance between (easy and digital) degree verification for employers, and maintaining
    alumni privacy to the highest extent possible. """
    id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
    first_name = models.CharField(
        max_length=64,
        blank=False,
        )
    last_name = models.CharField(
        max_length=64,
        blank=False,
        )
    additional_names = models.CharField(
        max_length=64,
        blank=True,
        )
    DOB = models.DateField(null=False)#editable=False, null=False)  # This can't be changed, of course
    POB = models.CharField(
        max_length=64,
        blank=False,
        #editable=False,
        )
    # The study also has to be a charfield, because if a study is removed,
    # The information will be lost.
    study = models.CharField(
        max_length=64,
        blank=False,
        #editable=False,
        )
    achieved = models.DateField(null=False)#editable=False, null=False)
    user = models.ForeignKey(
        "User",
        on_delete=models.SET_NULL,
        null=True,
        help_text=_("The person that achieved this degree, if (s)he still has "
                    "an account at this university. If the account is deleted "
                    "at a later date, this field will be set to NULL, but the "
                    "other fields will be retained."),
        )

    def __str__(self):
        return self.first_name +" "+ self.last_name +" | "+ self.study


# Classes regarding roster items


class Event(models.Model):
    """An event that will show up in the roster of accounts that need to be
    aware of this event. This can be a multitude of things, like colleges
    for certain courses, meetings like blood donations, and so on. There are
    specialized classes for certain types of events that take place."""
    begin_time = models.DateTimeField(
        null=False,
        help_text=_("The begin date and time that this event takes place. "
                    "This value must be a quarter of an hour (0, 15, 30, 45), "
                    "and take place <em>before</em> this event's end time."),
        verbose_name=_("begin time"),
        validators=[validate_event_time, validate_university_hours],
        )
    end_time = models.DateTimeField(
        null=False,
        help_text=_("The end date and time that this event takes place. "
                    "This value must be a quarter of an hour (0, 15, 30, 45), "
                    "and take place <em>after</em> this event's begin time, "
                    "but it must end on the same day as it begins!"),
        verbose_name=_("end time"),
        validators=[validate_event_time, validate_university_hours],
        )
    note = models.TextField(
        blank=True,
        help_text=_("Optional. If necessary, this field allows for additional "
                    "information that can be shown to the people for whom this "
                    "event is."),
        )
    created = models.DateTimeField(
        auto_now_add=True,
        )
    last_update = models.DateTimeField(
        auto_now=True,
        )

    def recently_created(self):
        """Indicates if this event was created in the last 5 days."""
        return (datetime.datetime.now(datetime.timezone.utc) - self.created).days <= 5
    def recently_updated(self):
        """Indicates if this event was updated in the last 5 days."""
        return (datetime.datetime.now(datetime.timezone.utc) - self.last_update).days <= 5

class CourseEvent(Event):
    """An event related to a particular course. This includes a location,
    a group (if applicable), and other data."""
    course = models.ForeignKey(
        "courses.CourseProgramme",
        on_delete=models.CASCADE,
        null=False,
        )
    docent = models.ForeignKey(
        "User",
        on_delete=models.PROTECT,
        null=False,
        limit_choices_to={'is_staff': True},
        help_text=_("The person who will be the main overseer of this event."),
        )
    room = models.ForeignKey(
        "Room",
        on_delete=models.PROTECT,
        limit_choices_to={'reservable': True},
        null=False,
        help_text=_("The room in which this event will be held."),
        )
    subject = models.CharField(
        max_length=32,
        blank=False,
        help_text=_("The subject of this event. Examples are 'Hoorcollege', "
                    "'Zelfstudie', ..."),
        )
    group = models.ForeignKey(
        "courses.CourseGroup",
        on_delete = models.CASCADE,
        null=True,
        blank=True,
        help_text=_("Some courses have multiple groups. If that's the case, "
                    "and this event is only for a specific group, then that "
                    "group must be referenced here."),
        )

    def clean(self):
        general_reservation_validator(self)


class UniversityEvent(Event):
    """University wide events. These include events like blood donations for the
    Red Cross, for example."""
    pass

class StudyEvent(Event):
    """An event that is linked to a particular study, like lectures from guest
    speakers about a certain subject, the Flemish Programming Contest, ..."""
    pass

class ExamCommissionDecision(models.Model):
    """The Exam commission can make certain decisions regarding individual
    students. Every decision on its own is stored in this table, and is linked
    to the recipient's account."""
    user = models.ForeignKey(
        User,
        on_delete=models.CASCADE,
        null=False,
        help_text=_("The recipient of this decision."),
        )
    date = models.DateField(auto_now_add=True)
    text = models.TextField(
        blank=False,
        help_text=_("The text describing the decision. Org syntax available.")
        )
    def __str__(self):
        return str(self.user) + " | " + str(self.date)

    class Meta:
        verbose_name = _("Decision of the exam commission")
        verbose_name_plural = _("Decisions of the exam commission")

class EducationDepartmentMessages(models.Model):
    """The department of education can issue messages that are to be shown to
    all students. Their contents are stored here."""
    date = models.DateField(auto_now_add=True)
    title = models.CharField(
        max_length=64,
        blank=False,
        help_text=_("A short, well-describing title for this message."),
        )
    text = models.TextField(
        blank=False,
        help_text=_("The message text. Org syntax available.")
        )
    def __str__(self):
        return str(self.date) + " | " + str(self.title)

    class Meta:
        verbose_name = _("Message of the education department")
        verbose_name_plural = _("Messages of the education department")


courses/forms.py ¶

6 additions and 0 deletions.

View changes Hide changes

from django.forms import ModelForm, modelformset_factory
from . import models


class AssignmentForm(ModelForm):
    class Meta:
        model = models.Assignment
        fields = ['title',
                  'information',
                  'deadline',
                  'digital_task',
                  ]
class AnnouncementForm(ModelForm):
    class Meta:
        model = models.Announcement
        fields = ['title',
                  'text',
                  ]
class UploadForm(ModelForm):
    class Meta:
        model = models.Upload
        fields = ['comment',
                  'file',
                  ]
class CourseItemForm(ModelForm):
    class Meta:
        model = models.CourseItem
        fields = ['file',
                  'note',
                  ]

AssignmentFormSet = modelformset_factory(
    models.Assignment, fields=('title', 'information', 'deadline', 'digital_task'),
    localized_fields="__all__",
    can_delete=True,
    )
AnnouncementFormSet = modelformset_factory(
    models.Announcement, fields=('title', 'text'),
    localized_fields="__all__",
    can_delete=True,
    )
CourseItemFormSet = modelformset_factory(
    models.CourseItem, fields=('file', 'note'),
    localized_fields="__all__",
    can_delete=True,
    )

    administration.models.CourseResult, fields=('student', 'first_score', 'second_score', 'result'),
    localized_fields="__all__",
    can_delete=True,
    )


courses/templates/courses/edit_course_items.djhtml ¶

4 additions and 1 deletion.

View changes Hide changes

{% load static %}
{% load i18n %}
{% load joeni_org %}

{% block title %}
    {{ course.name }} | {{ block.super }}
{% endblock %}

{% block main %}
    {% include "administration/nav.djhtml" %}
    <p>
        {% blocktrans %}You can edit announcements, assignments, and course
            items on this page, mark them for deletion, and add new ones.
            When all changes are saved successfully, you will be redirected to
            the course's main page. When errors occur, you will stay on this page,
            and receive error notifications where necessary.{% endblocktrans %}
    </p>

    <form action="" method="POST">
        {% csrf_token %}
        <h2 id="{% trans "announcements" %}">{% trans "Announcements" %}</h2>
            <table>
                {{ announcements }}
            </table>
        <h2 id="{% trans "assignments" %}">{% trans "Assignments" %}</h2>
            <table>
            {{ assignments }}
            </table>
        <h2 id="{% trans "course-items" %}">{% trans "Course items" %}</h2>
            <table>
                {{ course_items }}
            </table>
        <hr />
            <table>
                {{ course_results }}
            </table>
        <hr />
        <input type="submit" value="{% trans "Save everything" %}" />
    </form>
{% endblock main %}


courses/views.py ¶

12 additions and 9 deletions.

View changes Hide changes

import datetime
from django.urls import reverse # Why?
from django.utils.translation import gettext as _
from .models import *
from .forms import *
import administration
from django.contrib.auth.decorators import login_required
from joeni.constants import current_academic_year

@login_required
def index(request):
    """ Starting page regarding the courses. This serves two specific groups:
    - Students: Displays all courses that this student has in his/her curriculum
                for this academic year. Requires the curriculum to be accepted.
    - Staff: Displays all courses in which the staff member is part of the
             educating team, or is otherwise related to the course.
    Users who are not logged in will be sent to the login page.
    """
    template = "courses/index.djhtml"
    courses = request.user.user_data.current_courses()

    context = {
        'courses': courses,
        }

    return render(request, template, context)

@login_required
def course(request, course_slug):
    template = "courses/course.djhtml"
    course = Course.objects.get(slug_name=course_slug)

    # Check if user can see this page
    if request.user.user_data.is_student:
        if course not in request.user.user_data.current_courses():
            """ I'm currently just redirecting to the index page, but maybe it's
            just as good to make an announcement that this course cannot be
            used by this user. """
            return index(request)

    context = {
        'course': course,
        'main_color': course.color,
        'announcements': Announcement.objects.filter(course=course),
        'assignments': Assignment.objects.filter(course=course),
        'course-items': CourseItem.objects.filter(course=course),
        'study-groups': StudyGroup.objects.filter(course=course),
        'uploads': Upload.objects.filter(course=course).filter(student=request.user)
        }
    if request.user.user_data.is_student:
        context['upload_form'] = UploadForm()

    return render(request, template, context)

# TODO: Find a way to see if it's possible to require some permissions and to
# put them in a decorator
#@permission_required
@login_required
def new_item(request, course_slug):
    template = "courses/new_item.djhtml"
    course = Course.objects.get(slug_name=course_slug)

    if request.user.user_data.is_student or request.user not in course.course_team:
        # Students can't add new items. Redirect to index
        # Also redirect people who are not part of the course team
        redirect('courses-index')
    # Now able to assume user is allowed to add items to this course

    context = {
        'course': course,
        'announcements': Announcement.objects.filter(course=course),
        'assignments': Assignment.objects.filter(course=course),
        'course-items': CourseItem.objects.filter(course=course),
        'study-groups': StudyGroup.objects.filter(course=course),
        'uploads': Upload.objects.filter(course=course)
        }

    return render(request, template, context)

@login_required
@login_required
def edit_course_items(request, course_slug):
    # TODO Only allow people on the course team to this page!
    template = "courses/edit_course_items.djhtml"
    context = dict()
    course_ = Course.objects.get(slug_name=course_slug)
    if request.method == 'POST':
        assignments = AssignmentFormSet(request.POST, prefix='assignments')
        announcements = AnnouncementFormSet(request.POST, prefix='announcements')
        course_items = CourseItemFormSet(request.POST, request.FILES, prefix='course_items')
        if assignments.is_valid() and announcements.is_valid() and course_items.is_valid():
            assignments.save(commit=False)
        if assignments.is_valid() and announcements.is_valid() and course_items.is_valid() and course_results.is_valid():
            assignments.save(commit=False)
            announcements.save(commit=False)
            course_items.save(commit=False)
            for new_assignment in assignments.new_objects:
            for new_assignment in assignments.new_objects:
                new_assignment.course = course_
            for new_announcement in announcements.new_objects:
                new_announcement.course = course_
            for new_course_item in course_items.new_objects:
                new_coutse_item.course = course_
            assignments.save()
                new_coutse_result.course = course_
            assignments.save()
            announcements.save()
            course_items.save()
            return course(request, course_slug)
            return course(request, course_slug)
    else:
        assignments = AssignmentFormSet(
            queryset=Assignment.objects.filter(course=course_),
            prefix="assignments",
            )
        announcements = AnnouncementFormSet(
            queryset=Announcement.objects.filter(course=course_),
            prefix="announcements",
            )
        course_items = CourseItemFormSet(
            queryset=CourseItem.objects.filter(course=course_),
            prefix="course_items",
            )
    context['assignments'] = assignments
            queryset=CourseResult.objects.filter(course=course_).filter(year=current_academic_year()),
            prefix="course_results",
            )
    context['assignments'] = assignments
    context['announcements'] = announcements
    context['course_items'] = course_items
    return render(request, template, context)
    return render(request, template, context)


@login_required
def remove(request, type, id):
    pass

@login_required
def upload(request):
    pass

@login_required
def groups(request):
    pass

def fiche(request, course_slug):
    """Displays the fiche for the given course. Includes information about all
    course programs."""
    template = "courses/fiche.djhtml"
    context = dict()
    course = Course.objects.get(slug_name=course_slug)
    


1	1	from django.forms import ModelForm, modelformset_factory
2	2	from . import models
3	3
+	4
4	5	class AssignmentForm(ModelForm):
5	6	class Meta:
6	7	model = models.Assignment
7	8	fields = ['title',
8	9	'information',
9	10	'deadline',
10	11	'digital_task',
11	12	]
12	13	class AnnouncementForm(ModelForm):
13	14	class Meta:
14	15	model = models.Announcement
15	16	fields = ['title',
16	17	'text',
17	18	]
18	19	class UploadForm(ModelForm):
19	20	class Meta:
20	21	model = models.Upload
21	22	fields = ['comment',
22	23	'file',
23	24	]
24	25	class CourseItemForm(ModelForm):
25	26	class Meta:
26	27	model = models.CourseItem
27	28	fields = ['file',
28	29	'note',
29	30	]
30	31
31	32	AssignmentFormSet = modelformset_factory(
32	33	models.Assignment, fields=('title', 'information', 'deadline', 'digital_task'),
33	34	localized_fields="__all__",
34	35	can_delete=True,
35	36	)
36	37	AnnouncementFormSet = modelformset_factory(
37	38	models.Announcement, fields=('title', 'text'),
38	39	localized_fields="__all__",
39	40	can_delete=True,
40	41	)
41	42	CourseItemFormSet = modelformset_factory(
42	43	models.CourseItem, fields=('file', 'note'),
43	44	localized_fields="__all__",
44	45	can_delete=True,
45	46	)
46	47
+	48	administration.models.CourseResult, fields=('student', 'first_score', 'second_score', 'result'),
+	49	localized_fields="__all__",
+	50	can_delete=True,
+	51	)
+	52

1	1	{% load static %}
2	2	{% load i18n %}
3	3	{% load joeni_org %}
4	4
5	5	{% block title %}
6	6	{{ course.name }} \| {{ block.super }}
7	7	{% endblock %}
8	8
9	9	{% block main %}
10	10	{% include "administration/nav.djhtml" %}
11	-	<p>
12	11	{% blocktrans %}You can edit announcements, assignments, and course
13	12	items on this page, mark them for deletion, and add new ones.
14	13	When all changes are saved successfully, you will be redirected to
15	14	the course's main page. When errors occur, you will stay on this page,
16	15	and receive error notifications where necessary.{% endblocktrans %}
17	16	</p>
18	17
19	18	<form action="" method="POST">
20	19	{% csrf_token %}
21	20	<h2 id="{% trans "announcements" %}">{% trans "Announcements" %}</h2>
22	21	<table>
23	22	{{ announcements }}
24	23	</table>
25	24	<h2 id="{% trans "assignments" %}">{% trans "Assignments" %}</h2>
26	25	<table>
27	26	{{ assignments }}
28	27	</table>
29	28	<h2 id="{% trans "course-items" %}">{% trans "Course items" %}</h2>
30	29	<table>
31	30	{{ course_items }}
32	31	</table>
33	32	<hr />
+	33	<table>
+	34	{{ course_results }}
+	35	</table>
+	36	<hr />
34	37	<input type="submit" value="{% trans "Save everything" %}" />
35	38	</form>
36	39	{% endblock main %}
37	40

1	1	import datetime
2	2	from django.urls import reverse # Why?
3	3	from django.utils.translation import gettext as _
4	4	from .models import *
5	5	from .forms import *
6	6	import administration
7	7	from django.contrib.auth.decorators import login_required
8	8	from joeni.constants import current_academic_year
9	9
10	10	@login_required
11	11	def index(request):
12	12	""" Starting page regarding the courses. This serves two specific groups:
13	13	- Students: Displays all courses that this student has in his/her curriculum
14	14	for this academic year. Requires the curriculum to be accepted.
15	15	- Staff: Displays all courses in which the staff member is part of the
16	16	educating team, or is otherwise related to the course.
17	17	Users who are not logged in will be sent to the login page.
18	18	"""
19	19	template = "courses/index.djhtml"
20	20	courses = request.user.user_data.current_courses()
21	21
22	22	context = {
23	23	'courses': courses,
24	24	}
25	25
26	26	return render(request, template, context)
27	27
28	28	@login_required
29	29	def course(request, course_slug):
30	30	template = "courses/course.djhtml"
31	31	course = Course.objects.get(slug_name=course_slug)
32	32
33	33	# Check if user can see this page
34	34	if request.user.user_data.is_student:
35	35	if course not in request.user.user_data.current_courses():
36	36	""" I'm currently just redirecting to the index page, but maybe it's
37	37	just as good to make an announcement that this course cannot be
38	38	used by this user. """
39	39	return index(request)
40	40
41	41	context = {
42	42	'course': course,
43	43	'main_color': course.color,
44	44	'announcements': Announcement.objects.filter(course=course),
45	45	'assignments': Assignment.objects.filter(course=course),
46	46	'course-items': CourseItem.objects.filter(course=course),
47	47	'study-groups': StudyGroup.objects.filter(course=course),
48	48	'uploads': Upload.objects.filter(course=course).filter(student=request.user)
49	49	}
50	50	if request.user.user_data.is_student:
51	51	context['upload_form'] = UploadForm()
52	52
53	53	return render(request, template, context)
54	54
55	55	# TODO: Find a way to see if it's possible to require some permissions and to
56	56	# put them in a decorator
57	57	#@permission_required
58	58	@login_required
59	59	def new_item(request, course_slug):
60	60	template = "courses/new_item.djhtml"
61	61	course = Course.objects.get(slug_name=course_slug)
62	62
63	63	if request.user.user_data.is_student or request.user not in course.course_team:
64	64	# Students can't add new items. Redirect to index
65	65	# Also redirect people who are not part of the course team
66	66	redirect('courses-index')
67	67	# Now able to assume user is allowed to add items to this course
68	68
69	69	context = {
70	70	'course': course,
71	71	'announcements': Announcement.objects.filter(course=course),
72	72	'assignments': Assignment.objects.filter(course=course),
73	73	'course-items': CourseItem.objects.filter(course=course),
74	74	'study-groups': StudyGroup.objects.filter(course=course),
75	75	'uploads': Upload.objects.filter(course=course)
76	76	}
77	77
78	78	return render(request, template, context)
79	79
80	80	@login_required
+	81	@login_required
81	82	def edit_course_items(request, course_slug):
82	83	# TODO Only allow people on the course team to this page!
83	84	template = "courses/edit_course_items.djhtml"
84	85	context = dict()
85	86	course_ = Course.objects.get(slug_name=course_slug)
86	87	if request.method == 'POST':
87	88	assignments = AssignmentFormSet(request.POST, prefix='assignments')
88	89	announcements = AnnouncementFormSet(request.POST, prefix='announcements')
89	90	course_items = CourseItemFormSet(request.POST, request.FILES, prefix='course_items')
90	91	if assignments.is_valid() and announcements.is_valid() and course_items.is_valid():
91	-	assignments.save(commit=False)
+	92	if assignments.is_valid() and announcements.is_valid() and course_items.is_valid() and course_results.is_valid():
+	93	assignments.save(commit=False)
92	94	announcements.save(commit=False)
93	95	course_items.save(commit=False)
94	96	for new_assignment in assignments.new_objects:
+	97	for new_assignment in assignments.new_objects:
95	98	new_assignment.course = course_
96	99	for new_announcement in announcements.new_objects:
97	100	new_announcement.course = course_
98	101	for new_course_item in course_items.new_objects:
99	102	new_coutse_item.course = course_
100	103	assignments.save()
+	104	new_coutse_result.course = course_
+	105	assignments.save()
101	106	announcements.save()
102	107	course_items.save()
103	108	return course(request, course_slug)
+	109	return course(request, course_slug)
104	110	else:
105	111	assignments = AssignmentFormSet(
106	112	queryset=Assignment.objects.filter(course=course_),
107	113	prefix="assignments",
108	114	)
109	115	announcements = AnnouncementFormSet(
110	116	queryset=Announcement.objects.filter(course=course_),
111	117	prefix="announcements",
112	118	)
113	119	course_items = CourseItemFormSet(
114	120	queryset=CourseItem.objects.filter(course=course_),
115	121	prefix="course_items",
116	122	)
117	123	context['assignments'] = assignments
+	124	queryset=CourseResult.objects.filter(course=course_).filter(year=current_academic_year()),
+	125	prefix="course_results",
+	126	)
+	127	context['assignments'] = assignments
118	128	context['announcements'] = announcements
119	129	context['course_items'] = course_items
120	130	return render(request, template, context)
+	131	return render(request, template, context)
121	132
122	133
123	134	@login_required
124	-	def remove(request, type, id):
125	-	pass
126	-
127	-	@login_required
128	-	def upload(request):
129	-	pass
130	-
131	135	@login_required
132	136	def groups(request):
133	137	pass
134	138
135	139	def fiche(request, course_slug):
136	140	"""Displays the fiche for the given course. Includes information about all
137	141	course programs."""
138	142	template = "courses/fiche.djhtml"
139	143	context = dict()
140	144	course = Course.objects.get(slug_name=course_slug)
141	145
142	-