joeni

Refinement of roster module in administration

The functionality of the roster has been moved to its own module, to keep it nicely seperated from what is the view code.
Several updates in the models have been made, so the migrations have been included.
Added a couple models to the admin registry so elements can be added in the admin interface.
Also added some new style classes for the roster to indicate important things like a change, new event, or notification.

Author: Maarten 'Vngngdn' Vangeneugden
Date: Feb. 4, 2018, 7:21 p.m.
Hash: 838a4c30e3ac78883df4d4a301ef8929e5be6ffe
Parent: db2baced09f3dd36acf8ca5ebb352e88c7b30ed1
Modified files: administration/admin.py; administration/migrations/0012_auto_20180204_1349.py; administration/migrations/0013_auto_20180204_1444.py; administration/models.py; administration/roster.py; administration/templates/administration/roster.djhtml; administration/views.py; courses/admin.py; courses/migrations/0005_auto_20180204_1349.py; courses/migrations/0006_auto_20180204_1349.py; courses/models.py; static/css/base.css

administration/admin.py ¶

5 additions and 0 deletions.

View changes Hide changes

from .models import *
from django.contrib.auth.admin import UserAdmin

admin.site.register(User, UserAdmin)

admin.site.register(Curriculum)
admin.site.register(UserData)
admin.site.register(CourseResult)
admin.site.register(PreRegistration)
admin.site.register(Room)
admin.site.register(RoomReservation)
admin.site.register(Degree)

admin.site.register(CourseEvent)
admin.site.register(CourseEvent)
admin.site.register(UniversityEvent)
admin.site.register(StudyEvent)

admin.site.register(ExamCommissionDecision)
admin.site.register(EducationDepartmentMessages)



administration/migrations/0012_auto_20180204_1349.py ¶

57 additions and 0 deletions.

View changes Hide changes

+	1
+	2	import administration.models
+	3	from django.conf import settings
+	4	from django.db import migrations, models
+	5	import django.db.models.deletion
+	6
+	7
+	8	class Migration(migrations.Migration):
+	9
+	10	dependencies = [
+	11	('administration', '0011_auto_20180128_1935'),
+	12	]
+	13
+	14	operations = [
+	15	migrations.CreateModel(
+	16	name='EducationDepartmentMessages',
+	17	fields=[
+	18	('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+	19	('date', models.DateField(auto_now_add=True)),
+	20	('title', models.CharField(help_text='A short, well-describing title for this message.', max_length=64)),
+	21	('text', models.TextField(help_text='The message text. Org syntax available.')),
+	22	],
+	23	options={
+	24	'verbose_name': 'Decision of the exam commission',
+	25	'verbose_name_plural': 'Decisions of the exam commission',
+	26	},
+	27	),
+	28	migrations.CreateModel(
+	29	name='ExamCommissionDecision',
+	30	fields=[
+	31	('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+	32	('date', models.DateField(auto_now_add=True)),
+	33	('text', models.TextField(help_text='The text describing the decision. Org syntax available.')),
+	34	('user', models.ForeignKey(help_text='The recipient of this decision.', on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL)),
+	35	],
+	36	options={
+	37	'verbose_name': 'Decision of the exam commission',
+	38	'verbose_name_plural': 'Decisions of the exam commission',
+	39	},
+	40	),
+	41	migrations.AddField(
+	42	model_name='courseresult',
+	43	name='year',
+	44	field=models.PositiveIntegerField(default=2018, help_text="The academic year this course took place in. If 2018 is entered, then that means academic year '2018-2019'."),
+	45	),
+	46	migrations.AlterField(
+	47	model_name='event',
+	48	name='begin_time',
+	49	field=models.DateTimeField(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.", validators=[administration.models.validate_event_time], verbose_name='begin time'),
+	50	),
+	51	migrations.AlterField(
+	52	model_name='event',
+	53	name='end_time',
+	54	field=models.DateTimeField(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.", validators=[administration.models.validate_event_time], verbose_name='end time'),
+	55	),
+	56	]
+	57

administration/migrations/0013_auto_20180204_1444.py ¶

29 additions and 0 deletions.

View changes Hide changes

+	1
+	2	from django.conf import settings
+	3	from django.db import migrations, models
+	4	import django.db.models.deletion
+	5
+	6
+	7	class Migration(migrations.Migration):
+	8
+	9	dependencies = [
+	10	('administration', '0012_auto_20180204_1349'),
+	11	]
+	12
+	13	operations = [
+	14	migrations.AlterModelOptions(
+	15	name='educationdepartmentmessages',
+	16	options={'verbose_name': 'Message of the education department', 'verbose_name_plural': 'Messages of the education department'},
+	17	),
+	18	migrations.AlterField(
+	19	model_name='courseevent',
+	20	name='group',
+	21	field=models.ForeignKey(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.", null=True, on_delete=django.db.models.deletion.CASCADE, to='courses.CourseGroup'),
+	22	),
+	23	migrations.AlterField(
+	24	model_name='curriculum',
+	25	name='student',
+	26	field=models.ForeignKey(limit_choices_to={'groups': 1}, on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL, unique_for_year='year'),
+	27	),
+	28	]
+	29

administration/models.py ¶

6 additions and 4 deletions.

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.contrib.auth.models import AbstractUser
import datetime
import os
import uuid

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)

class UserData(models.Model):
    user = models.OneToOneField(User, on_delete=models.CASCADE)
    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,
        help_text=_("The date of birth of this user."),
        )
    POB = models.CharField(
        max_length=64,
        blank=False,
        #editable=False,
        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."),
        )

    # 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)
    study_number = models.PositiveSmallIntegerField(blank=True)
    study_bus = models.CharField(max_length=10, null=True, blank=True)
    study_postal_code = models.PositiveSmallIntegerField(blank=True)
    study_country = models.CharField(max_length=64, blank=True)
    study_telephone = models.CharField(
        blank=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,
        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)
    titularis_bus = models.CharField(max_length=10, null=True, blank=True)
    titularis_postal_code = models.PositiveSmallIntegerField(null=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,
        )

    # 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={'is_student': True},
        null=False,
        null=False,
        #editable=False,
        unique_for_year="year",  # Only 1 curriculum per year
        )
    year = models.DateField(
        auto_now_add=True,
        db_index=True,
        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."),
        )
    last_modified = models.DateTimeField(
        auto_now=True,
        help_text=_("The last timestamp that this was updated."),
        )
    course_programmes = models.ManyToManyField(
        "courses.CourseProgramme",
        null=False,
        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 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:
            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):
        year = self.year.year
        if self.year.month < 7:
            return str(self.student) +" | "+ str(year-1) +"-"+ str(year)
        else:
            return str(self.student) +" | "+ str(year) +"-"+ str(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")
    ITLD = _("Tolerance used")
    BDRG = _("Fraud committed")
    VRST = _("Exemption")
    STOP = _("Course cancelled")
    # Possible to add more in the future

    student = models.ForeignKey(
        "User",
        on_delete=models.CASCADE,
        limit_choices_to={'is_student': True},
        null=False,
        )
    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.
        validators=[MaxValueValidator(
            20,
            _("The score mustn't be higher than 20."),
            )],
        )
    second_score = models.PositiveSmallIntegerField(
        null=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),
            ("ITLD", ITLD),
            ),
        blank=False,
        help_text=_("The final 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" + self.first_score + "1"
            else:
                result = "C" + 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. This can be handy for exams for example."),
        )
    wheelchair_accessible = models.BooleanField(default=True)
    exams_equipped = models.BooleanField(
        default=True,
        help_text=_("Indicates if exams can reasonably be held in this room."),
        )
    computers_available = models.PositiveSmallIntegerField(
        default=False,
        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 reservation_possible(self, begin, end, seats=None):
        """ 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 <= begin or reservation.begin >= 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

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)
    start_time = models.DateTimeField(
        null=False,
        help_text=_("The time that this reservation starts."),
        )
    end_time = models.DateTimeField(
        null=False,
        help_text=_("The time that this reservation ends."),
        )
    seats = models.PositiveSmallIntegerField(
        null=True,
        help_text=_("Indicates how many seats are required. If this is left null, "
                    "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

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

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]:
        raise ValidationError(
            _('%(time)s is not in the quarter of an hour.'),
            params={'time': time},
        )

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],
        )
    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."),
        verbose_name=_("end time"),
        validators=[validate_event_time],
        )
    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,
        )

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,
        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.Group",
        on_delete = models.CASCADE,
        on_delete = models.CASCADE,
        null=True,
        help_text=_("Some courses have multiple groups. If that's the case, "
        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."),
        )

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."""
    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 = _("Decision of the exam commission")
        verbose_name_plural = _("Decisions of the exam commission")

        verbose_name_plural = _("Messages of the education department")


administration/roster.py ¶

106 additions and 0 deletions.

View changes Hide changes

+	1	building of the roster. """
+	2	from django.shortcuts import render
+	3	from collections import OrderedDict
+	4	import datetime
+	5	from django.urls import reverse # Why?
+	6	from django.utils.translation import gettext as _
+	7	from .models import *
+	8	import administration
+	9
+	10	def same_day(datetime_a, datetime_b):
+	11	"""True if both a and b are on the same day, false otherwise."""
+	12	return (
+	13	datetime_a.day == datetime_b.day and
+	14	datetime_a.month == datetime_b.month and
+	15	datetime_a.year == datetime_b.year)
+	16
+	17
+	18	def make_quarter_buckets(events):
+	19	"""Returns a dict with all days that the given events take place.
+	20	Every quarter between the first and last event will get a bucket in the dict,
+	21	with the keys in format "dd-mm-yyyy". Also quarters without events will be
+	22	included, but will simply have empty buckets."""
+	23	quarters = OrderedDict() # This is the first time I ever use an OrderedDict and I intend it to be my last one as well.
+	24	current_quarter = datetime.datetime.now().replace(hour=8, minute=0)
+	25	while current_quarter.hour != 20 or current_quarter.minute != 00:
+	26	quarters[current_quarter.strftime("%H:%M")] = list()
+	27	current_quarter += datetime.timedelta(minutes=15)
+	28	for event in events:
+	29	quarters[event.begin_time.strftime("%H:%M")].append(event)
+	30
+	31	return quarters # Yay! ^.^
+	32
+	33
+	34	def create_roster_rows(events):
+	35	"""Creates the rows for use in the roster table.
+	36	None of the times in the given events may overlap, and all must start and
+	37	end at a quarter of the hour (so :00, :15, :30, or :45). If you think you're above this,
+	38	I'll raise you a ValueError, kind sir.
+	39	Events must be of administration.models.Event type."""
+	40	for event in events:
+	41	for other_event in events:
+	42	if other_event is not event and (
+	43	(event.begin_time >= other_event.begin_time and event.begin_time < other_event.end_time)
+	44	or (event.end_time > other_event.begin_time and event.end_time <= other_event.end_time)
+	45	):
+	46	raise ValueError("One of the events overlaps with another event.")
+	47	if event.begin_time.minute not in [0, 15, 30, 45] or event.end_time.minute not in [0, 15, 30, 45]:
+	48	raise ValueError("One of the events did not begin or end on a quarter.")
+	49
+	50	# XXX: I assume here the given queryset is sorted:
+	51	first_day = events[0].begin_time
+	52	last_day = events.last().begin_time
+	53	# All events validated
+	54	quarter_buckets = make_quarter_buckets(events)
+	55	skip_row = dict()
+	56	table_code = list()
+	57
+	58	for quarter_bucket in quarter_buckets.keys():
+	59	# Preparing time column
+	60	quarter_line = "<tr><td style='font-size: xx-small;'>"
+	61	if quarter_bucket[3:] == "00":
+	62	quarter_line += quarter_bucket
+	63	quarter_line += "</td>"
+	64
+	65	current_day = first_day
+	66	while not same_day(current_day, last_day+datetime.timedelta(days=1)):
+	67	for event in quarter_buckets[quarter_bucket]:
+	68	if same_day(current_day, event.begin_time):
+	69	quarters = (event.end_time - event.begin_time).seconds // 60 // 15
+	70	skip_row[quarter_bucket] = quarters
+	71	event_line = "<td "
+	72	if isinstance(event, CourseEvent) and (datetime.datetime.now(datetime.timezone.utc) - event.last_update).days > 5:
+	73	event_line += "style='backgrond-color: #"+event.course.color+"; color: white;' "
+	74	elif (datetime.datetime.now(datetime.timezone.utc) - event.last_update).days <= 5:
+	75	event_line += "style='backgrond-color: yellow; color: red;' "
+	76	if event.note:
+	77	event_line +="title='" +event.note+ "' "
+	78
+	79	# FIXME: From here, I just assume the events are all CourseEvents, because
+	80	# that is the most important one to implement for the prototype.
+	81	if quarters > 1:
+	82	event_line += "rowspan='"+str(quarters)+"' "
+	83
+	84	event_line +=">"
+	85	event_line += str(
+	86	#"<a href=" + reverse("courses-course-index", args="")+"> " # FIXME so that this links to the course's index page
+	87	"<a href=""> "
+	88	+ str(event.course)
+	89	+ "<br />"
+	90	+ str(event.docent)
+	91	+ "<br />"
+	92	+ str(event.room) + " (" + str(event.subject) + ")</a></td>")
+	93	quarter_line += event_line
+	94	else:
+	95	if quarter_bucket in skip_row:
+	96	skip_row[quarter_bucket] -= 1
+	97	if skip_row[quarter_bucket] == 0:
+	98	del skip_row[quarter_bucket]
+	99	quarter_line += "<td></td>"
+	100	else:
+	101	quarter_line += "<td></td>"
+	102	current_day += datetime.timedelta(days=1)
+	103	quarter_line += "</tr>"
+	104	table_code.append(quarter_line)
+	105	return table_code
+	106

administration/templates/administration/roster.djhtml ¶

43 additions and 43 deletions.

View changes Hide changes

{% cycle "hour" "first quarter" "half" "last quarter" as hour silent %}
{# "silent" blocks the cycle operator from printing the cycler, and in subsequent calls #}
{% load i18n %}

{% block title %}
    {% trans "Roster | ◀ Joeni /▶" %}
{% endblock %}
{% endblock %}

{% block main %}
    {% include "administration/nav.djhtml" %}
    {% trans "Personal timetable" %}
    {% trans "Explanation" %}
    
        {% trans "Personal roster from" %} {{ begin|date }} {% trans "to" %} {{ end|date }}
    
    
        {% blocktrans %}
            Some fields may have additional information that might be of interest
            to you. This information is shown in different ways with colour codes.
        {% endblocktrans %}
    
    
        {% blocktrans %}
            Most fields have a single colour, determined by the course. This makes
            it easier to differentiate on a glance what hours are for what courses.
        {% endblocktrans %}
    
    
        {% blocktrans %}
            Some fields have a
            
                bright yellow background, with red text and a red dotted border.
            This indicates this event had one or more of its properties changed
            in the last five days. This can be the room, the hours, the subject, ...
            You're encouraged to take note of that.
        {% endblocktrans %}
    
    
        {% blocktrans %}
            Some fields are 
            white with a dashed black border. This indicates this event
            is new, and was added in the last five days.
        {% endblocktrans %}
    
    
        {% blocktrans %}
            Fields that flash 
            orange with the same coloured border have a note attached to
            them by the docent/speaker. Hover over the event to display the note.
        {% endblocktrans %}
    

    {% trans "Main hour roster" %}
271

Refinement of roster module in administration

administration/admin.py ¶

administration/migrations/0012_auto_20180204_1349.py ¶

administration/migrations/0013_auto_20180204_1444.py ¶

administration/models.py ¶

administration/roster.py ¶

administration/templates/administration/roster.djhtml ¶

{% trans "Personal timetable" %}

{% trans "Explanation" %}

{% trans "Main hour roster" %}

{% trans "Main hour roster" %}

administration/views.py ¶

courses/admin.py ¶

courses/migrations/0005_auto_20180204_1349.py ¶

courses/migrations/0006_auto_20180204_1349.py ¶

courses/models.py ¶

1	1	from .models import *
2	2	from django.contrib.auth.admin import UserAdmin
3	3
4	4	admin.site.register(User, UserAdmin)
5	5
6	6	admin.site.register(Curriculum)
7	7	admin.site.register(UserData)
8	8	admin.site.register(CourseResult)
9	9	admin.site.register(PreRegistration)
10	10	admin.site.register(Room)
11	11	admin.site.register(RoomReservation)
12	12	admin.site.register(Degree)
13	13
14	14	admin.site.register(CourseEvent)
+	15	admin.site.register(CourseEvent)
15	16	admin.site.register(UniversityEvent)
16	17	admin.site.register(StudyEvent)
17	18
+	19	admin.site.register(ExamCommissionDecision)
+	20	admin.site.register(EducationDepartmentMessages)
+	21
+	22