add routes and functions to update admin

better emails

.env.example

@@ -1,6 +1,6 @@
 mongoURI=mongodb://localhost:27017
 dbo=school
-secret=
+secret=<your 256 bit secret>
 PORT=8000
-SYSTEM_EMAIL=
+SYSTEM_EMAIL=<your system email>
-SYSTEM_PASSWORD=
+SYSTEM_PASSWORD=<your system password>

.gitignore

@@ -3,7 +3,14 @@
 
 # Pycache
 /test/__pycache__/*
+/test/util/__pycache__/*
+/test/scheduleGenerator/__pycache__/*
+
+# Test
+/test/test.py
 
 # Test output
-/test/schedule.json
+/test/output/*
-/test/students.json
+
+# Sample Data
+/test/sample_data/*

DOCUMENTATION.md

@@ -0,0 +1,940 @@
+# School Management API Documentation
+
+The School Management API Documentation, defining all functions and their purpose. As well as how to use the API, how to properly call functions and provide the necessary fields. 
+
+### Contents
+
+* [Getting Started](#getting-started)
+* [General Functions](#general-functions)
+* [Creating Accounts](#creating-accounts)
+    * [Creating Administrators](#creating-administrators)
+    * [Registering a Teacher](#registering-a-teacher)
+    * [Enrolling a Student](#enrolling-a-student)
+    * [Additional Info](#additional-information-after-creating-an-account)
+* [Log into Accounts](#log-into-accounts)
+	* [Logging Into Admin](#logging-into-admin)
+	* [Logging Into Teacher](#logging-into-teacher)
+	* [Logging Into Student](#logging-into-student)
+* [Get Account](#get-account)
+	* [Get Admin Account](#get-admin-account)
+	* [Get Teacher Account](#get-teacher-account)
+	* [Get Student Account](#get-student-account)
+* [Updating Account information](#updating-accounts)
+	* **Update Student...**
+	* [Name](#update-student-name)
+	* [Grade Level](#update-student-grade-level)
+	* [Homeroom](#update-student-homeroom)
+	* [Locker](#update-student-locker)
+	* [YOG](#update-student-year-of-graduation)
+	* [Password](#update-student-password)
+	* [Email](#update-student-email)
+	* [Address](#update-student-address)
+	* [Photo](#update-student-photo)
+    <br></br>
+	* **Update Teacher...**
+	* [Name](#update-teacher-name)
+	* [Homeroom](#update-teacher-homeroom)
+	* [Password](#update-teacher-password)
+	* [Email](#update-teacher-email)
+	* [Address](#update-teacher-address)
+	* [Photo](#update-teacher-photo)
+	<br></br>
+	* **Update Admin...**
+	* [Name](#update-admin-name) - **(Coming Soon)**
+	* [Password](#update-admin-password) - **(Coming Soon)**
+	* [Email](#update-admin-email) - **(Coming Soon)**
+	* [Photo](#update-admin-photo) - **(Coming Soon)**
+* [Managing Contacts](#managing-contacts) - **(Not Documented)**
+	* [Create Contact](#create-contact) - **(Not Documented)**
+	* [Update Contact Name](#update-contact-name) - **(Not Documented)**
+	* [Update Contact Address](#update-contact-address) - **(Not Documented)**
+	* [Update Contact Home Phone](#update-contact-home-phone) - **(Not Documented)**
+	* [Update Contact Work Phone](#update-contact-work-phone) - **(Not Documented)**
+	* [Update Contact Email](#update-contact-email) - **(Not Documented)**
+	* [Update Contact Priority](#update-contact-priority) - **(Not Documented)**
+	* [Delete Contact](#delete-contact) - **(Not Documented)**
+
+<br>
+
+## Getting Started 
+
+* ### Installation & Deployment
+    The API is an all in one package and is simple and easy to deploy. Eliminating any long unforgiving configurations you may face in other software.
+
+    1. Clone the repo
+        ```bash
+        $ git clone https://github.com/SowinskiBraeden/school-management-api
+        $ cd school-management-api
+        ```
+    
+    2. Rename `.env.example` to `.env`
+    
+    3. Enter desired values into `.env`
+        ```bash
+        mongoURI='your mongo URI'
+        dbo='school'
+        secret='your 256 bit secret'
+        
+        # Suggested port for Production: 80
+        # Suggested port for Development: 8000
+        PORT='desired port'
+        
+        # This is to enable the system to send emails
+        SYSTEM_EMAIL='your system email'
+        SYSTEM_PASSWORD='your system email password'
+        ```
+    
+    4. Run the system in your terminal
+        ```bash
+        $ go run main.go
+        ```
+    
+    Or...
+    
+    5. Build and compile the system into an executable
+        ```bash
+        $ go build
+        ```
+
+* ### Initializing the System
+
+    Upon running the system for the first time, you will be prompted to create an admin.
+    In order to perform many actions with the API, an Admin account is required. You will be prompted to create your default admin account seen below...
+    
+    ![init](previews/init.png)
+    
+    Upon completing the initial setup and creating your default administrator for the system, it is ready to use and this box will appear below, displaying basic system details seen below...
+    
+    ![running](previews/running.png)
+    
+<br>
+
+## General Functions
+
+* ### API Status
+    **Method:** `GET`
+    ```
+    <API_URL>/api/v1/status
+    ```
+    
+    **Returns:**
+    * Status 200: `OK`
+    * JSON: 
+        ```jsonc
+        {
+            "success": true,
+            "message": "the API is active"
+        }
+        ```
+
+<br>
+  
+## Creating Accounts
+
+There are several account that can be registered into the system. As you may guess they are Administrators, Teachers and Students.
+
+<br>
+
++ ### Creating Administrators
+    You can create Administrates- who will have permissions to perform majority of the actions in the API. It is common that there are more than one Administrator to help manage the system.
+
+    **Method:** `POST`
+    ```
+    <API_URL>/api/v1/admin/create
+    ```
+    
+    **Required:**
+    + Logged into an existing Admin account
+    + JSON:
+        ```jsonc
+        {
+            "firstname": "John",
+            "lastname": "Doe",
+            "dob": "01-01-1999",
+            "email": "john_doe@example.com"
+        }
+        ```
+    
+    **Returns:**
+    + Status 200: `OK`
+    + JSON:
+        ```jsonc
+        {
+            "success": true,
+            "message": "successfully inserted admin"
+        }
+        ```
+    
+    <br>
+    
++ ### Registering a Teacher
+    Obviously a school management system will require teachers to manage and teach students. Teachers have an important role for the system.
+
+    **Method:** `POST`
+    ```
+    <API_URL>/api/v1/teacher/register
+    ```
+    
+    **Required:**
+    + Logged into an existing Admin account
+    + JSON:
+        ```jsonc
+        {
+            "firstname": "Homer",
+            "middlename": "Jay",
+            "lastname": "Simson",
+            "dob": "12-05-1956",
+            "email": "homerdog_simpson@example.com"
+        }
+        ```
+    
+    **Returns:**
+    + Status 200: `OK`
+    + JSON:
+        ```jsonc
+        {
+            "success": true,
+            "message": "successfully inserted teacher"
+        }
+        ```
+        
++ ### Enrolling a Student
+    What is a school without students? A professional day, but not the point. Students when their application to the school has been accepted by an admin can be enrolled into the school.
+
+    **Method:** `POST`
+    ```
+    <API_URL>/api/v1/student/enroll
+    ```
+    
+    **Required:**
+    + Logged into an existing Admin account
+    + JSON:
+        ```jsonc
+        {
+            "firstname": "Bart",
+            "middlename": "JoJo",
+            "lastname": "Simpson",
+            "age": 10,
+            "gradelevel": 4,
+            "dob": "17-12-1979",
+            "province": "...",
+            "city": "Springfield",
+            "address": "742 Evergreen Terrace",
+            "postal": "..."
+        }
+        ```
+        
+    **Returns:**
+    + Status 200: `OK`
+    + JSON:
+        ```jsonc
+        {
+            "success": true,
+            "successfully inserted student"
+        }
+        ```
+        
++ ### Additional Information After creating an account
+    1. After successfully creating an account for another admin, teacher or student. A school email will be generated for them using their first and last name, each formatted differently based on the type of account.
+
+    2. All users are given a random ID used to sign into the system. Each ID is a random 6 digit number.
+    
+    3. Students are given a random PEN (Personal Education Number). A random 12 digit number.
+    
+    4. Accounts are given a default profile image. This can be updated in the future.
+    
+    **(Coming Soon)**
+    5. All new users, once have verified their email, will receive and email containing their ID.
+    
+    **(Currently No verified email required)**
+    6. All new users, once have verified their email, will receive and email containing their temporary password.
+
+<br>
+
+## Log Into Accounts
+
++ ### Logging into Admin
+	**Method:** `POST`
+	```
+	<API_URL>/api/v1/admin/login
+	```
+
+	**Required:**
+	* JSON:
+		```jsonc
+		{
+			"tid": "123456",
+			"password": "myawesomepassword123"
+		}
+		```
+		
+	**Returns:**
+	* Status 200: `OK`
+	* JSON:
+		```
+		{
+			"success": true,
+			"message": "correct password"
+		}
+		```
+
+<br>
+
++ ### Logging into Teacher
+	**Method:** `POST`
+	```
+	<API_URL>/api/v1/teacher/login
+	```
+
+	**Required:**
+	* JSON:
+		```jsonc
+		{
+			"tid": "123456",
+			"password": "myawesomepassword123"
+		}
+		```
+		
+	**Returns:**
+	* Status 200: `OK`
+	* JSON:
+		```jsonc
+		{
+			"success": true,
+			"message": "correct password"
+		}
+		```
+
+<br>
+
++ ### Logging into Student
+	**Method:** `POST`
+	```
+	<API_URL>/api/v1/student/login
+	```
+
+	**Required:**
+	* JSON:
+		```jsonc
+		{
+			"sid": "123456",
+			"password": "myawesomepassword123"
+		}
+		```
+		
+	**Returns:**
+	* Status 200: `OK`
+	* JSON:
+		```jsonc
+		{
+			"success": true,
+			"message": "correct password"
+		}
+		```
+
+<br>
+
+## Get Account
+
++ ### Get Admin Account
+	**Method:** `GET`
+	```
+	<API_URL>/api/v1/admin
+	```
+
+	**Required:**
+	* Logged into an admin account
+	
+	**Returns:**
+	* Status 200: `OK`
+	* JSON:
+		```jsonc
+		{
+			"success": true,
+			"message": "successfully logged into admin",
+			"admin:" <admin object>
+		}
+		```
+
+<br>
+
++ ### Get Teacher Account
+	**Method:** `GET`
+	```
+	<API_URL>/api/v1/teacher
+	```
+
+	**Required:**
+	* Logged into an teacher account
+	
+	**Returns:**
+	* Status 200: `OK`
+	* JSON:
+		```jsonc
+		{
+			"success": true,
+			"message": "successfully logged into teacher",
+			"teacher:" <teacher object>
+		}
+		```
+
+<br>
+
++ ### Get Student Account
+	 **Method:** `GET`
+	```
+	<API_URL>/api/v1/student
+	```
+
+	**Required:**
+	* Logged into an admin account
+	
+	**Returns:**
+	* Status 200: `OK`
+	* JSON:
+		```jsonc
+		{
+			"success": true,
+			"message": "successfully logged into teacher",
+			"student:" <student object>
+		}
+		```
+
+<br>
+
+## Updating Account Information
+
++ ### Update Student Name
+    **Method:** `POST`
+	```
+	<API_URL>/api/v1/student/updateName
+	```
+
+	**Required:**
+	* Logged into an admin account
+    * JSON:
+        ```jsonc
+        {
+            "sid": "123456",
+            "firstname": "Lisa",
+            "middlename": "Marie", // (OPTIONAL)
+            "lastname": "Simpson"
+        }
+        ```
+
+	**Returns:**
+	* Status 200: `OK`
+	* JSON:
+		```jsonc
+		{
+			"success": true,
+			"message": "successfully updated student"
+		}
+		```
+
+<br></br>
+
++ ### Update Student Grade Level
+    **Method:** `POST`
+	```
+	<API_URL>/api/v1/student/updateGradeLevel
+	```
+
+	**Required:**
+	* Logged into an admin account
+	* JSON":
+	    ```jsonc
+	    {
+	        "sid": "123456",
+	        "gradelevel": 11
+	    }
+	    ```
+	
+	**Returns:**
+	* Status 200: `OK`
+	* JSON:
+		```jsonc
+		{
+			"success": true,
+			"message": "successfully updated student"
+		}
+		```
+
+<br></br>
+
++ ### Update Student Homeroom
+    **Method:** `POST`
+	```
+	<API_URL>/api/v1/student/updateHomeroom
+	```
+
+	**Required:**
+	* Logged into an admin account
+    * JSON:
+        ```jsonc
+        {
+            "sid": "123456",
+            "homeroom": "A123"
+        }
+        ```
+
+	**Returns:**
+	* Status 200: `OK`
+	* JSON:
+		```jsonc
+		{
+			"success": true,
+			"message": "successfully updated student"
+		}
+		```
+
+<br></br>
+
++ ### Update Student Locker
+    **Method:** `POST`
+	```
+	<API_URL>/api/v1/student/updateLocker
+	```
+
+	**Required:**
+	* Logged into an admin account
+	* JSON:
+	    ```jsonc
+	    {
+	        "sid": "123456",
+	        "lockernumber": "B123"
+	    }
+	    ```
+	
+	**Returns:**
+	* Status 200: `OK`
+	* JSON:
+		```jsonc
+		{
+			"success": true,
+			"message": "successfully updated student"
+		}
+		```
+
+<br></br>
+
++ ### Update Student Year of Graduation
+    **Method:** `POST`
+	```
+	<API_URL>/api/v1/student/updateYOG
+	```
+
+	**Required:**
+	* Logged into an admin account
+	* JSON:
+	    ```jsonc
+	    {
+	        "sid": "123456",
+	        "yog": 2020
+	    }
+	    ```
+	
+	**Returns:**
+	* Status 200: `OK`
+	* JSON:
+		```jsonc
+		{
+			"success": true,
+			"message": "successfully updated student"
+		}
+		```
+
+<br></br>
+
++ ### Update Student Password
+    **Method:** `POST`
+	```
+	<API_URL>/api/v1/student/updatePassword
+	```
+
+	**Required:**
+	* Logged into students account
+	* JSON:
+		```jsonc
+		{
+			"password": "myOldPassword",
+			"newpassword1": "myNewPassword",
+			"newpassword2": "myNewPassword"
+		}
+		```
+	
+	**Returns:**
+	* Status 200: `OK`
+	* JSON:
+		```jsonc
+		{
+			"success": true,
+			"message": "successfully updated student password"
+		}
+		```
+	* Emails student an alert of password change
+
+<br></br>
+
++ ### Update Student Email
+    **Method:** `POST`
+	```
+	<API_URL>/api/v1/student/updateEmail
+	```
+
+	**Required:**
+	* Logged into an admin account
+	__or__
+	* Logged into students account
+	* JSON:
+		```jsonc
+		{
+			"sid": "123456", // (Only required if signed in as admin)
+			"email": "BartSimpsonsCoolEmail@example.com"
+		}
+		```
+	
+	**Returns:**
+	* Status 200: `OK`
+	* JSON:
+		```jsonc
+		{
+			"success": true,
+			"message": "successfully updated"
+		}
+		```
+
+<br></br>
+
++ ### Update Student Address
+    **Method:** `POST`
+	```
+	<API_URL>/api/v1/student/updateAddress
+	```
+
+	**Required:**
+	* Logged into an admin account
+	* JSON:
+	    ```jsonc
+	   {
+	       "sid": "123456",
+	       "address": "742 Evergreen Terrace",
+	       "city": "Springfield",
+	       "province": "...",
+	       "postal": "..."
+	   }
+	    ```
+	
+	**Returns:**
+	* Status 200: `OK`
+	* JSON:
+		```jsonc
+		{
+			"success": true,
+			"message": "successfully updated student"
+		}
+		```
+
+<br></br>
+
++ ### Update Student Photo
+    **Method:** `POST`
+	```
+	<API_URL>/api/v1/student/updatePhoto
+	```
+
+	**Required:**
+	* Logged into an admin account
+    * Form Submission:
+        ```
+            sid: "123456"
+            image: newStudentPhoto.png
+        ```
+
+	**Returns:**
+	* Status 200: `OK`
+	* JSON:
+		```jsonc
+		{
+			"success": true,
+			"message": "successfully updated student photo"
+		}
+		```
+
+<br></br>
+
++ ### Update Teacher Name
+    **Method:** `POST`
+	```
+	<API_URL>/api/v1/teacher/updateName
+	```
+
+	**Required:**
+	* Logged into an admin account
+    * JSON:
+        ```jsonc
+        {
+            "tid": "123456",
+            "firstname": "Marjorie",
+            "middlename": "Jacqueline", // (Optional)
+            "lastname": "Simpson"
+        }
+        ```
+
+	**Returns:**
+	* Status 200: `OK`
+	* JSON:
+		```jsonc
+		{
+			"success": true,
+			"message": "successfully updated teacher"
+		}
+		```
+
+<br></br>
+
++ ### Update Teacher Homeroom
+    **Method:** `POST`
+	```
+	<API_URL>/api/v1/teacher/updateHomeroom
+	```
+
+	**Required:**
+	* Logged into an admin account
+	* JSON:
+	    ```
+	    {
+	        "tid": "123456",
+	        "homeroom": "A123"
+	    }
+	    ```
+	
+	**Returns:**
+	* Status 200: `OK`
+	* JSON:
+		```jsonc
+		{
+			"success": true,
+			"message": "successfully updated teacher"
+		}
+		```
+
+<br></br>
+
++ ### Update Teacher Password
+    **Method:** `POST`
+	```
+	<API_URL>/api/v1/teacher/updatePassword
+	```
+
+	**Required:**
+	* Logged into teacher account
+	* JSON:
+	    ```jsonc
+	        {
+	            "password": "myOldPassword",
+	            "newpassword1": "myNewPassword",
+	            "newpassword2": "myNewPassword"
+	        }
+	    ```
+	
+	**Returns:**
+	* Status 200: `OK`
+	* JSON:
+		```jsonc
+		{
+			"success": true,
+			"message": "successfully updated teacher password"
+		}
+		```
+	* Emails teacher an alert of password change
+
+<br></br>
+
++ ### Update Teacher Email
+    **Method:** `POST`
+	```
+	<API_URL>/api/v1/teacher/updateEmail
+	```
+
+	**Required:**
+	* Logged into an admin account
+	**or**
+    * Logged into teachers account
+    * JSON:
+        ```jsonc
+        {
+            "tid": "123456", // (Only required if igned in as admin)
+            "email": "MargeSimpson@example.com"
+        }
+        ```
+	
+	**Returns:**
+	* Status 200: `OK`
+	* JSON:
+		```jsonc
+		{
+			"success": true,
+			"message": "successfully updated teacher"
+		}
+		```
+
+<br></br>
+
++ ### Update Teacher Address
+    **Method:** `POST`
+	```
+	<API_URL>/api/v1/teacher/updateAddress
+	```
+
+	**Required:**
+	* Logged into an admin account
+	* JSON:
+	    ```jsonc
+	    {
+	        "tid": "123456",
+	        "address": "742 Evergreen Terrace",
+	        "city": "Springfield",
+	        "province": "...",
+	        "postal": "..."
+	    }
+	    ```
+	
+	**Returns:**
+	* Status 200: `OK`
+	* JSON:
+		```jsonc
+		{
+			"success": true,
+			"message": "successfully updated teacher"
+		}
+		```
+
+<br></br>
+
++ ### Update Teacher Photo
+    **Method:** `POST`
+    ```
+    <API_URL>/api/v1/teacher/updatePhoto
+    ```
+
+    **Required:**
+    * Logged into an admin
+    * Form Submission:
+        ```
+            tid: "123456"
+            image: newTeacherPhoto.png
+        ```
+        
+    **Returns:**
+    * Status 200: `OK`
+    * JSON:
+        ```jsonc
+        {
+            "success": true,
+            "message": "successfully updated teacher photo"
+        }
+        ```
+
+<br></br>
+
++ ### Update Admin Name
+    **Coming Soon...**
+
+<br></br>
+
++ ### Update Admin Password
+    **Coming Soon...**
+
+<br></br>
+
++ ### Update Admin Email
+    **Coming Soon...**
+
+<br></br>
+
++ ### Update Admin Photo
+    **Coming Soon...**
+
+<br></br>
+
+## Managing Conacts
+**To be Documented...**
+
++ ### Creating Contact
+	**To be Documented...**
+
+<br></br>
+
++ ### Update Contact Name
+	**To be Documented...**
+
+<br></br>
+
++ ### Update Contact Address
+	**To be Documented...**
+
+<br></br>
+
++ ### Update Contact Home Phone
+	**To be Documented...**
+
+<br></br>
+
++ ### Update Contact Work Phone
+	**To be Documented...**
+
+<br></br>
+
++ ### Update Contact Email
+	**To be Documented...**
+
+<br></br>
+
++ ### Update Contact Priority
+	**To be Documented...**
+
+<br></br>
+
++ ### Delete Conotact
+	**To be Documented...**
+
+<br></br>
+
+## Remove Users
+**To be Documented...**
+
++ ### Remove Admin
+	**To be Documented...**
+
+<br></br>
+
++ ### Remove Teacher
+	**To be Documented...**
+
+<br></br>
+
++ ### Remove Student
+	**To be Documented...**
+
+<br></br>
+
+### Admin Commands
+Administrators play a very important role in managing a school, they do much work behind the scenes to make sure that everything is correctly organized and working.
+
++ ### Update Locker Combination
+	**To be Documented...**
+
+<br></br>
+
++ ### Enable Student Account
+    In the case a students acount has been disabled, an admin would require to enable the account.
+
+	**To be Documented...**
+<br></br>
+
++ ### Enable Teacher Account
+    In the case a teachers acount has been disabled, an admin would require to enable the account.
+
+	**To be Documented...**
+<br></br>

LICENSE

@@ -1,21 +1,674 @@
-MIT License
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
 
-Copyright (c) 2022 Braeden Sowinski
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
+                            Preamble
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all
+  The GNU General Public License is a free, copyleft license for
-copies or substantial portions of the Software.
+software and other kinds of works.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+  The licenses for most software and other practical works are designed
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+to take away your freedom to share and change the works.  By contrast,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+the GNU General Public License is intended to guarantee your freedom to
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+share and change all versions of a program--to make sure it remains free
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+software for all its users.  We, the Free Software Foundation, use the
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+GNU General Public License for most of our software; it applies also to
-SOFTWARE.
+any other work released this way by its authors.  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+    <program>  Copyright (C) <year>  <name of author>
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<https://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<https://www.gnu.org/licenses/why-not-lgpl.html>.

README.md

@@ -2,27 +2,32 @@
 
 The backend API for a school management system accessible by staff and students.
 
-<a href="https://github.com/SowinskiBraeden/school-management-api"><strong>Explore the docs »</strong></a>
+***Explore the docs »***
+* [Getting Started](#getting-started)
+* [Usage/Documenation](#usage)
+* [Contributing](#contributing)
+* [License](#license)
+* [Contact](#contact)
 <br>
 <br>
 
 ## About The Project
 
-Originally started as a personal project to improve my overall Go knowledge and skills, driven by the complains
+Originally started as a personal project to improve my overall Go knowledge and skills, driven by the complaints
 of my current school management system for students to view their grades, credits, course selections etc. I took
 this on as a full project to work on for my Software Engineering class and is now a staple of my work. I plan to
 work on this till completion, starting with this API, and then the front end, learning new tricks and languages
 along the way.
 
-## Future Plans
+I highly recommend looking at the testing for [schedule generation](/test/scheduleGenerator), [version 3](/test/scheduleGenerator/generator_v3.py)
+
+## Related Work
 
 After the majority completion of vital api functionalities such as the ability to update information, create new
-information, generate information, delete information, authentication etc. I plan on creating a new repository 
+information, generate information, delete information, authentication etc. I have created a new repository 
-for a new frontier of this project. I plan on making the [School Management Website](https://github.com/SowinskiBraeden/school-management-website).
+for the next frontier of this project. I am now concurrently working on the [School Management Website](https://github.com/SowinskiBraeden/school-management).
 
-This is most likely going to be written in another programming language or framework I am unfamiliar with. The 
+The School Management Website. is going to be written using the [Vue.js](https://vuejs.org/) framework. Vue.js is a popular framwork for working on frontend UI programs. I am currently unfamiliar with the framework but plan on learning the framework to use it more in the future.
-idea is to have a modern designed website capable of being used easily on any device or platform. I may use the
-[React.js](https://reactjs.org/) or [Vue.js](https://vuejs.org/) frameworks to build the front end design.
 <br>
 
 ### Built With
@@ -33,7 +38,7 @@ idea is to have a modern designed website capable of being used easily on any de
 
 ## Getting Started
 
-The systems is easy to start and your local machine. Eliminating and long unforgiving configurations you may face in other software.
+The systems is easy to start and your local machine. Eliminating any long unforgiving configurations you may face in other software.
 
 ### Installation
 
@@ -43,20 +48,34 @@ The systems is easy to start and your local machine. Eliminating and long unforg
     $ cd school-management-api
 ```
 
+<br>
+
 2. Rename `.env.example` to `.env`
+
+<br>
+
 3. Enter desired values into `.env`
-   ```
+```
     mongoURI='your mongo URI'
     dbo=school
-    secret='your secret'
+    secret='your 256 bit secret'
     PORT='your desired port'
     SYSTEM_EMAIL='your system email'
     SYSTEM_PASSWORD='your system email password'
-   ```
+```
-4. Run the sytem in your console
+
+<br>
+
+4. Run the system in your console
 ```
   go run main.go
 ```
+
+* The first time the API is run, you will be promted to enter in the systems defualt administrator account detials.
+ This is required, in order to use majority of the API you'll need to be in an authenticated admin account.
+
+<br>
+
 5. Build and compile the system into an executable
 ```
   go build
@@ -68,6 +87,8 @@ The systems is easy to start and your local machine. Eliminating and long unforg
 
 The usage for this API is in the name, school management, it's not an easy task in the areas I live near. Overcrowded schools are far too common and the need for a better school management system is there. The current systems issued by the government work but are poor and outdated.
 
+To see a full list of features and how to use the system, read the [documentation](DOCUMENTATION.md)
+
 
 <!-- CONTRIBUTING -->
 ## Contributing

controllers/authController.go

@@ -1,17 +1,20 @@
 package controllers
 
 import (
+	"bufio"
 	"context"
+	"fmt"
+	"log"
 	"os"
+	"strings"
 	"time"
 
 	"github.com/SowinskiBraeden/school-management-api/database"
 	"github.com/SowinskiBraeden/school-management-api/models"
+	"github.com/howeyc/gopass"
 
-	"net/smtp"
-
-	"github.com/dgrijalva/jwt-go"
 	"github.com/gofiber/fiber/v2"
+	"github.com/golang-jwt/jwt"
 	"github.com/google/uuid"
 	"go.mongodb.org/mongo-driver/bson"
 	"go.mongodb.org/mongo-driver/bson/primitive"
@@ -23,34 +26,101 @@ var studentCollection *mongo.Collection = database.OpenCollection(database.Clien
 var contactCollection *mongo.Collection = database.OpenCollection(database.Client, "contacts")
 var adminCollection *mongo.Collection = database.OpenCollection(database.Client, "admins")
 
+func confirm(s string) bool {
+	r := bufio.NewReader(os.Stdin)
+
+	fmt.Printf("%s [y/n]: ", s)
+	res, err := r.ReadString('\n')
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	return strings.ToLower(strings.TrimSpace(res))[0] == 'y'
+}
+
+func CreateDefaultAdmin() models.Admin {
+	fmt.Println()
+	reader := bufio.NewReader(os.Stdin)
+	fmt.Print("First Name: ")
+	firstname, _ := reader.ReadString('\n')
+	fmt.Print("Last Name: ")
+	lastname, _ := reader.ReadString('\n')
+	fmt.Print("Email: ")
+	email, _ := reader.ReadString('\n')
+	fmt.Print("Password: ")
+	password, _ := gopass.GetPasswd()
+
+	// Clear values of new lines and enter characters
+	firstname = strings.ReplaceAll(firstname, "\n", "")
+	lastname = strings.ReplaceAll(lastname, "\n", "")
+	email = strings.ReplaceAll(email, "\n", "")
+	firstname = strings.ReplaceAll(firstname, "\r", "")
+	lastname = strings.ReplaceAll(lastname, "\r", "")
+	email = strings.ReplaceAll(email, "\r", "")
+
+	var admin models.Admin
+	admin.FirstName = firstname
+	admin.LastName = lastname
+	admin.Email = email
+
+	admin.SchoolEmail = admin.GenerateSchoolEmail()
+
+	pass := strings.TrimSuffix(string(password), "\n")
+	admin.Password = admin.HashPassword(pass)
+	admin.TempPassword = false
+
+	var aid string
+	for {
+		aid = GenerateID(6)
+		if ValidateID(aid, 3) == true {
+			break
+		}
+	}
+	admin.AID = aid
+
+	admin.Created_at, _ = time.Parse(time.RFC3339, time.Now().Format(time.RFC3339))
+	admin.Updated_at, _ = time.Parse(time.RFC3339, time.Now().Format(time.RFC3339))
+	admin.ID = primitive.NewObjectID()
+
+	return admin
+}
+
+func NewSystem() {
+	count, err := adminCollection.CountDocuments(context.Background(), bson.D{})
+	if err != nil {
+		fmt.Println("Unable to detect new system")
+	}
+
+	if count == 0 {
+		fmt.Println("Admin account setup...")
+
+		for {
+			defaultAdmin := CreateDefaultAdmin()
+
+			if confirm("Are the above credentials correct?") {
+				_, insertErr := adminCollection.InsertOne(context.Background(), defaultAdmin)
+				if insertErr != nil {
+					log.Printf("Failed to create an admin\n")
+				}
+
+				log.Printf("Successfully created default admin")
+				log.Printf("Your default admin ID is %s", defaultAdmin.AID)
+				break
+			}
+		}
+	}
+}
+
 var SecretKey = os.Getenv("secret")
 
 var systemEmail string = os.Getenv("SYSTEM_EMAIL")
 var systemPassword string = os.Getenv("SYSTEM_PASSWORD")
 
-func AuthAdmin(c *fiber.Ctx) bool {
+func AuthenticateUser(c *fiber.Ctx, userType int) (bool, string) {
-	cookie := c.Cookies("jwt")
+	if userType < 1 || userType > 3 {
-
+		log.Fatal("Invalid userType")
-	token, err := jwt.ParseWithClaims(cookie, &jwt.StandardClaims{}, func(token *jwt.Token) (interface{}, error) {
-		return []byte(SecretKey), nil
-	})
-	if err != nil {
-		return false
 	}
 
-	claims := token.Claims.(*jwt.StandardClaims)
-
-	// Though admin is not used, it's required to prevent findErr
-	var admin models.Admin
-	findErr := adminCollection.FindOne(context.TODO(), bson.M{"aid": claims.Issuer}).Decode(&admin)
-	if findErr != nil {
-		return false
-	}
-
-	return true
-}
-
-func AuthStudent(c *fiber.Ctx) (verified bool, sid string) {
 	cookie := c.Cookies("jwt")
 
 	token, err := jwt.ParseWithClaims(cookie, &jwt.StandardClaims{}, func(token *jwt.Token) (interface{}, error) {
@@ -62,14 +132,17 @@ func AuthStudent(c *fiber.Ctx) (verified bool, sid string) {
 
 	claims := token.Claims.(*jwt.StandardClaims)
 
-	// Though student is not used, it's required to prevent findErr
+	var userID models.Id
-	var student models.Student
+	findErr := idCollection.FindOne(context.TODO(), bson.M{"cid": claims.Issuer}).Decode(&userID)
-	findErr := studentCollection.FindOne(context.TODO(), bson.M{"sid": claims.Issuer}).Decode(&student)
 	if findErr != nil {
 		return false, ""
 	}
 
-	return true, claims.Issuer
+	if userID.ParentType != userType {
+		return false, ""
+	}
+
+	return true, userID.CID
 }
 
 func Enroll(c *fiber.Ctx) error {
@@ -78,7 +151,7 @@ func Enroll(c *fiber.Ctx) error {
 
 	if err := c.BodyParser(&data); err != nil {
 		cancel()
-		return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{
+		return c.Status(fiber.StatusInternalServerError).JSON(fiber.Map{
 			"success": false,
 			"message": "Failed to parse body",
 			"error":   err,
@@ -86,7 +159,7 @@ func Enroll(c *fiber.Ctx) error {
 	}
 
 	// Ensure Authenticated admin sent request
-	if !AuthAdmin(c) {
+	if verified, _ := AuthenticateUser(c, 3); !verified {
 		cancel()
 		return c.Status(fiber.StatusUnauthorized).JSON(fiber.Map{
 			"success": false,
@@ -143,6 +216,7 @@ func Enroll(c *fiber.Ctx) error {
 
 	// Disable login block
 	student.AccountData.AccountDisabled = false
+	student.AccountData.Alerted = false
 	student.AccountData.Attempts = 0
 
 	// Generate temporary password
@@ -151,23 +225,22 @@ func Enroll(c *fiber.Ctx) error {
 	student.AccountData.TempPassword = true
 
 	// Send student personal email temp password
-	message := []byte("Your temporary password is " + tempPass)
+	subject := "Password Changed"
-	auth := smtp.PlainAuth("", systemEmail, systemPassword, "smtp.gmail.com")
+	receiver := student.PersonalData.Email
+	r := NewRequest([]string{receiver}, subject)
 
-	err := smtp.SendMail("smtp.gmail.com:587", auth, systemEmail, []string{student.PersonalData.Email}, message)
+	if sent := r.Send("./templates/passwordChanged.html", map[string]string{"username": student.PersonalData.FirstName, "password": tempPass}); !sent {
-	if err != nil {
 		cancel()
 		return c.Status(fiber.StatusInternalServerError).JSON(fiber.Map{
 			"success": false,
 			"message": "Could not send password to students email",
-			"error":   err,
 		})
 	}
 
 	var sid string
 	for {
 		sid = GenerateID(6)
-		if ValidateID(sid) == true {
+		if ValidateID(sid, 1) == true {
 			break
 		}
 	}
@@ -207,7 +280,7 @@ func Enroll(c *fiber.Ctx) error {
 	}
 	defer cancel()
 
-	return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{
+	return c.Status(fiber.StatusOK).JSON(fiber.Map{
 		"success": true,
 		"message": "successfully inserted student",
 	})
@@ -227,7 +300,7 @@ func RegisterTeacher(c *fiber.Ctx) error {
 	}
 
 	// Ensure Authenticated admin sent request
-	if !AuthAdmin(c) {
+	if verified, _ := AuthenticateUser(c, 3); !verified {
 		cancel()
 		return c.Status(fiber.StatusUnauthorized).JSON(fiber.Map{
 			"success": false,
@@ -252,7 +325,7 @@ func RegisterTeacher(c *fiber.Ctx) error {
 	teacher.PersonalData.Province = data["province"].(string)
 	teacher.PersonalData.City = data["city"].(string)
 	teacher.PersonalData.Postal = data["postal"].(string)
-	teacher.PersonalData.DOB = data["postal"].(string)
+	teacher.PersonalData.DOB = data["dob"].(string)
 
 	var photo models.Photo
 	photo.Name = uuid.New().String()
@@ -286,16 +359,15 @@ func RegisterTeacher(c *fiber.Ctx) error {
 	teacher.AccountData.TempPassword = true
 
 	// Send teacher personal email temp password
-	message := []byte("Your temporary password is " + tempPass)
+	subject := "Password Changed"
-	auth := smtp.PlainAuth("", systemEmail, systemPassword, "smtp.gmail.com")
+	receiver := teacher.PersonalData.Email
+	r := NewRequest([]string{receiver}, subject)
 
-	err := smtp.SendMail("smtp.gmail.com:587", auth, systemEmail, []string{teacher.PersonalData.Email}, message)
+	if sent := r.Send("./templates/passwordChanged.html", map[string]string{"username": teacher.PersonalData.FirstName, "password": tempPass}); !sent {
-	if err != nil {
 		cancel()
 		return c.Status(fiber.StatusInternalServerError).JSON(fiber.Map{
 			"success": false,
-			"message": "Could not send password to teacners email",
+			"message": "Could not send password to teachers email",
-			"error":   err,
 		})
 	}
 
@@ -303,7 +375,7 @@ func RegisterTeacher(c *fiber.Ctx) error {
 	// For the unlikely event that an ID is already in use this will simply try again till it gets a id not in use
 	for {
 		tid = GenerateID(6)
-		isValid := ValidateID(tid)
+		isValid := ValidateID(tid, 2)
 		if isValid == true {
 			break
 		}
@@ -345,7 +417,7 @@ func CreateAdmin(c *fiber.Ctx) error {
 	}
 
 	// Ensure Authenticated admin sent request
-	if !AuthAdmin(c) {
+	if verified, _ := AuthenticateUser(c, 3); !verified {
 		cancel()
 		return c.Status(fiber.StatusUnauthorized).JSON(fiber.Map{
 			"success": false,
@@ -374,23 +446,22 @@ func CreateAdmin(c *fiber.Ctx) error {
 	admin.TempPassword = true
 
 	// Send admin personal email temp password
-	message := []byte("Your temporary password is " + tempPass)
+	subject := "Password Changed"
-	auth := smtp.PlainAuth("", systemEmail, systemPassword, "smtp.gmail.com")
+	receiver := admin.Email
+	r := NewRequest([]string{receiver}, subject)
 
-	err := smtp.SendMail("smtp.gmail.com:587", auth, systemEmail, []string{admin.Email}, message)
+	if sent := r.Send("./templates/passwordChanged.html", map[string]string{"username": admin.FirstName, "password": tempPass}); !sent {
-	if err != nil {
 		cancel()
 		return c.Status(fiber.StatusInternalServerError).JSON(fiber.Map{
 			"success": false,
-			"message": "Could not send password to admins email",
+			"message": "Could not send password to students email",
-			"error":   err,
 		})
 	}
 
 	var aid string
 	for {
 		aid = GenerateID(6)
-		if ValidateID(aid) == true {
+		if ValidateID(aid, 3) == true {
 			break
 		}
 	}
@@ -441,32 +512,39 @@ func StudentLogin(c *fiber.Ctx) error {
 
 	var student models.Student
 	err := studentCollection.FindOne(ctx, bson.M{"schooldata.sid": data["sid"]}).Decode(&student)
-	defer cancel()
 
 	if err != nil {
 		cancel()
-		return c.Status(fiber.StatusInternalServerError).JSON(fiber.Map{
+		return c.Status(fiber.StatusOK).JSON(fiber.Map{
 			"success": false,
 			"message": "student not found",
 			"error":   err,
 		})
 	}
 
-	var localAccountDisabled = false
+	var verified bool = student.ComparePasswords(data["password"])
-	if student.AccountData.Attempts >= 5 {
+	var localAccountDisabled bool = false
+	var localAttempts int = student.AccountData.Attempts
+
+	if !verified {
+		localAttempts += 1
+	}
+
+	if student.AccountData.Attempts >= 5 || localAttempts >= 5 {
 		localAccountDisabled = true // Catches newly disbaled account before student obj is updated
 		update_time, _ := time.Parse(time.RFC3339, time.Now().Format(time.RFC3339))
 		update := bson.M{
 			"$set": bson.M{
-				"AccountData.accountdisabled": true,
+				"accountdata.accountdisabled": true,
-				"AccountData.attempts":        0,
+				"accountdata.alerted":         true,
+				"accountdata.attempts":        0,
 				"updated_at":                  update_time,
 			},
 		}
 
 		_, updateErr := studentCollection.UpdateOne(
 			ctx,
-			bson.M{"sid": data["sid"]},
+			bson.M{"schooldata.sid": data["sid"]},
 			update,
 		)
 		if updateErr != nil {
@@ -480,26 +558,42 @@ func StudentLogin(c *fiber.Ctx) error {
 	}
 
 	if localAccountDisabled || student.AccountData.AccountDisabled {
+
+		if !student.AccountData.Alerted {
+			// Send student email warning of disabled account
+			subject := "Account Disabled"
+			receiver := student.PersonalData.Email
+			r := NewRequest([]string{receiver}, subject)
+
+			if sent := r.Send("./templates/accountDisabled.html", map[string]string{"username": student.PersonalData.FirstName}); !sent {
+				cancel()
+				return c.Status(fiber.StatusInternalServerError).JSON(fiber.Map{
+					"success": false,
+					"message": "Could not send password to students email",
+					"error":   err,
+				})
+			}
+		}
 		cancel()
-		return c.Status(fiber.StatusForbidden).JSON(fiber.Map{
+
+		return c.Status(fiber.StatusOK).JSON(fiber.Map{
 			"success": false,
 			"message": "Account is Disabled, contact an Admin",
 		})
 	}
 
-	var verified bool = student.ComparePasswords(data["password"])
+	if !verified {
-	if verified == false {
 		update_time, _ := time.Parse(time.RFC3339, time.Now().Format(time.RFC3339))
 		update := bson.M{
 			"$set": bson.M{
-				"AccountData.attempts": student.AccountData.Attempts + 1,
+				"accountdata.attempts": (student.AccountData.Attempts + 1),
 				"updated_at":           update_time,
 			},
 		}
 
 		_, updateErr := studentCollection.UpdateOne(
 			ctx,
-			bson.M{"sid": data["sid"]},
+			bson.M{"schooldata.sid": data["sid"]},
 			update,
 		)
 		cancel()
@@ -510,10 +604,33 @@ func StudentLogin(c *fiber.Ctx) error {
 				"error":   updateErr,
 			})
 		}
-		return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{
+
+		return c.Status(fiber.StatusOK).JSON(fiber.Map{
 			"success": false,
 			"message": "incorrect password",
 		})
+	} else {
+		update_time, _ := time.Parse(time.RFC3339, time.Now().Format(time.RFC3339))
+		update := bson.M{
+			"$set": bson.M{
+				"accountdata.attempts": 0,
+				"updated_at":           update_time,
+			},
+		}
+
+		_, updateErr := studentCollection.UpdateOne(
+			ctx,
+			bson.M{"schooldata.sid": data["sid"]},
+			update,
+		)
+		if updateErr != nil {
+			cancel()
+			return c.Status(fiber.StatusInternalServerError).JSON(fiber.Map{
+				"success": false,
+				"message": "the student could not be updated",
+				"error":   updateErr,
+			})
+		}
 	}
 	defer cancel()
 
@@ -571,9 +688,9 @@ func TeacherLogin(c *fiber.Ctx) error {
 
 	if err != nil {
 		cancel()
-		return c.Status(fiber.StatusInternalServerError).JSON(fiber.Map{
+		return c.Status(fiber.StatusOK).JSON(fiber.Map{
 			"success": false,
-			"message": "student not found",
+			"message": "teacher not found",
 			"error":   err,
 		})
 	}
@@ -581,7 +698,7 @@ func TeacherLogin(c *fiber.Ctx) error {
 
 	var verified bool = teacher.ComparePasswords(data["password"])
 	if verified == false {
-		return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{
+		return c.Status(fiber.StatusOK).JSON(fiber.Map{
 			"success": false,
 			"message": "incorrect password",
 		})
@@ -641,7 +758,7 @@ func AdminLogin(c *fiber.Ctx) error {
 
 	if err != nil {
 		cancel()
-		return c.Status(fiber.StatusInternalServerError).JSON(fiber.Map{
+		return c.Status(fiber.StatusOK).JSON(fiber.Map{
 			"success": false,
 			"message": "admin not found",
 			"error":   err,
@@ -651,7 +768,7 @@ func AdminLogin(c *fiber.Ctx) error {
 
 	var verified bool = admin.ComparePasswords(data["password"])
 	if verified == false {
-		return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{
+		return c.Status(fiber.StatusOK).JSON(fiber.Map{
 			"success": false,
 			"message": "incorrect password",
 		})
@@ -685,7 +802,7 @@ func AdminLogin(c *fiber.Ctx) error {
 
 func Student(c *fiber.Ctx) error {
 	var sid string
-	if AuthAdmin(c) {
+	if verified, _ := AuthenticateUser(c, 3); verified {
 		var data map[string]string
 
 		if err := c.BodyParser(&data); err != nil {
@@ -722,27 +839,34 @@ func Student(c *fiber.Ctx) error {
 		sid = claims.Issuer
 	}
 
-	responceData := make(map[string]interface{})
+	responseData := make(map[string]interface{})
-	responceData["student"] = nil
+	responseData["student"] = nil
-	responceData["locker"] = nil
+	responseData["locker"] = nil
-	responceData["contacts"] = nil
+	responseData["contacts"] = nil
-	responceData["photo"] = nil
+	responseData["photo"] = nil
 
 	var student models.Student
 	findErr := studentCollection.FindOne(context.TODO(), bson.M{"schooldata.sid": sid}).Decode(&student)
 	if findErr != nil {
-		return c.Status(fiber.StatusUnauthorized).JSON(fiber.Map{
+		return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{
 			"success": false,
 			"message": "student not found",
 		})
 	}
 
-	responceData["student"] = student
+	if student.AccountData.AccountDisabled {
+		return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{
+			"success": false,
+			"message": "Student Accound Disabled, Contact and Admin",
+		})
+	}
+
+	responseData["student"] = student
 
 	var locker models.Locker
 	if student.SchoolData.Locker != "" {
 		lockerCollection.FindOne(context.TODO(), bson.M{"ID": student.SchoolData.Locker}).Decode(&locker)
-		responceData["locker"] = locker
+		responseData["locker"] = locker
 	}
 
 	var contacts []models.Contact
@@ -750,24 +874,24 @@ func Student(c *fiber.Ctx) error {
 	for i := range student.PersonalData.Contacts {
 		findErr := contactCollection.FindOne(context.TODO(), bson.M{"_id": student.PersonalData.Contacts[i]}).Decode(&contact)
 		if findErr != nil {
-			responceData["error"] = "Error! There was an error finding some contacts"
+			responseData["error"] = "Error! There was an error finding some contacts"
 		}
 		contacts = append(contacts, contact)
 	}
 	if len(contacts) > 0 {
-		responceData["contacts"] = contacts
+		responseData["contacts"] = contacts
 	}
 
 	var photo models.Photo
 	findErr = imageCollection.FindOne(context.TODO(), bson.M{"name": student.SchoolData.PhotoName}).Decode(&photo)
 	if findErr != nil {
-		responceData["error"] = "Error! There was an error finding the student photo"
+		responseData["error"] = "Error! There was an error finding the student photo"
 	}
-	responceData["photo"] = photo
+	responseData["photo"] = photo
 
 	return c.Status(fiber.StatusAccepted).JSON(fiber.Map{
 		"success":  true,
-		"responce": responceData,
+		"response": responseData,
 	})
 }
 
@@ -778,7 +902,7 @@ func Teacher(c *fiber.Ctx) error {
 		return []byte(SecretKey), nil
 	})
 	if err != nil {
-		return c.Status(fiber.StatusInternalServerError).JSON(fiber.Map{
+		return c.Status(fiber.StatusUnauthorized).JSON(fiber.Map{
 			"success": false,
 			"message": "not authorized",
 		})
@@ -789,13 +913,13 @@ func Teacher(c *fiber.Ctx) error {
 	var teacher models.Teacher
 	findErr := teacherCollection.FindOne(context.TODO(), bson.M{"schooldata.tid": claims.Issuer}).Decode(&teacher)
 	if findErr != nil {
-		return c.Status(fiber.StatusInternalServerError).JSON(fiber.Map{
+		return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{
 			"success": false,
 			"message": "teacher not found",
 		})
 	}
 
-	return c.Status(fiber.StatusAccepted).JSON(fiber.Map{
+	return c.Status(fiber.StatusOK).JSON(fiber.Map{
 		"success": true,
 		"message": "successfully logged into teacher",
 		"result":  teacher,
@@ -820,13 +944,13 @@ func Admin(c *fiber.Ctx) error {
 	var admin models.Admin
 	findErr := adminCollection.FindOne(context.TODO(), bson.M{"aid": claims.Issuer}).Decode(&admin)
 	if findErr != nil {
-		return c.Status(fiber.StatusUnauthorized).JSON(fiber.Map{
+		return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{
 			"success": false,
 			"message": "admin not found",
 		})
 	}
 
-	return c.Status(fiber.StatusAccepted).JSON(fiber.Map{
+	return c.Status(fiber.StatusOK).JSON(fiber.Map{
 		"success": true,
 		"message": "successfully logged into admin",
 		"result":  admin,
@@ -863,7 +987,7 @@ func CreateContact(c *fiber.Ctx) error {
 	}
 
 	// Ensure Authenticated admin sent request
-	if !AuthAdmin(c) {
+	if verified, _ := AuthenticateUser(c, 3); !verified {
 		cancel()
 		return c.Status(fiber.StatusUnauthorized).JSON(fiber.Map{
 			"success": false,
@@ -948,7 +1072,7 @@ func DeleteContact(c *fiber.Ctx) error {
 	}
 
 	// Ensure Authenticated admin sent request
-	if !AuthAdmin(c) {
+	if verified, _ := AuthenticateUser(c, 3); !verified {
 		cancel()
 		return c.Status(fiber.StatusUnauthorized).JSON(fiber.Map{
 			"success": false,
@@ -968,7 +1092,7 @@ func DeleteContact(c *fiber.Ctx) error {
 	_, err := contactCollection.DeleteOne(ctx, bson.M{"_id": data["id"]})
 	if err != nil {
 		cancel()
-		return c.Status(fiber.StatusUnauthorized).JSON(fiber.Map{
+		return c.Status(fiber.StatusInternalServerError).JSON(fiber.Map{
 			"success": false,
 			"message": "Failed to delete object",
 			"error":   err,
@@ -976,7 +1100,7 @@ func DeleteContact(c *fiber.Ctx) error {
 	}
 	defer cancel()
 
-	return c.Status(fiber.StatusNotImplemented).JSON(fiber.Map{
+	return c.Status(fiber.StatusOK).JSON(fiber.Map{
 		"success": true,
 		"message": "Successfully deleted contact",
 	})

controllers/emailController.go

@@ -0,0 +1,79 @@
+package controllers
+
+import (
+	"bytes"
+	"fmt"
+	"html/template"
+	"log"
+	"net/smtp"
+	"os"
+)
+
+type Config struct {
+	Server   string
+	Port     int
+	Email    string
+	Password string
+}
+
+var config Config = Config{
+	Server:   "smtp.gmail.com",
+	Port:     587,
+	Email:    os.Getenv("SYSTEM_EMAIL"),
+	Password: os.Getenv("SYSTEM_PASSWORD"),
+}
+
+type Request struct {
+	from    string
+	to      []string
+	subject string
+	body    string
+}
+
+const (
+	MIME = "MIME-version: 1.0;\nContent-Type: text/html; charset=\"UTF-8\";\n\n"
+)
+
+func NewRequest(to []string, subject string) *Request {
+	return &Request{
+		to:      to,
+		subject: subject,
+	}
+}
+
+func (r *Request) parseTemplate(fileName string, data interface{}) error {
+	t, err := template.ParseFiles(fileName)
+	if err != nil {
+		return err
+	}
+	buffer := new(bytes.Buffer)
+	if err = t.Execute(buffer, data); err != nil {
+		return err
+	}
+	r.body = buffer.String()
+	return nil
+}
+
+func (r *Request) sendMail() bool {
+	body := "To: " + r.to[0] + "\r\nSubject: " + r.subject + "\r\n" + MIME + "\r\n" + r.body
+	SMTP := fmt.Sprintf("%s:%d", config.Server, config.Port)
+	if err := smtp.SendMail(SMTP, smtp.PlainAuth("", config.Email, config.Password, config.Server), config.Email, r.to, []byte(body)); err != nil {
+		return false
+	}
+	return true
+}
+
+func (r *Request) Send(templateName string, items interface{}) bool {
+	err := r.parseTemplate(templateName, items)
+	if err != nil {
+		log.Fatal(err)
+		return false
+	}
+	if ok := r.sendMail(); ok {
+		log.Printf("Email has been sent to %s\n", r.to)
+		return true
+	} else {
+		log.Printf("Failed to send the email to %s\n", r.to)
+		return false
+	}
+}

controllers/idController.go

@@ -18,7 +18,7 @@ var idCollection *mongo.Collection = database.OpenCollection(database.Client, "c
 
 var table = [...]byte{'1', '2', '3', '4', '5', '6', '7', '8', '9', '0'}
 
-func ValidateID(id string) bool { // true: valid id, false: id already in use
+func ValidateID(id string, userType int) bool { // true: valid id, false: id already in use
 	ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
 	var foundID models.Id
 	err := idCollection.FindOne(ctx, bson.M{"cid": id}).Decode(&foundID)
@@ -26,6 +26,7 @@ func ValidateID(id string) bool { // true: valid id, false: id already in use
 	if err != nil { // If there is no id found create new ID object to be stored and return true (unless insert error then try again)
 		var newID models.Id
 		newID.CID = id
+		newID.ParentType = userType
 		newID.ID = primitive.NewObjectID()
 		_, insertErr := idCollection.InsertOne(context.Background(), newID)
 		if insertErr != nil {

go.mod

@@ -3,17 +3,17 @@ module github.com/SowinskiBraeden/school-management-api
 go 1.16
 
 require (
-	github.com/dgrijalva/jwt-go v3.2.0+incompatible
 	github.com/gofiber/fiber/v2 v2.26.0
+	github.com/golang-jwt/jwt v3.2.1+incompatible
 	github.com/google/go-cmp v0.5.6 // indirect
 	github.com/google/uuid v1.3.0
+	github.com/howeyc/gopass v0.0.0-20210920133722-c8aef6fb66ef
 	github.com/joho/godotenv v1.3.0
 	github.com/stretchr/testify v1.7.0 // indirect
+	github.com/valyala/fasthttp v1.34.0 // indirect
 	go.mongodb.org/mongo-driver v1.7.2
-	golang.org/x/crypto v0.0.0-20210921155107-089bfa567519
+	golang.org/x/crypto v0.0.0-20220214200702-86341886e292
 	golang.org/x/sync v0.0.0-20210220032951-036812b2e83c // indirect
-	golang.org/x/sys v0.0.0-20211205182925-97ca703d548d // indirect
-	golang.org/x/text v0.3.7 // indirect
 	golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 // indirect
 	gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b // indirect
 )

go.sum

@@ -1,11 +1,10 @@
 github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
-github.com/andybalholm/brotli v1.0.2 h1:JKnhI/XQ75uFBTiuzXpzFrUriDPiZjlOSzh6wXogP0E=
 github.com/andybalholm/brotli v1.0.2/go.mod h1:loMXtMfwqflxFJPmdbJO0a3KNoPuLBgiu3qAvBg8x/Y=
+github.com/andybalholm/brotli v1.0.4 h1:V7DdXeJtZscaqfNuAdSRuRFzuiKlHSC/Zh3zl9qY3JY=
+github.com/andybalholm/brotli v1.0.4/go.mod h1:fO7iG3H7G2nSZ7m0zPUDn85XEX2GTukHGRSepvi9Eig=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
-github.com/dgrijalva/jwt-go v3.2.0+incompatible h1:7qlOGliEKZXTDg6OTjfoBKDXWrumCAMpl/TFQ4/5kLM=
-github.com/dgrijalva/jwt-go v3.2.0+incompatible/go.mod h1:E3ru+11k8xSBh+hMPgOLZmtrrCbhqsmaPHjLKYnJCaQ=
 github.com/go-stack/stack v1.8.0 h1:5SgMzNM5HxrEjV0ww2lTmX6E2Izsfxas4+YHWRs3Lsk=
 github.com/go-stack/stack v1.8.0/go.mod h1:v0f6uXyyMGvRgIKkXu+yp6POWl0qKG85gN/melR3HDY=
 github.com/gobuffalo/attrs v0.0.0-20190224210810-a9411de4debd/go.mod h1:4duuawTqi2wkkpB4ePgWMaai6/Kc6WEz83bhFwpHzj0=
@@ -34,6 +33,8 @@ github.com/gobuffalo/packr/v2 v2.2.0/go.mod h1:CaAwI0GPIAv+5wKLtv8Afwl+Cm78K/I/V
 github.com/gobuffalo/syncx v0.0.0-20190224160051-33c29581e754/go.mod h1:HhnNqWY95UYwwW3uSASeV7vtgYkT2t16hJgV3AEPUpw=
 github.com/gofiber/fiber/v2 v2.26.0 h1:Awnfqp3fqbZzV3wZWMRJ6Xo2U8X0Ls68M7tXjx52NcM=
 github.com/gofiber/fiber/v2 v2.26.0/go.mod h1:7efVWcBOZi1PyMWznnbitjnARPA7nYZxmQXJVod0bo0=
+github.com/golang-jwt/jwt v3.2.1+incompatible h1:73Z+4BJcrTC+KczS6WvTPvRGOp1WmfEP4Q1lOd9Z/+c=
+github.com/golang-jwt/jwt v3.2.1+incompatible/go.mod h1:8pz2t5EyA70fFQQSrl6XZXzqecmYZeUEB8OUGHkxJ+I=
 github.com/golang/snappy v0.0.1/go.mod h1:/XxbfmMg8lxefKM7IXC3fBNl/7bRcc72aCRzEWrmP2Q=
 github.com/golang/snappy v0.0.3 h1:fHPg5GQYlCeLIPB9BZqMVR5nR9A+IM5zcgeTdjMYmLA=
 github.com/golang/snappy v0.0.3/go.mod h1:/XxbfmMg8lxefKM7IXC3fBNl/7bRcc72aCRzEWrmP2Q=
@@ -42,14 +43,17 @@ github.com/google/go-cmp v0.5.6 h1:BKbKCqvP6I+rmFHt06ZmyQtvB8xAkWdhFyr0ZUNZcxQ=
 github.com/google/go-cmp v0.5.6/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 github.com/google/uuid v1.3.0 h1:t6JiXgmwXMjEs8VusXIJk2BXHsn+wx8BZdTaoZ5fu7I=
 github.com/google/uuid v1.3.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
+github.com/howeyc/gopass v0.0.0-20210920133722-c8aef6fb66ef h1:A9HsByNhogrvm9cWb28sjiS3i7tcKCkflWFEkHfuAgM=
+github.com/howeyc/gopass v0.0.0-20210920133722-c8aef6fb66ef/go.mod h1:lADxMC39cJJqL93Duh1xhAs4I2Zs8mKS89XWXFGp9cs=
 github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8=
 github.com/joho/godotenv v1.3.0 h1:Zjp+RcGpHhGlrMbJzXTrZZPrWj+1vfm90La1wgB6Bhc=
 github.com/joho/godotenv v1.3.0/go.mod h1:7hK45KPybAkOC6peb+G5yklZfMxEjkZhHbwpqxOKXbg=
 github.com/karrick/godirwalk v1.8.0/go.mod h1:H5KPZjojv4lE+QYImBI8xVtrBRgYrIVsaRPx4tDPEn4=
 github.com/karrick/godirwalk v1.10.3/go.mod h1:RoGL9dQei4vP9ilrpETWE8CLOZ1kiN0LhBygSwrAsHA=
 github.com/klauspost/compress v1.9.5/go.mod h1:RyIbtBH6LamlWaDj8nUwkbUhJ87Yi3uG0guNDohfE1A=
-github.com/klauspost/compress v1.13.4 h1:0zhec2I8zGnjWcKyLl6i3gPqKANCCn5e9xmviEEeX6s=
 github.com/klauspost/compress v1.13.4/go.mod h1:8dP1Hq4DHOhN9w426knH3Rhby4rFm6D8eO+e+Dq5Gzg=
+github.com/klauspost/compress v1.15.0 h1:xqfchp4whNFxn5A4XFyyYtitiWI8Hy5EW59jEwcyL6U=
+github.com/klauspost/compress v1.15.0/go.mod h1:/3/Vjq9QcHkK5uEr5lBEmyoZ1iFhe47etQ6QUkpK6sk=
 github.com/konsorten/go-windows-terminal-sequences v1.0.1/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ=
 github.com/konsorten/go-windows-terminal-sequences v1.0.2/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ=
 github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=
@@ -84,8 +88,9 @@ github.com/tidwall/pretty v1.0.0 h1:HsD+QiTn7sK6flMKIvNmpqz1qrpP3Ps6jOKIKMooyg4=
 github.com/tidwall/pretty v1.0.0/go.mod h1:XNkn88O1ChpSDQmQeStsy+sBenx6DDtFZJxhVysOjyk=
 github.com/valyala/bytebufferpool v1.0.0 h1:GqA5TC/0021Y/b9FG4Oi9Mr3q7XYx6KllzawFIhcdPw=
 github.com/valyala/bytebufferpool v1.0.0/go.mod h1:6bBcMArwyJ5K/AmCkWv1jt77kVWyCJ6HpOuEn7z0Csc=
-github.com/valyala/fasthttp v1.32.0 h1:keswgWzyKyNIIjz2a7JmCYHOOIkRp6HMx9oTV6QrZWY=
 github.com/valyala/fasthttp v1.32.0/go.mod h1:2rsYD01CKFrjjsvFxx75KlEUNpWNBY9JWD3K/7o2Cus=
+github.com/valyala/fasthttp v1.34.0 h1:d3AAQJ2DRcxJYHm7OXNXtXt2as1vMDfxeIcFvhmGGm4=
+github.com/valyala/fasthttp v1.34.0/go.mod h1:epZA5N+7pY6ZaEKRmstzOuYJx9HI8DI1oaCGZpdH4h0=
 github.com/valyala/tcplisten v1.0.0 h1:rBHj/Xf+E1tRGZyWIWwJDiRY0zc1Js+CV5DqwacVSA8=
 github.com/valyala/tcplisten v1.0.0/go.mod h1:T0xQ8SeCZGxckz9qRXTfG43PvQ/mcWh7FwZEA7Ioqkc=
 github.com/xdg-go/pbkdf2 v1.0.0 h1:Su7DPu48wXMwC3bs7MCNG+z4FhcyEuz5dlvchbq0B0c=
@@ -103,12 +108,14 @@ golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACk
 golang.org/x/crypto v0.0.0-20190422162423-af44ce270edf/go.mod h1:WFFai1msRO1wXaEeE5yQxYXgSfI8pQAWXbQop6sCtWE=
 golang.org/x/crypto v0.0.0-20200302210943-78000ba7a073/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
 golang.org/x/crypto v0.0.0-20210513164829-c07d793c2f9a/go.mod h1:P+XmwS30IXTQdn5tA2iutPOUgjI07+tq3H3K9MVA1s8=
-golang.org/x/crypto v0.0.0-20210921155107-089bfa567519 h1:7I4JAnoQBe7ZtJcBaYHi5UtiO8tQHbUSXxL+pnGRANg=
+golang.org/x/crypto v0.0.0-20220214200702-86341886e292 h1:f+lwQ+GtmgoY+A2YaQxlSOnDjXcQ7ZRLWOHbC6HtRqE=
-golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
+golang.org/x/crypto v0.0.0-20220214200702-86341886e292/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4=
 golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
 golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
 golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
 golang.org/x/net v0.0.0-20210510120150-4163338589ed/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
+golang.org/x/net v0.0.0-20211112202133-69e39bad7dc2/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
+golang.org/x/net v0.0.0-20220225172249-27dd8689420f/go.mod h1:CfG3xpIq0wQ8r1q4Su4UZFWDARRcnwPjda9FqA0JpMk=
 golang.org/x/sync v0.0.0-20190227155943-e225da77a7e6/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sync v0.0.0-20190412183630-56d357773e84/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
@@ -126,9 +133,12 @@ golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7w
 golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20210514084401-e8d321eab015/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.0.0-20211205182925-97ca703d548d h1:FjkYO/PPp4Wi0EAUOVLxePm7qVW4r4ctbWpURyuOD0E=
+golang.org/x/sys v0.0.0-20211216021012-1d35b9e2eb4e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.0.0-20211205182925-97ca703d548d/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20220227234510-4e6760a101f9 h1:nhht2DYV/Sn3qOayu8lM+cU1ii9sTLUeBQwQQfUHtrs=
+golang.org/x/sys v0.0.0-20220227234510-4e6760a101f9/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
+golang.org/x/term v0.0.0-20210927222741-03fcf44c2211 h1:JGgROgKl9N8DuW20oFS5gxc+lE67/N3FcwmBPMe7ArY=
+golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
 golang.org/x/text v0.3.5/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=

main.go

@@ -1,6 +1,7 @@
 package main
 
 import (
+	"fmt"
 	"os"
 
 	"github.com/SowinskiBraeden/school-management-api/routes"
@@ -10,7 +11,10 @@ import (
 	"github.com/gofiber/fiber/v2/middleware/cors"
 )
 
+const version string = "\nv0.9.2-Alpha"
+
 func main() {
+	fmt.Println(version)
 	app := fiber.New()
 
 	app.Use(cors.New(cors.Config{

models/idModel.go

@@ -15,6 +15,7 @@ import (
 */
 
 type Id struct {
-	ID  primitive.ObjectID `bson:"_id"`
+	ID         primitive.ObjectID `bson:"_id"`
-	CID string             `bson:"cid"` // custom id for admin, teahcer or student
+	CID        string             `json:"cid"`        // custom id for admin, teahcer or student
+	ParentType int                `json:"parenttype"` // A number representing the user (1: student, 2: teacher, 3: admin)
 }

models/studentModel.go

@@ -48,6 +48,7 @@ type Student struct {
 		SchoolEmail     string   `json:"schoolemail"`
 		Password        string   `json:"-" validate:"min=10,max=32"`
 		AccountDisabled bool     `bson:"accountdisabled"`
+		Alerted         bool     `bson:"alerted"`
 		TempPassword    bool     `json:"temppassword"`
 		Attempts        int      `json:"attempts"` // login attempts max 5
 		HashHistory     []string `json:"-"`        // List of old hashed passwords (not including auto generated passwords)

routes/routes.go

@@ -7,10 +7,20 @@ import (
 )
 
 func Setup(app *fiber.App) {
-	// API Handling
+	// Detect if system is new and needs default admin
+	controllers.NewSystem()
 
+	// API Handling
 	var routerPrefix string = "/api/v1"
 
+	// API check
+	app.Get(routerPrefix+"/status", func(c *fiber.Ctx) error {
+		return c.Status(fiber.StatusOK).JSON(fiber.Map{
+			"success": true,
+			"message": "the API is active",
+		})
+	})
+
 	// Student Authentication Handler
 	app.Get(routerPrefix+"/student", controllers.Student)
 	app.Post(routerPrefix+"/student/enroll", controllers.Enroll)
@@ -62,10 +72,20 @@ func Setup(app *fiber.App) {
 	app.Post(routerPrefix+"/admin/create", controllers.CreateAdmin)
 	app.Post(routerPrefix+"/admin/login", controllers.AdminLogin)
 
+	// Admin Update Handler
+	app.Post(routerPrefix+"/admin/updateName", controllers.UpdateAdminName)
+	app.Post(routerPrefix+"/admin/updateEmail", controllers.UpdateAdminEmail)
+	app.Post(routerPrefix+"/admin/updatePassword", controllers.UpdateAdminPassword)
+
 	// General Command Handling
 	app.Post(routerPrefix+"/admin/updateLockerCombo", controllers.UpdateLockerCombo)
-	app.Post(routerPrefix+"/admin/renableStudent", controllers.RemoveStudentsDisabled)
+	app.Post(routerPrefix+"/admin/enableStudent", controllers.RemoveStudentsDisabled)
-	app.Post(routerPrefix+"/admin/renableTeacher", controllers.RemoveTeachersDisabled)
+	app.Post(routerPrefix+"/admin/enableTeacher", controllers.RemoveTeachersDisabled)
+
+	// Delete Handler
+	app.Post(routerPrefix+"/remove/student", controllers.RemoveStudent)
+	app.Post(routerPrefix+"/remove/teacher", controllers.RemoveTeacher)
+	app.Post(routerPrefix+"/remove/admin", controllers.RemoveAdmin)
 
 	// 404 Handler
 	app.Use(func(c *fiber.Ctx) error {

templates/accountDisabled.html

@@ -0,0 +1,83 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta name="viewport" content="width=device-width"/>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+    <title>Account Disabled</title>
+    <style type="text/css">
+      body{
+        margin: 0 auto;
+        padding: 0;
+        min-width: 100%;
+        font-family: sans-serif;
+      }
+      table{
+        margin: 50px 0 50px 0;
+      }
+      .header{
+        height: 40px;
+        text-align: center;
+        text-transform: uppercase;
+        font-size: 24px;
+        font-weight: bold;
+      }
+      .content{
+        height: 100px;
+        font-size: 18px;
+        line-height: 30px;
+      }
+      .subscribe{
+        height: 70px;
+        text-align: center;
+      }
+      .button{
+        text-align: center;
+        font-size: 18px;
+        font-family: sans-serif;
+        font-weight: bold;
+        padding: 0 30px 0 30px;
+      }
+      .button a{
+        color: #FFFFFF;
+        text-decoration: none;
+      }
+      .buttonwrapper{
+        margin: 0 auto;
+      }
+      .footer{
+        text-transform: uppercase;
+        text-align: center;
+        height: 40px;
+        font-size: 14px;
+        font-style: italic;
+      }
+      .footer a{
+        color: #000000;
+        text-decoration: none;
+        font-style: normal;
+      }
+    </style>
+  </head>
+  <body bgcolor="#009587">
+    <table bgcolor="#FFFFFF" width="100%" border="0" cellspacing="0" cellpadding="0">
+      <tr class="header">
+        <td style="padding: 40px;">
+          Uh Oh! Account Disabled!
+        </td>
+      </tr>
+      <tr class="content">
+        <td style="padding:10px;">
+          <p>
+            Hi <b>{{ .username }}</b>, <br/>
+            Your account has been disabled due to too many incorrect login attempts, please contact an admin to enable your account.
+          </p>
+        </td>
+      </tr>
+      <tr class="footer">
+        <td style="padding: 40px;">
+          This is an automated system email // DO NOT REPLY
+        </td>
+      </tr>
+    </table>
+  </body>
+</html>

templates/passwordChanged.html

@@ -0,0 +1,95 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta name="viewport" content="width=device-width"/>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+    <title>Password has been changed</title>
+    <style type="text/css">
+      body{
+        margin: 0 auto;
+        padding: 0;
+        min-width: 100%;
+        font-family: sans-serif;
+      }
+      table{
+        margin: 50px 0 50px 0;
+      }
+      .header{
+        height: 40px;
+        text-align: center;
+        text-transform: uppercase;
+        font-size: 24px;
+        font-weight: bold;
+      }
+      .content{
+        height: 100px;
+        font-size: 18px;
+        line-height: 30px;
+      }
+      .subscribe{
+        height: 70px;
+        text-align: center;
+      }
+      .button{
+        text-align: center;
+        font-size: 18px;
+        font-family: sans-serif;
+        font-weight: bold;
+        padding: 0 30px 0 30px;
+      }
+      .button a{
+        color: #FFFFFF;
+        text-decoration: none;
+      }
+      .buttonwrapper{
+        margin: 0 auto;
+      }
+      .footer{
+        text-transform: uppercase;
+        text-align: center;
+        height: 40px;
+        font-size: 14px;
+        font-style: italic;
+      }
+      .footer a{
+        color: #000000;
+        text-decoration: none;
+        font-style: normal;
+      }
+    </style>
+  </head>
+  <body bgcolor="#009587">
+    <table bgcolor="#FFFFFF" width="100%" border="0" cellspacing="0" cellpadding="0">
+      <tr class="header">
+        <td style="padding: 40px;">
+          Password Change!
+        </td>
+      </tr>
+      <tr class="content">
+        <td style="padding:10px;">
+          <p>
+            Hi <b>{{ .username }}</b>, <br/>
+            Your password has been changed by the system.
+          </p>
+        </td>
+      </tr>
+      <tr class="subscribe">
+        <td style="padding: 20px 0 0 0;">
+        <h3>Your new password is:</h3>
+          <table bgcolor="#009587" border="0" cellspacing="0" cellpadding="0" class="buttonwrapper">
+            <tr>
+              <td class="button" height="45">
+                {{ .password }}
+              </td>
+            </tr>
+          </table>
+        </td>
+      </tr>
+      <tr class="footer">
+        <td style="padding: 40px;">
+          This is an automated system email // DO NOT REPLY
+        </td>
+      </tr>
+    </table>
+  </body>
+</html>

templates/selfPasswordChanged.html

@@ -0,0 +1,83 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta name="viewport" content="width=device-width"/>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+    <title>Password has been changed</title>
+    <style type="text/css">
+      body{
+        margin: 0 auto;
+        padding: 0;
+        min-width: 100%;
+        font-family: sans-serif;
+      }
+      table{
+        margin: 50px 0 50px 0;
+      }
+      .header{
+        height: 40px;
+        text-align: center;
+        text-transform: uppercase;
+        font-size: 24px;
+        font-weight: bold;
+      }
+      .content{
+        height: 100px;
+        font-size: 18px;
+        line-height: 30px;
+      }
+      .subscribe{
+        height: 70px;
+        text-align: center;
+      }
+      .button{
+        text-align: center;
+        font-size: 18px;
+        font-family: sans-serif;
+        font-weight: bold;
+        padding: 0 30px 0 30px;
+      }
+      .button a{
+        color: #FFFFFF;
+        text-decoration: none;
+      }
+      .buttonwrapper{
+        margin: 0 auto;
+      }
+      .footer{
+        text-transform: uppercase;
+        text-align: center;
+        height: 40px;
+        font-size: 14px;
+        font-style: italic;
+      }
+      .footer a{
+        color: #000000;
+        text-decoration: none;
+        font-style: normal;
+      }
+    </style>
+  </head>
+  <body bgcolor="#009587">
+    <table bgcolor="#FFFFFF" width="100%" border="0" cellspacing="0" cellpadding="0">
+      <tr class="header">
+        <td style="padding: 40px;">
+          Password Change!
+        </td>
+      </tr>
+      <tr class="content">
+        <td style="padding:10px;">
+          <p>
+            Hi <b>{{ .username }}</b>, <br/>
+            Your password has been changed by you. If you did not change your password, contact an admin immediatley!
+          </p>
+        </td>
+      </tr>
+      <tr class="footer">
+        <td style="padding: 40px;">
+          This is an automated system email // DO NOT REPLY
+        </td>
+      </tr>
+    </table>
+  </body>
+</html>

test/README.md

@@ -0,0 +1,3 @@
+# Testing
+
+If you would like to view this code more neatly, it has been moved to its own [repository](https://github.com/SowinskiBraeden/schedule-generator).

test/error.py

@@ -0,0 +1,21 @@
+import json
+
+f = open('./output/students.json')
+students = json.load(f)
+f.close()
+
+couldnt_resolve = 0
+missing_classes = 0
+acceptable_missing_classes = 0
+
+for student in students:
+  blocks = [student["schedule"][block] for block in student["schedule"]]
+  conflicts = sum(1 for b in blocks if len(b)>1)
+  if conflicts == 0 and student["classes"] == student["expectedClasses"]: continue
+  if conflicts > 0: couldnt_resolve += 1
+  if (student["expectedClasses"] - 2) <= student["classes"] < student["expectedClasses"]: acceptable_missing_classes += 1
+  if student["classes"] < (student["expectedClasses"] - 2): missing_classes += 1
+
+print(f"Couldn't resolve            :  {couldnt_resolve}/{len(students)} - {round((couldnt_resolve/len(students))*100, 2)}%")
+print(f"Missing classes             :  {missing_classes}/{len(students)}  - {round((missing_classes/len(students))*100, 2)}%")
+print(f"Acceptable Missing classes  :  {acceptable_missing_classes}/{len(students)} - {round((acceptable_missing_classes/len(students))*100, 2)}%")

test/mock.py

@@ -1,32 +0,0 @@
-#!/usr/bin/python3
-import random
-import names
-from courses import courses
-
-mockStudents = []
-
-# Generate n students for mock data
-def generateMockStudents(n):
-  for _ in range(n):
-    newStudent = {
-      "name": names.get_full_name(),
-      "requests": [], # list of class codes
-      "schedule": {
-        "block1": "",
-        "block2": "",
-        "block3": "",
-        "block4": "",
-        "block5": "",
-        "block6": "",
-        "block7": "",
-        "block8": ""
-      }
-    }
-    # Get list of random class choices with no repeats
-    # 8 primary choices, 2 secondary choices
-    courseSelection = random.sample(range(0, len(courses)), 10)
-    for courseNum in courseSelection:
-      newStudent["requests"].append(list(courses)[courseNum])
-    mockStudents.append(newStudent)
-
-  return mockStudents

test/scheduleGenerator/generator_v1.py

@@ -0,0 +1,197 @@
+#!/usr/bin/env python3
+from util.courses import mockCourses, activeCourses # Fake courses
+from util.mockStudents import generateMockStudents # Generate fake students
+import json
+
+
+'''
+  Block 1-4 is first semester while
+  block 5-8 is second semester
+'''
+
+'''
+schedule example:
+schedule: {
+  "block1": "className",
+  "block2": "className",
+  "block3": "className",
+  "block4": "className" 
+  "block5": "className",
+  "block6": "className",
+  "block7": "className",
+  "block8": "className"
+}
+'''
+
+'''
+running example:
+running: {
+  "block1": {classCode:{"className":name,"students":[student Name]},classCode:{"className":name,"students":[student Name]}},
+  "block2": {classCode:{"className":name,"students":[student Name]},classCode:{"className":name,"students":[student Name]}},
+  "block3": {classCode:{"className":name,"students":[student Name]},classCode:{"className":name,"students":[student Name]}},
+  "block4": {classCode:{"className":name,"students":[student Name]},classCode:{"className":name,"students":[student Name]}},
+  "block5": {classCode:{"className":name,"students":[student Name]},classCode:{"className":name,"students":[student Name]}},
+  "block6": {classCode:{"className":name,"students":[student Name]},classCode:{"className":name,"students":[student Name]}},
+  "block7": {classCode:{"className":name,"students":[student Name]},classCode:{"className":name,"students":[student Name]}},
+  "block8": {classCode:{"className":name,"students":[student Name]},classCode:{"className":name,"students":[student Name]}}
+}
+'''
+
+# Error 1: No classes in schedule can fit this student
+# Error 2: No more room in schedule for another class
+
+minReq, median, classCap, blockClassLimit = 18, 24, 30, 12
+activeCourses = {}
+running = {
+  "block1": {},
+  "block2": {},
+  "block3": {},
+  "block4": {},
+  "block5": {},
+  "block6": {},
+  "block7": {},
+  "block8": {}
+}
+
+# Currently V1 has an average of 9.4% success rate, with an avverage of 90.6% error rate
+def generateScheduleV1(mockStudents, mockCourses):
+  # Collect data and calculate schedules
+  for student in mockStudents:
+    # Tally class request
+    for request in student["requests"]:
+      mockCourses[request]["totalrequests"] += 1
+      mockCourses[request]["studentindexes"].append(mockStudents.index(student))
+      # Add course to active list if enough requests
+      if mockCourses[request]["totalrequests"] > minReq and mockCourses[request]["code"] not in activeCourses: activeCourses[mockCourses[request]["code"]] = mockCourses[request]
+
+  for student in mockStudents:
+    alternateOffset = len(student["requests"])-8
+    alternateIndex = 8
+    for i in range(len(student["requests"])-alternateOffset): # Subtract x classes as they are alternatives
+      currentCourse = student["requests"][i]
+      generate = True
+      while generate:
+        # If class is allowed to run
+        if currentCourse in activeCourses:
+          blockIndex = 1
+          courseNum = 1
+          getFreeBlock = True
+          while getFreeBlock:
+            block = f"block{blockIndex}"
+            cname = f"{mockCourses[currentCourse]['name']}-{courseNum}"
+            if cname in running[block]:
+              if student["schedule"][block] == "": # Add student to class
+                if len(running[block][cname]["students"]) < classCap:
+                  running[block][cname]["students"].append(student["name"])
+                  student["schedule"][block] = cname
+                  getFreeBlock = False
+                else: # Find next available class or create new one
+                  if blockIndex == 8:  # No available classes
+                    if len(student["requests"]) == 8:
+                      # This student never had any alternatives
+                      # How to solve?
+
+                      # print(f"\nError 1: No more available classes for student {student['name']}")
+                      generate = False
+                    else:
+                      if alternateIndex <= (len(student["requests"]) - 1):
+                        currentCourse = student["requests"][alternateIndex]
+                        alternateIndex += 1
+                      else: # No more alterantive
+                        # print(f"\nError 1: No more available classes for student {student['name']}")
+                        generate = False
+                    getFreeBlock = False
+                  else:
+                    if (mockCourses[currentCourse]["teachers"] - courseNum) > 0:
+                      courseNum += 1
+                    else:
+                      blockIndex += 1
+                      courseNum = 1
+              else:
+                if blockIndex == 8: # No available classes
+                  if len(student["requests"]) == 8:
+                    # This student never had any alternatives
+                    # How to solve?
+
+                    # print(f"\nError 1: No more available classes for student {student['name']}")
+                    err1 += 1
+                    generate = False
+                  else:
+                    if alternateIndex <= (len(student["requests"]) - 1):
+                      currentCourse = student["requests"][alternateIndex]
+                      alternateIndex += 1
+                    else: # No more alternatives
+                      # print(f"\nError 1: No more available classes for student {student['name']}")
+                      generate = False
+                  getFreeBlock = False
+                else:
+                  blockIndex += 1
+                  courseNum = 1
+            else:
+              if blockIndex == 8:
+                # Class does not exists
+                # Create new class in first available slot 
+                blockNum = 1
+                while True:
+                  newBlock = f"block{blockNum}"
+                  if cname not in running[newBlock] and len(running[newBlock]) < blockClassLimit:
+                    if student["schedule"][newBlock] == "": # Add student to class
+                      running[newBlock][cname] = {
+                        "name": mockCourses[currentCourse]["name"],
+                        "students": [student["name"]]
+                      }
+                      student["schedule"][newBlock] = cname
+                      break
+                    else:
+                      if blockNum == 8:
+                        # All student classes have been filled
+                        break
+                      else:
+                        blockNum += 1
+                        courseNum = 1
+                  else:
+                    if blockNum == 8:
+                      # No room in school for more classes
+                      # print(f"\nError 2: No more room in school for another class")
+                      break
+                    else:
+                      if (mockCourses[currentCourse]["teachers"] - courseNum) > 0:
+                        courseNum += 1
+                      else:
+                        blockNum += 1
+                        courseNum = 1
+                break
+              else:
+                blockIndex += 1
+                courseNum = 1
+          break
+        elif currentCourse not in activeCourses:
+          if len(student["requests"]) == 8:
+            # This student never had any alternatives
+            # How to solve?
+
+            # print(f"\nError 1: No more available classes for student {student['name']}")
+            generate = False
+          else:
+            if alternateIndex <= (len(student["requests"]) - 1):
+              currentCourse = student["requests"][alternateIndex]
+              alternateIndex += 1
+            else: # Out of alternatives
+              # print(f"\nError 1: No more available classes for student {student['name']}")
+              generate = False
+
+  return running
+
+
+if __name__ == '__main__':
+  print("Processing...")
+
+  mockStudents = generateMockStudents(400)
+  timetable = {}
+  timetable["Version"] = 1
+  timetable["timetable"] = generateScheduleV1(mockStudents, mockCourses)
+
+  with open("../output/timetable.json", "w") as outfile:
+    json.dump(timetable, outfile, indent=2)
+
+  print("Done")

test/scheduleGenerator/generator_v2.py

@@ -0,0 +1,213 @@
+#!/usr/bin/env python3
+from util.courses import mockCourses, activeCourses # Fake courses
+from util.mockStudents import generateMockStudents # Generate fake students
+import math
+import json
+
+
+'''
+  Block 1-4 is first semester while
+  block 5-8 is second semester
+'''
+
+'''
+schedule example:
+schedule: {
+  "block1": "className",
+  "block2": "className",
+  "block3": "className",
+  "block4": "className" 
+  "block5": "className",
+  "block6": "className",
+  "block7": "className",
+  "block8": "className"
+}
+'''
+
+'''
+running example:
+running: {
+  "block1": {classCode:{"className":name,"students":[student Name]},classCode:{"className":name,"students":[student Name]}},
+  "block2": {classCode:{"className":name,"students":[student Name]},classCode:{"className":name,"students":[student Name]}},
+  "block3": {classCode:{"className":name,"students":[student Name]},classCode:{"className":name,"students":[student Name]}},
+  "block4": {classCode:{"className":name,"students":[student Name]},classCode:{"className":name,"students":[student Name]}},
+  "block5": {classCode:{"className":name,"students":[student Name]},classCode:{"className":name,"students":[student Name]}},
+  "block6": {classCode:{"className":name,"students":[student Name]},classCode:{"className":name,"students":[student Name]}},
+  "block7": {classCode:{"className":name,"students":[student Name]},classCode:{"className":name,"students":[student Name]}},
+  "block8": {classCode:{"className":name,"students":[student Name]},classCode:{"className":name,"students":[student Name]}}
+}
+'''
+
+
+minReq, median, classCap, blockClassLimit = 18, 24, 30, 12
+mockStudents = []
+activeCourses = {}
+running = {
+  "block1": {},
+  "block2": {},
+  "block3": {},
+  "block4": {},
+  "block5": {},
+  "block6": {},
+  "block7": {},
+  "block8": {}
+}
+
+
+# Currently V2 has an average of 0.35% success rate, with an avverage of 99.65% error rate
+def generateScheduleV2(mockStudents, mockCourses):
+  # Collect data and calculate schedules
+  for student in mockStudents:
+    # Tally class request
+    for request in student["requests"]:
+      mockCourses[request]["totalrequests"] += 1
+      mockCourses[request]["studentindexes"].append(mockStudents.index(student))
+      # Add course to active list if enough requests
+      if mockCourses[request]["totalrequests"] > minReq and mockCourses[request]["code"] not in activeCourses: activeCourses[mockCourses[request]["code"]] = mockCourses[request]
+
+  # calculate # of times to run class
+  for i in range(len(activeCourses)):
+    index = list(activeCourses)[i]
+    classRunCount = math.floor(activeCourses[index]["totalrequests"] / classCap)
+    # If there is minReq+ requests left, 1 more class could be run
+    if (activeCourses[index]["totalrequests"] % classCap) > minReq: classRunCount += 1
+    activeCourses[index]["classRunCount"] = classRunCount
+
+    newBlockIndex = 1
+    newCourseNum = 1
+    while classRunCount > 0:
+      block = f"block{newBlockIndex}"
+      cname = f"{activeCourses[index]['name']}-{newCourseNum}"
+      if cname not in running[block] and len(running[block]) < blockClassLimit:
+        # Generate class and sub 1 from classRunCount
+        running[block][cname] = {
+          "name": activeCourses[index]["name"],
+          "students": []
+        }
+        classRunCount -= 1
+      else:
+        if newBlockIndex == 8:
+          if (activeCourses[index]["teachers"] - newCourseNum) > 0:
+            newCourseNum += 1
+            newBlockIndex = 1
+          else:  
+            # No room in school for more classes
+            # print(f"\nError 2: No more room in school for another class")
+            classRunCount = 0
+        else: newBlockIndex += 1
+
+  for student in mockStudents:
+    alternateOffset = len(student["requests"])-8
+    alternateIndex = 8
+    for i in range(len(student["requests"])-alternateOffset): # Subtract x classes as they are alternatives
+      currentCourse = student["requests"][i]
+      generate = True
+      courseNum = 1
+      while generate:
+        # If class is allowed to run
+        if currentCourse in activeCourses:
+          blockIndex = 1
+          getFreeBlock = True
+          cname = f"{mockCourses[currentCourse]['name']}-{courseNum}"
+          while getFreeBlock:
+            block = f"block{blockIndex}"
+            if cname in running[block]:
+              if student["schedule"][block] == "": # Add student to class
+                if len(running[block][cname]["students"]) < classCap:
+                  running[block][cname]["students"].append(student["name"])
+                  student["schedule"][block] = cname
+                  getFreeBlock = False
+                else: # Find next available class or create new one
+                  if blockIndex == 8:  # No available classes
+                    if (activeCourses[index]["teachers"] - newCourseNum) > 0:
+                      newCourseNum += 1
+                      newBlockIndex = 1
+                    else:
+                      # No room in school for more classes
+                      # print(f"\nError 2: No more room in school for another class")
+                      classRunCount = 0
+                    if len(student["requests"]) == 8:
+                      # This student never had any alternatives
+                      # How to solve?
+
+                      # print(f"\nError 1: No more available classes for student {student['name']}")
+                      generate = False
+                    else:
+                      if alternateIndex <= (len(student["requests"]) - 1):
+                        currentCourse = student["requests"][alternateIndex]
+                        alternateIndex += 1
+                      else: # No more alterantive
+                        # print(f"\nError 1: No more available classes for student {student['name']}")
+                        generate = False
+                    getFreeBlock = False
+                  else: blockIndex += 1
+              else:
+                if blockIndex == 8: # No available classes
+                  if len(student["requests"]) == 8:
+                    # This student never had any alternatives
+                    # How to solve?
+
+                    # print(f"\nError 1: No more available classes for student {student['name']}")
+                    generate = False
+                  else:
+                    if alternateIndex <= (len(student["requests"]) - 1):
+                      currentCourse = student["requests"][alternateIndex]
+                      alternateIndex += 1
+                    else: # No more alternatives
+                      # print(f"\nError 1: No more available classes for student {student['name']}")
+                      generate = False
+                  getFreeBlock = False
+                else:
+                  if (mockCourses[currentCourse]["teachers"] - courseNum) > 0:
+                    courseNum += 1
+                  else:
+                    blockIndex += 1
+                    courseNum = 1
+            else:
+              if blockIndex == 8:
+                # Class does not exists
+                # Resort to alternative
+                if alternateIndex <= (len(student["requests"]) - 1):
+                  currentCourse = student["requests"][alternateIndex]
+                  alternateIndex += 1
+                else: # Out of alternatives
+                  # print(f"\nError 1: No more available classes for student {student['name']}")
+                  generate = False
+                break
+              else:
+                if (mockCourses[currentCourse]["teachers"] - courseNum) > 0:
+                  courseNum += 1
+                else:
+                  blockIndex += 1
+                  courseNum = 1
+          break
+        elif currentCourse not in activeCourses:
+          if len(student["requests"]) == 8:
+            # This student never had any alternatives
+            # How to solve?
+
+            # print(f"\nError 1: No more available classes for student {student['name']}")
+            generate = False
+          else:
+            if alternateIndex <= (len(student["requests"]) - 1):
+              currentCourse = student["requests"][alternateIndex]
+              alternateIndex += 1
+            else: # Out of alternatives
+              # print(f"\nError 1: No more available classes for student {student['name']}")
+              generate = False
+
+  return running
+
+
+if __name__ == '__main__':
+  print("Processing...")
+  
+  mockStudents = generateMockStudents(400)
+  timetable = {}
+  timetable["Version"] = 2
+  timetable["timetable"] = generateScheduleV2(mockStudents, mockCourses)
+  
+  with open("../output/timetable.json", "w") as outfile:
+    json.dump(timetable, outfile, indent=2)
+
+  print("Done")

test/scheduleGenerator/generator_v3.py

@@ -0,0 +1,613 @@
+#!/usr/bin/env python3
+import json
+import math
+import random
+from inspect import currentframe
+
+from click import pass_context
+
+# Import from custom utilities
+from util.mockStudents import getSampleStudents
+from util.generateCourses import getSampleCourses
+
+
+'''
+  Block 1-5 is first semester while
+  block 6-10 is second semester
+
+
+  schedule example:
+  schedule: {
+    "block1": "className",
+    "block2": "className",
+    "block3": "className",
+    ...
+  }
+
+
+  running example:
+  running: {
+    "block1": {
+      classCode: {
+        "className": name,
+        "students": [student Name]
+      },
+      classCode: {
+        "className": name,
+        "students": [student Name]
+      }
+    },
+    ...
+  }
+'''
+
+def getLineNumber(): return currentframe().f_back.f_lineno
+
+# Takes in information to create or add a new conflict
+# Returns if the particular student has a previous error
+def newConflict(pupilNum: str, email: str, type: str, code: str, description: str, logs: dict) -> bool:
+  exists = True if pupilNum in logs else False
+  if exists: logs[pupilNum].append({
+      "Pupil #": pupilNum,
+      "Email": email,
+      "Type": type,
+      "Code": code,
+      "Conflict": description
+    })
+  else:
+    logs[pupilNum] = [{
+      "Pupil #": pupilNum,
+      "Email": email,
+      "Type": type,
+      "Code": code,
+      "Conflict": description
+    }]
+  return exists
+
+minReq, median, classCap = 18, 24, 30
+activeCourses = {}
+running = {
+  "block1": {},
+  "block2": {},
+  "block3": {},
+  "block4": {},
+  "block5": {},
+  "block6": {},
+  "block7": {},
+  "block8": {},
+  "block9": {},
+  "block10": {}
+}
+
+# These are the codes for Flex (spare) blocks
+# Semester 1 and 2
+flex = ["XAT--12A-S", "XAT--12B-S"]
+
+# V3 differs a lot by V1/2 as it does not focus on fitting the classes
+# into the time table first.
+# It starts by trying to get all classes full and give all students a full class list.
+# Then it starts to attempt to fit all classes into a timetable, making corretions along
+# the way. Corrections being moving a students class
+def generateScheduleV3(
+  students: list, 
+  courses: dict, 
+  blockClassLimit: int=40,
+  studentsDir: str="../output/students.json",
+  conflictsDir: str="../output/conflicts.json"
+  ) -> dict[str, dict]:
+  
+  def equal(l: list) -> list: # Used to equalize list of numbers
+    q,r = divmod(sum(l),len(l))
+    return [q+1]*r + [q]*(len(l)-r)
+
+
+  # Step 1 - Calculate which classes can run
+  for student in students:
+    # Tally class request
+    for request in (request for request in student["requests"] if not request["alt"] and request["CrsNo"] not in flex):
+      code = request["CrsNo"]
+      courses[code]["Requests"] += 1
+      # Add course to active list if enough requests
+      if courses[code]["Requests"] > minReq and courses[code]["CrsNo"] not in activeCourses:
+        activeCourses[code] = courses[code]
+
+
+  # Step 2 - Generate empty classes
+  allClassRunCounts = []
+  courseRunInfo = {} # Generated now, used in step 4
+  emptyClasses = {} # List of all classes with how many students should be entered during step 3
+  # calculate # of times to run class
+  for i in range(len(activeCourses)):
+    index = list(activeCourses)[i]
+    if index not in emptyClasses: emptyClasses[index] = {}
+    classRunCount = math.floor(activeCourses[index]["Requests"] / median)
+    remaining = activeCourses[index]["Requests"] % median
+
+    # Put # of classRunCount classes in emptyClasses
+    for j in range(classRunCount):
+      emptyClasses[index][f"{index}-{j}"] = {
+        "CrsNo": index,
+        "Description": activeCourses[index]["Description"],
+        "expectedLen": median # Number of students expected in this class / may be altered
+      }
+
+    # If remaining fit in open slots in existing classes
+    if remaining <= classRunCount * (classCap - median):
+      # Equally disperse remaining into existing classes
+      while remaining > 0:
+        for j in range(classRunCount):
+          if remaining == 0: break
+          emptyClasses[index][f"{index}-{j}"]["expectedLen"] += 1
+          remaining -= 1
+
+    # If we can create a class using remaining, but no other classes
+    # exists, create class, and do not equalize
+    elif remaining >= minReq:
+      # Create a class using remaining
+      emptyClasses[index][f"{index}-{classRunCount}"] = {
+        "CrsNo": index,
+        "Description": activeCourses[index]["Description"],
+        "expectedLen": remaining
+      }
+
+      classRunCount += 1
+      if classRunCount >= 2:
+        # Equalize (level) class expectedLen's
+        expectedLengths = [emptyClasses[index][f"{index}-{j}"]["expectedLen"] for j in range(classRunCount)]
+        newExpectedLens = equal(expectedLengths)
+        for j in range(len(newExpectedLens)):
+          emptyClasses[index][f"{index}-{j}"]["expectedLen"] = newExpectedLens[j]
+
+    # Else if we can't fit remaining in open slots in existing classes
+    # and it is unable to create its own class,
+    # and requiered number to make a class is less than the max number we can provide from existing classes
+    elif minReq - remaining < classRunCount * (median - minReq):
+      # Take 1 from each class till min requirment met
+      for j in range(classRunCount):
+        emptyClasses[index][f"{index}-{j}"]["expectedLen"] -= 1
+        remaining += 1
+        if remaining == minReq: break
+
+      # Create a class using remaining
+      emptyClasses[index][f"{index}-{classRunCount}"] = {
+        "CrsNo": index,
+        "Description": activeCourses[index]["Description"],
+        "expectedLen": remaining
+      }
+      
+      classRunCount += 1
+
+      # Equalize (level) class expectedLen's
+      expectedLengths = [emptyClasses[index][f"{index}-{j}"]["expectedLen"] for j in range(classRunCount)]
+      newExpectedLens = equal(expectedLengths)
+      for j in range(len(newExpectedLens)):
+        emptyClasses[index][f"{index}-{j}"]["expectedLen"] = newExpectedLens[j]
+
+    else:
+      # In the case that the remaining requests are unable to be resolved
+      # Fill as many requests into class as possible, any left that can't fit,
+      # Will need to be ignored so later we can fold them into their alternative
+      # choices
+      for j in range(classRunCount):
+        if emptyClasses[index][f"{index}-{j}"]["expectedLen"] < classCap and remaining > 0: 
+          emptyClasses[index][f"{index}-{j}"]["expectedLen"] += 1
+          remaining -= 1
+
+    courseRunInfo[index] = {
+      "Total": classRunCount,
+      "CrsNo": index
+    }
+    allClassRunCounts.append(classRunCount)
+
+
+  # Step 3 Fill emptyClasses with Students
+  selectedCourses = {}
+  tempStudents = list(students)
+  
+  while len(tempStudents) > 0:
+    student = tempStudents[random.randint(0, len(tempStudents)-1)]
+
+    alternates = [request for request in student["requests"] if request["alt"]]
+    for request in (request for request in student["requests"] if not request["alt"] and request["CrsNo"] not in flex):
+      course = request["CrsNo"]
+      getAvailableCourse = True
+      isAlt = False
+      while getAvailableCourse:
+        if course in emptyClasses:
+          # if course exists, get first available class
+          for cname in emptyClasses[course]:
+            if cname in selectedCourses:
+              if isAlt and emptyClasses[course][cname]["expectedLen"] < classCap:
+                emptyClasses[course][cname]["expectedLen"] += 1
+              if len(selectedCourses[cname]["students"]) < emptyClasses[course][cname]["expectedLen"]:
+                # Class exists with room for student
+                selectedCourses[cname]["students"].append({
+                  "Pupil #": student["Pupil #"],
+                  "index": student["studentIndex"]
+                })
+                getAvailableCourse = False
+                break
+              elif len(selectedCourses[cname]["students"]) == emptyClasses[course][cname]["expectedLen"]:
+                # If class is full, and is last class of that course
+                if cname[len(cname)-1] == f"{len(emptyClasses[course])-1}":
+                  if len(alternates) > 0:
+                    # Use alternate
+                    course = alternates[0]["CrsNo"]
+                    alternates.remove(alternates[0])
+                    isAlt = True
+                    break
+                  else:
+                    # Force break loop, ignore and let an admin
+                    # handle options to solve for missing class
+                    getAvailableCourse = False
+                    break
+            elif cname not in selectedCourses:
+              selectedCourses[cname] = {
+                "students": [{
+                  "Pupil #": student["Pupil #"],
+                  "index": student["studentIndex"]
+                }],
+                "CrsNo": course,
+                "Description": courses[course]["Description"]
+              }
+              getAvailableCourse = False
+              break
+
+        elif course not in emptyClasses:
+          if len(alternates) > 0:
+            # Use alternate
+            course = alternates[0]["CrsNo"]
+            alternates.remove(alternates[0])
+            isAlt = True
+          else:
+            # Force break loop, ignore and let an admin
+            # handle options to solve for missing class
+            getAvailableCourse = False
+
+    students[student["studentIndex"]]["remainingAlts"] = alternates
+    tempStudents.remove(student)
+
+
+  # Step 4 - Attempt to fit classes into timetable
+  def stepIndex(offset: int, stepType: int) -> int:
+    # stepType 0 is for stepping between first and second semester
+    if stepType == 0:
+      if offset == 0 or offset == -4: return 5
+      else: return -4
+    
+    # stepType 1 is for stepping between second and first semester
+    elif stepType == 1:
+      if offset == 0 or offset == 6: return -5
+      else: return 6
+
+    # Return Error if code is altered to cause error
+    else: raise SystemExit(f"Invalid 'stepType' in func 'stepIndex' line {getLineNumber()}")
+
+  while len(allClassRunCounts) > 0:
+    # Get highest resource class (most times run)
+    index = allClassRunCounts.index(min(allClassRunCounts))
+    course = list(courseRunInfo)[index]
+
+    # Tally first and second semester
+    sem1, sem2 = 0, 0
+    sem1List, sem2List = {}, {}
+    for i in range(1, 6):
+      sem1 += len(running[f"block{i}"])
+      sem1List[f"block{i}"] = running[f"block{i}"]
+    for i in range(5, 11):
+      sem2 += len(running[f"block{i}"])
+      sem2List[f"block{i}"] = running[f"block{i}"]
+
+    # If there is more than one class Running
+    if allClassRunCounts[index] > 1:
+      blockIndex = 0 if sem1 <= sem2 else 5
+      stepType = 0 if sem1 <= sem2 else 1
+      offset = 0
+
+      # Spread classes throughout both semesters
+      for i in range(courseRunInfo[course]["Total"]):
+        cname = f"{course}-{i}"
+        classInserted = False
+        while not classInserted:
+
+          blockIndex += offset
+          if len(running[list(running)[blockIndex]]) < blockClassLimit:
+            running[list(running)[blockIndex]][cname] = {
+              "CrsNo": course,
+              "Description": emptyClasses[course][cname]["Description"],
+              "students": selectedCourses[cname]["students"]
+            }
+            allClassRunCounts[index] -= 1
+            classInserted = True
+
+          offset = stepIndex(offset, stepType)
+
+          if blockIndex >= 9:
+            blockIndex = 0 if sem1 <= sem2 else 5
+            offset = 0
+
+    # If the class only runs once, place in semester with least classes
+    elif allClassRunCounts[index] == 1:
+      # Equally disperse into semesters classes
+      semBlocks = []
+      offset = 1
+
+      # If sem1 is less than or equal to sem2, add to sem1
+      if sem1 <= sem2:
+        for block in sem1List:
+          semBlocks.append(len(block))
+
+      # If sem2 is less than sem1, add to sem2
+      elif sem1 > sem2:
+        offset = 5
+        for block in sem2List:
+          semBlocks.append(len(block))
+
+      # Get block with least classes
+      leastBlock = semBlocks.index(min(semBlocks))
+      cname = f"{course}-0"
+
+      running[f"block{leastBlock+offset}"][course] = {
+        "CrsNo": course,
+        "Description": emptyClasses[course][cname]["Description"],
+        "students": selectedCourses[cname]["students"],
+      }
+
+      allClassRunCounts[index] -= 1
+
+    # Remove course when fully inserted
+    if allClassRunCounts[index] == 0:
+      allClassRunCounts.remove(allClassRunCounts[index])
+      courseRunInfo.pop(list(courseRunInfo)[index])
+
+
+  # Step 5 - Fill student schedule
+  for block in running:
+    for cname in running[block]:
+      for student in running[block][cname]["students"]:
+        students[student["index"]]["schedule"][block].append(cname)
+        students[student["index"]]["classes"] += 1
+
+
+  # Step 6 - Evaluate, move students to fix conflicts
+  conflictLogs = {}
+  criticalCount, acceptableCount = 0, 0
+  c_mc_count, c_cr_count, a_mc_count = 0, 0, 0
+  studentsCritical, studentsAcceptable = 0, 0
+
+  for student in students:
+    initialBlocks = [student["schedule"][block] for block in student["schedule"]]
+    conflicts = sum(1 for b in initialBlocks if len(b)>1)
+    hasConflicts = True if conflicts > 0 else False
+
+    # If there is no conflicts
+    # and classes inserted to is equal to expectedClasses
+    # or classes the student is inserted to is missing
+    # no more than two classes:
+    # continue to next student
+    if not hasConflicts and student["classes"] == student["expectedClasses"]: continue
+    elif not hasConflicts and (student["expectedClasses"]-2) <= student["classes"] < student["expectedClasses"]:
+      a_mc_count += 1
+      acceptableCount += 1
+      if not newConflict(student["Pupil #"], "", "Acceptable", "A-MC", "Missing 1-2 Classses", conflictLogs): studentsAcceptable += 1
+      continue
+    
+    studentData = {
+      "Pupil #": student["Pupil #"],
+      "index": student["studentIndex"]
+    }
+
+    # If we are unable to solve, we add to exceptions 
+    # and keep trying to resolve the rest of the schedule
+    exceptions = [] 
+
+    while hasConflicts:
+      # Check if conflicts have been resolved
+      blocks = [student["schedule"][block] for block in student["schedule"]]
+      # If there is exceptions, make them look normal in blocks
+      # list to ginore them when looking for clashes, and not to
+      # accidently overwrite while evaluating other classes
+      if len(exceptions) > 0:
+        for i in range(len(blocks)):
+          if i in exceptions: blocks[i] = ['EXPT']
+      conflicts = sum(1 for b in blocks if len(b)>1)
+
+      if conflicts == 0: hasConflicts = False
+      
+      elif conflicts > 0:
+
+        blockLens = [len(block) for block in blocks]
+        freeBlocks = [index for index in range(len(blocks)) if len(blocks[index]) == 0]
+
+        clashIndex = blockLens.index(max(blockLens))
+        blockOut = f"block{clashIndex+1}"
+        classIndex = 0
+        done, advancedConflict = False, False
+
+        while not done:
+          classOut = blocks[clashIndex][classIndex]
+          found = False
+          for index in freeBlocks:
+            if found: break
+            if index != clashIndex:
+              blockIn = list(running)[index]
+              for cname in running[blockIn]:
+                if cname[:-2] == classOut[:-2] and len(running[blockIn][cname]["students"]) < classCap:
+
+                  # Update records
+                  student["schedule"][blockOut].remove(classOut)
+                  student["schedule"][blockIn].append(cname)
+
+                  running[blockOut][classOut]["students"].remove(studentData)
+                  running[blockIn][cname]["students"].append(studentData)
+
+                  found = True
+                  break
+
+          if not found:
+            if classIndex < len(blocks[clashIndex])-1: classIndex += 1
+            elif classIndex == len(blocks[clashIndex])-1:
+              classIndex = 0
+              advancedConflict = True
+              done = True
+            else:
+              print(f"Fatal error ({getLineNumber()}): Impossible error")
+              continue
+          
+          elif found: done = True
+
+        if advancedConflict:
+          attemptResolve = True
+          classOutIndex = 0
+          while attemptResolve:
+            foundSolution = False
+            newClassOut = blocks[clashIndex][classOutIndex]
+            for blockIndex in range(len(running)):
+              if foundSolution: break
+              if blockIndex != clashIndex and blockIndex not in exceptions:
+                for cname in running[list(running)[blockIndex]]:
+                  if cname[:-2] == newClassOut[:-2]:
+                    blockIn = f"block{blockIndex+1}"
+                    if blockIndex in freeBlocks:
+                      if len(running[blockIn][cname]["students"]) < classCap:
+                        # In the rare or impossible case a student was not inserted to a class
+                        # And it weren't full, insert them into the class
+                        student["schedule"][blockOut].remove(newClassOut)
+                        student["schedule"][blockIn].append(cname)
+
+                        running[blockOut][newClassOut]["students"].remove(studentData)
+                        running[blockIn][cname]["students"].append(studentData)
+                        foundSolution = True
+                        break
+
+                    elif len(blocks[blockIndex]) == 1:
+                      oClassOut = blocks[blockIndex][0]
+                      found_oBlockSolution = False
+                      for oBlockIndex in range(len(running)):
+                        if found_oBlockSolution: break
+                        if oBlockIndex != clashIndex and oBlockIndex not in exceptions and oBlockIndex in freeBlocks:
+                          for ocname in running[list(running)[oBlockIndex]]:
+                            if ocname[:-2] == oClassOut[:-2]:
+                              oBlockIn = f"block{oBlockIndex+1}"
+                              if len(running[oBlockIn][ocname]["students"]) < classCap:
+                                student["schedule"][blockOut].remove(newClassOut)
+                                student["schedule"][blockIn].append(cname)
+                                student["schedule"][blockIn].remove(oClassOut)
+                                student["schedule"][oBlockIn].append(ocname)
+
+                                running[blockOut][newClassOut]["students"].remove(studentData)
+                                running[blockIn][cname]["students"].append(studentData)
+                                running[blockIn][oClassOut]["students"].remove(studentData)
+                                running[oBlockIn][ocname]["students"].append(studentData)
+
+                                found_oBlockSolution = True
+                                break
+
+                        
+                      if not found_oBlockSolution:
+                        exceptions.append(clashIndex)
+                        criticalCount += 1
+                        c_cr_count += 1
+                        if not newConflict(student["Pupil #"], "", "Critial", "C-CR", "Couldn't Resolve", conflictLogs): studentsCritical += 1 
+
+                      foundSolution = True
+                      break
+
+            if not foundSolution:
+              if classOutIndex < len(blocks[clashIndex]) - 1: classOutIndex += 1
+              elif classOutIndex == len(blocks[clashIndex]) - 1:
+                if len(student["remainingAlts"]) > 0:
+                  exceptions.append(clashIndex)
+                  criticalCount += 1
+                  c_cr_count += 1
+                  if not newConflict(student["Pupil #"], "", "Critical", "C-CR", "Couldn't Resolve", conflictLogs): studentsCritical += 1
+                  
+                  attemptResolve = False
+                  # Attempt to use alt
+                elif len(student["remainingAlts"]) == 0:
+                  exceptions.append(clashIndex)
+                  criticalCount += 1
+                  c_cr_count += 1
+                  if not newConflict(student["Pupil #"], "", "Critical", "C-CR", "Couldn't Resolve", conflictLogs): studentsCritical += 1
+                  
+                  attemptResolve = False
+              else: print("Impossible - Thanos")
+            elif foundSolution:
+              attemptResolve = False
+      
+      else:
+        print(f"Fatal error ({getLineNumber()}): Impossible error")
+        continue
+
+    metSelfRequirements = True if student["classes"] == student["expectedClasses"] else False
+    while not metSelfRequirements:
+      
+      if (student["expectedClasses"] - 2) <= student["classes"] < student["expectedClasses"]:
+        a_mc_count += 1
+        acceptableCount += 1
+        if not newConflict(student["Pupil #"], "", "Acceptable", "A-MC", "Missing 1-2 Classses", conflictLogs): studentsAcceptable += 1
+        break
+
+      elif student["classes"] < (student["expectedClasses"] - 2):
+        # Difference between classes inserted to and
+        # expected classes is too great, attempt to fix
+        if student["Pupil #"] in conflictLogs:
+          c_mc_count += 1
+          criticalCount += 1
+          if not newConflict(student["Pupil #"], "", "Critical", "C-MC", "Missing too many Classses", conflictLogs): studentsCritical += 1
+
+        break
+
+      else:
+        print(f"Fatal error ({getLineNumber()}): Impossible error")
+        continue
+
+  finalConflictLogs = {
+    "Conflicts": conflictLogs,
+    "Critical": {
+      "Total": criticalCount,
+      "Students": studentsCritical,
+      "Errors": [{
+        "Total": c_mc_count,
+        "Description": "Missing too many Classes",
+        "Code": "C-MC"
+      }, {
+        "Total": c_cr_count,
+        "Description": "Couldn't Resolve",
+        "Code": "C-CR"
+      }]
+    },
+    "Acceptable": {
+      "Total": acceptableCount,
+      "Students": studentsAcceptable,
+      "Errors": [{
+        "Total": a_mc_count,
+        "Description": "Missing 1-2 Classes",
+        "Code": "A-MC"
+      }]
+    }
+  }
+
+  # Update Student records
+  with open(studentsDir, "w") as outfile:
+      json.dump(students, outfile, indent=2)
+
+  # Log Conflict to records
+  with open(conflictsDir, "w") as outfile:
+    json.dump(finalConflictLogs, outfile, indent=2)
+
+  return running
+
+if __name__ == '__main__':
+  print("Processing...")
+
+  sampleStudents = getSampleStudents(True)
+  samplemockCourses = getSampleCourses(True) 
+  timetable = {}
+  timetable["Version"] = 3
+  timetable["timetable"] = generateScheduleV3(sampleStudents, samplemockCourses)
+
+  with open("../output/timetable.json", "w") as outfile:
+    json.dump(timetable, outfile, indent=2)
+
+  print("Done")

test/test.js

@@ -1,21 +0,0 @@
-let schedule = require('./schedule.json');
-let students = require('./students.json');
-
-// console.table(schedule)
-
-// Display first semester 
-// console.table(schedule.block1)
-// console.table(schedule.block2)
-// console.table(schedule.block3)
-// console.table(schedule.block4)
-
-// // Display second semester 
-// console.table(schedule.block5)
-// console.table(schedule.block6)
-// console.table(schedule.block7)
-// console.table(schedule.block8)
-
-// Display each students schedule
-for (let i = 0; i < students.length; i++) {
-  console.table(students[i].schedule)
-}

test/tinker.py

@@ -1,390 +1,98 @@
 #!/usr/bin/python3
-import sys
+from prettytable import PrettyTable
+from typing import Tuple
 import json
-import math
+import sys
-from courses import courses, activeCourses
-from mock import generateMockStudents
 
-'''
+# Import required utilities
-  I will be using python to test and
+from util.mockStudents import generateMockStudents, getSampleStudents
-  develop course selection / schedule
+from util.generateCourses import getSampleCourses
-  generation
+from util.courses import mockCourses
 
-  this is honestly terrible code but 
+# Import Algorithms
-  this is not an easy task for me to
+from scheduleGenerator.generator_v1 import generateScheduleV1
-  do
+from scheduleGenerator.generator_v2 import generateScheduleV2
+from scheduleGenerator.generator_v3 import generateScheduleV3
 
-  Block 1-4 is first semester while
+def errorOutput(students) -> Tuple[PrettyTable, dict, dict]:
-  block 5-8 is second semester
+  # Error Table calulation / output  
-'''
+  f = open('./output/conflicts.json')
+  conflicts = json.load(f)
+  f.close()
+  totalCritical = conflicts["Critical"]["Students"]
+  totalAcceptable = conflicts["Acceptable"]["Students"]
 
-'''
+  t = PrettyTable(['Type', 'Error %', 'Success %', 'Student Error Ratio'])
-schedule example:
-schedule: {
-  "block1": "className",
-  "block2": "className",
-  "block3": "className",
-  "block4": "className" 
-  "block5": "className",
-  "block6": "className",
-  "block7": "className",
-  "block8": "className"
-}
-'''
   
-'''
+  errorsC = round(totalCritical / len(students) * 100, 2)
-running example:
+  successC = round(100 - errorsC, 2)
-running: {
+  errorsA = round(totalAcceptable / len(students) * 100, 2)
-  "block1": {classCode:{"className":name,"students":[student Name]},classCode:{"className":name,"students":[student Name]}},
+  successA = round(100 - errorsA, 2)
-  "block2": {classCode:{"className":name,"students":[student Name]},classCode:{"className":name,"students":[student Name]}},
-  "block3": {classCode:{"className":name,"students":[student Name]},classCode:{"className":name,"students":[student Name]}},
-  "block4": {classCode:{"className":name,"students":[student Name]},classCode:{"className":name,"students":[student Name]}},
-  "block5": {classCode:{"className":name,"students":[student Name]},classCode:{"className":name,"students":[student Name]}},
-  "block6": {classCode:{"className":name,"students":[student Name]},classCode:{"className":name,"students":[student Name]}},
-  "block7": {classCode:{"className":name,"students":[student Name]},classCode:{"className":name,"students":[student Name]}},
-  "block8": {classCode:{"className":name,"students":[student Name]},classCode:{"className":name,"students":[student Name]}}
-}
-'''
-
-# Error 1: No classes in schedule can fit this student
-# Error 2: No more room in schedule for another class
-
-# 400 by default
-studentsNum = 500
-
-err1, err2, = 0,0
-minReq, classCap, blockClassLimit = 18, 30, 18
-mockStudents = []
-running = {
-  "block1": {},
-  "block2": {},
-  "block3": {},
-  "block4": {},
-  "block5": {},
-  "block6": {},
-  "block7": {},
-  "block8": {}
-}
-
-
-def generateScheduleV1():
-  global err1, err2
-  # Collect data and calculate schedules
-  for student in mockStudents:
-    # Tally class request
-    for request in student["requests"]:
-      courses[request]["totalrequests"] += 1
-      courses[request]["studentindexes"].append(mockStudents.index(student))
-      # Add course to active list if enough requests
-      if courses[request]["totalrequests"] > minReq and courses[request]["code"] not in activeCourses: activeCourses[courses[request]["code"]] = courses[request]
-
-  for student in mockStudents:
-    alternateOffset = len(student["requests"])-8
-    alternateIndex = 8
-    for i in range(len(student["requests"])-alternateOffset): # Subtract x classes as they are alternatives
-      currentCourse = student["requests"][i]
-      generate = True
-      while generate:
-        # If class is allowed to run
-        if currentCourse in activeCourses:
-          blockIndex = 1
-          courseNum = 1
-          getFreeBlock = True
-          while getFreeBlock:
-            block = f"block{blockIndex}"
-            cname = f"{courses[currentCourse]['name']}-{courseNum}"
-            if cname in running[block]:
-              if student["schedule"][block] == "": # Add student to class
-                if len(running[block][cname]["students"]) < classCap:
-                  running[block][cname]["students"].append(student["name"])
-                  student["schedule"][block] = cname
-                  getFreeBlock = False
-                else: # Find next available class or create new one
-                  if blockIndex == 8:  # No available classes
-                    if len(student["requests"]) == 8:
-                      # This student never had any alternatives
-                      # How to solve?
-
-                      # print(f"\nError 1: No more available classes for student {student['name']}")
-                      generate = False
-                    else:
-                      if alternateIndex <= (len(student["requests"]) - 1):
-                        currentCourse = student["requests"][alternateIndex]
-                        alternateIndex += 1
-                      else: # No more alterantive
-                        # print(f"\nError 1: No more available classes for student {student['name']}")
-                        err1 += 1
-                        generate = False
-                    getFreeBlock = False
-                  else:
-                    if (courses[currentCourse]["teachers"] - courseNum) > 0:
-                      courseNum += 1
-                    else:
-                      blockIndex += 1
-                      courseNum = 1
-              else:
-                if blockIndex == 8: # No available classes
-                  if len(student["requests"]) == 8:
-                    # This student never had any alternatives
-                    # How to solve?
-
-                    # print(f"\nError 1: No more available classes for student {student['name']}")
-                    err1 += 1
-                    generate = False
-                  else:
-                    if alternateIndex <= (len(student["requests"]) - 1):
-                      currentCourse = student["requests"][alternateIndex]
-                      alternateIndex += 1
-                    else: # No more alternatives
-                      # print(f"\nError 1: No more available classes for student {student['name']}")
-                      err1 += 1
-                      generate = False
-                  getFreeBlock = False
-                else:
-                  blockIndex += 1
-                  courseNum = 1
-            else:
-              if blockIndex == 8:
-                # Class does not exists
-                # Create new class in first available slot 
-                blockNum = 1
-                while True:
-                  newBlock = f"block{blockNum}"
-                  if cname not in running[newBlock] and len(running[newBlock]) < blockClassLimit:
-                    if student["schedule"][newBlock] == "": # Add student to class
-                      running[newBlock][cname] = {
-                        "name": courses[currentCourse]["name"],
-                        "students": [student["name"]]
-                      }
-                      student["schedule"][newBlock] = cname
-                      break
-                    else:
-                      if blockNum == 8:
-                        # All student classes have been filled
-                        break
-                      else:
-                        blockNum += 1
-                        courseNum = 1
-                  else:
-                    if blockNum == 8:
-                      # No room in school for more classes
-                      # print(f"\nError 2: No more room in school for another class")
-                      err2 += 1
-                      break
-                    else:
-                      if (courses[currentCourse]["teachers"] - courseNum) > 0:
-                        courseNum += 1
-                      else:
-                        blockNum += 1
-                        courseNum = 1
-                break
-              else:
-                blockIndex += 1
-                courseNum = 1
-          break
-        elif currentCourse not in activeCourses:
-          if len(student["requests"]) == 8:
-            # This student never had any alternatives
-            # How to solve?
-
-            # print(f"\nError 1: No more available classes for student {student['name']}")
-            err1 += 1
-            generate = False
-          else:
-            if alternateIndex <= (len(student["requests"]) - 1):
-              currentCourse = student["requests"][alternateIndex]
-              alternateIndex += 1
-            else: # Out of alternatives
-              # print(f"\nError 1: No more available classes for student {student['name']}")
-              err1 += 1
-              generate = False
-
-
-def generateScheduleV2():
-  global err1, err2
-  # Collect data and calculate schedules
-  for student in mockStudents:
-    # Tally class request
-    for request in student["requests"]:
-      courses[request]["totalrequests"] += 1
-      courses[request]["studentindexes"].append(mockStudents.index(student))
-      # Add course to active list if enough requests
-      if courses[request]["totalrequests"] > minReq and courses[request]["code"] not in activeCourses: activeCourses[courses[request]["code"]] = courses[request]
-
-  # calculate # of times to run class
-  for i in range(len(activeCourses)):
-    index = list(activeCourses)[i]
-    classRunCount = math.floor(activeCourses[index]["totalrequests"] / classCap)
-    # If there is minReq+ requests left, 1 more class could be run
-    if (activeCourses[index]["totalrequests"] % classCap) > minReq: classRunCount += 1
-    activeCourses[index]["classRunCount"] = classRunCount
-
-    blockIndex = 1
-    while classRunCount > 0:
-      block = f"block{blockIndex}"
-      if activeCourses[index]["code"] not in running[block] and len(running[block]) < blockClassLimit:
-        # Generate class and sub 1 from classRunCount
-        running[block][activeCourses[index]["code"]] = {
-          "name": activeCourses[index]["name"],
-          "students": []
-        }
-        classRunCount -= 1
-      else:
-        if blockIndex == 8:
-          # No room in school for more classes
-          # print(f"\nError 2: No more room in school for another class")
-          err2 += 1
-          classRunCount = 0
-        else:
-          blockIndex += 1
-
-  for student in mockStudents:
-    alternateOffset = len(student["requests"])-8
-    alternateIndex = 8
-    for i in range(len(student["requests"])-alternateOffset): # Subtract x classes as they are alternatives
-      currentCourse = student["requests"][i]
-      generate = True
-      while generate:
-        # If class is allowed to run
-        if currentCourse in activeCourses:
-          blockIndex = 1
-          getFreeBlock = True
-          while getFreeBlock:
-            block = f"block{blockIndex}"
-            if currentCourse in running[block]:
-              if student["schedule"][block] == "": # Add student to class
-                if len(running[block][currentCourse]["students"]) < classCap:
-                  running[block][currentCourse]["students"].append(student["name"])
-                  student["schedule"][block] = courses[currentCourse]["name"]
-                  getFreeBlock = False
-                else: # Find next available class or create new one
-                  if blockIndex == 8:  # No available classes
-                    if len(student["requests"]) == 8:
-                      # This student never had any alternatives
-                      # How to solve?
-
-                      # print(f"\nError 1: No more available classes for student {student['name']}")
-                      err1 += 1
-                      generate = False
-                    else:
-                      if alternateIndex <= (len(student["requests"]) - 1):
-                        currentCourse = student["requests"][alternateIndex]
-                        alternateIndex += 1
-                      else: # No more alterantive
-                        # print(f"\nError 1: No more available classes for student {student['name']}")
-                        err1 += 1
-                        generate = False
-                    getFreeBlock = False
-                  else: blockIndex += 1
-              else:
-                if blockIndex == 8: # No available classes
-                  if len(student["requests"]) == 8:
-                    # This student never had any alternatives
-                    # How to solve?
-
-                    # print(f"\nError 1: No more available classes for student {student['name']}")
-                    err1 += 1
-                    generate = False
-                  else:
-                    if alternateIndex <= (len(student["requests"]) - 1):
-                      currentCourse = student["requests"][alternateIndex]
-                      alternateIndex += 1
-                    else: # No more alternatives
-                      # print(f"\nError 1: No more available classes for student {student['name']}")
-                      err1 += 1
-                      generate = False
-                  getFreeBlock = False
-                else: blockIndex += 1
-            else:
-              if blockIndex == 8:
-                # Class does not exists
-                # Resort to alternative
-                if alternateIndex <= (len(student["requests"]) - 1):
-                  currentCourse = student["requests"][alternateIndex]
-                  alternateIndex += 1
-                else: # Out of alternatives
-                  # print(f"\nError 1: No more available classes for student {student['name']}")
-                  err1 += 1
-                  generate = False
-                break
-              else: blockIndex += 1
-          break
-        elif currentCourse not in activeCourses:
-          if len(student["requests"]) == 8:
-            # This student never had any alternatives
-            # How to solve?
-
-            # print(f"\nError 1: No more available classes for student {student['name']}")
-            err1 += 1
-            generate = False
-          else:
-            if alternateIndex <= (len(student["requests"]) - 1):
-              currentCourse = student["requests"][alternateIndex]
-              alternateIndex += 1
-            else: # Out of alternatives
-              # print(f"\nError 1: No more available classes for student {student['name']}")
-              err1 += 1
-              generate = False
   
+  t.add_row(['Critical', f"{errorsC} %", f"{successC} %", f"{totalCritical}/{len(students)} Students"])
+  t.add_row(['Acceptable', f"{errorsA} %", f"{successA} %", f"{totalAcceptable}/{len(students)} Students"])
   
+  return t, conflicts["Critical"], conflicts["Acceptable"]
 
 if __name__ == '__main__':
+  
   if len(sys.argv) == 1:
     print("Missing argument")
     exit()
+
   if sys.argv[1].upper() == 'V1':
-    if len(sys.argv) == 3:
-      try:
-        studentsNum = int(sys.argv[2])
-      except:
-        print("Error parsing number of students")
-        exit()
     print("Processing...")
-    mockStudents = generateMockStudents(studentsNum)
+
-    generateScheduleV1()
+    mockStudents = generateMockStudents(400)
+    timetable = {}
+    timetable["Version"] = 1
+    timetable["timetable"] = generateScheduleV1(mockStudents, mockCourses)
+  
   elif sys.argv[1].upper() == 'V2':
-    if len(sys.argv) == 3:
-      try:
-        studentsNum = int(sys.argv[2])
-      except:
-        print("Error parsing number of students")
-        exit()
     print("Processing...")
-    mockStudents = generateMockStudents(studentsNum)
+  
-    generateScheduleV2()
+    mockStudents = generateMockStudents(400)
+    timetable = {}
+    timetable["Version"] = 2
+    timetable["timetable"] = generateScheduleV2(mockStudents, mockCourses)
+  
+
+  elif sys.argv[1].upper() == 'V3':
+  
+    print("Processing...\n")
+  
+    sampleStudents = getSampleStudents("./sample_data/course_selection_data.csv", True)
+    samplemockCourses = getSampleCourses("./sample_data/course_selection_data.csv", True)
+    timetable = {}
+    timetable["Version"] = 3
+    timetable["timetable"] = generateScheduleV3(sampleStudents, samplemockCourses, 40, "./output/students.json", "./output/conflicts.json")
+
+    errors, _, _ = errorOutput(sampleStudents)
+    print(errors)
+
+  elif sys.argv[1].upper() == "ERRORS":
+    f = open('./output/students.json')
+    studentData = json.load(f)
+    f.close()
+    errors, critical, acceptable = errorOutput(studentData)
+    print()
+    print(errors)
+
+    print(f"\n{critical['Total']} critical errors")
+    for i in range(len(critical["Errors"])):
+      print(f"x{critical['Errors'][i]['Total']} {critical['Errors'][i]['Code']} Errors: Critical - {critical['Errors'][i]['Description']}")
+
+    print(f"\n{acceptable['Total']} acceptable errors")
+    for i in range(len(acceptable["Errors"])):
+      print(f"x{acceptable['Errors'][i]['Total']} {acceptable['Errors'][i]['Code']} Errors: Critical - {acceptable['Errors'][i]['Description']}")
+
+    exit()
+
   else:
     print("Invalid argument")
     exit()
 
-  print("\n")
+  with open("./output/timetable.json", "w") as outfile:
-  print(f"Error 1: x{err1}")
+    json.dump(timetable, outfile, indent=2)
-  print(f"Error 2: x{err2}")
-  print("\n")
 
-  ### Displays the number of students in each class
+  print("\nDone")
-  # for block in running:
-  #   print(f"\nBlock: {block}")
-  #   print("=====================")
-  #   for cl in running[block]:
-  #     name = running[block][cl]["name"]
-  #     students = len(running[block][cl]["students"])
-  #     print(f"Class: {name} | Students: {students}")
-
-  # Count errors in students schedules
-  errors = 0
-  for i in range(len(mockStudents)):
-    count = 0
-    for course in mockStudents[i]["schedule"]:
-      if mockStudents[i]["schedule"][course]=="": count+=1
-    if count > 0: errors += 1
-  
-  print(f"{errors}/{studentsNum} student(s) have a issue with their schedule")
-
-
-  with open("schedule.json", "w") as outfile:
-    json.dump(running, outfile, indent=2)
-
-  with open("students.json", "w") as outfile:
-    json.dump(mockStudents, outfile, indent=2)
-
-  print("Done")

test/util/courses.py

@@ -1,4 +1,6 @@
-courses = {
+# Fake sample data
+
+mockCourses = {
   "P-CL": {
     "name": "Pre-Calculus",
     "code": "P-CL",
@@ -99,8 +101,8 @@ courses = {
     "teachers": 3
   },
   "SC-ES": {
-    "name": "SC-ES",
+    "name": "Earth Science",
-    "code": "cl12",
+    "code": "SC-ES",
     "credits": 4,
     "gradelevel": 11,
     "totalrequests": 0,
@@ -109,7 +111,7 @@ courses = {
   },
   "M": {
     "name": "Music",
-    "code": "Ms",
+    "code": "M",
     "credits": 4,
     "gradelevel": 11,
     "totalrequests": 0,

test/util/generateCourses.py

@@ -0,0 +1,36 @@
+#!/usr/bin/env python3
+import json
+import csv
+
+realCourses = {}
+
+# Get all courses from real sample data
+def getSampleCourses(data_dir, log=False) -> dict:
+  with open(data_dir, newline='') as csvfile:
+    reader = csv.DictReader(csvfile)
+    for row in reader:
+      exists = False
+      for course in realCourses:
+        exists = True if realCourses[course]["CrsNo"] == row["CrsNo"] else False
+        if exists: break
+      if not exists:
+        realCourses[row["CrsNo"]] = {
+          "CrsNo": row["CrsNo"],
+          "Requests": 0,
+          "Description": row["Description"],
+          "Credits": 4,
+          "students": []
+        }
+
+  if log:
+    with open("./output/realCourses.json", "w") as outfile:
+      json.dump(realCourses, outfile, indent=2)
+        
+  return realCourses
+
+
+if __name__ == '__main__':
+  courseSet: dict = getSampleCourses("../sample_data/course_selection_data.csv")
+
+  with open("../output/realCourses.json", "w") as outfile:
+    json.dump(courseSet, outfile, indent=2)

test/util/mockStudents.py

@@ -0,0 +1,111 @@
+#!/usr/bin/env python3
+import random
+import names
+import json
+import csv
+import sys
+from util.courses import mockCourses
+
+flex= ["XAT--12A-S", "XAT--12B-S"]
+
+mockStudents: list[dict] = []
+
+# Generate n students for mock data
+def generateMockStudents(n: int) -> list[dict]:
+  for _ in range(n):
+    newStudent = {
+      "name": names.get_full_name(),
+      "requests": [], # list of class codes
+      "schedule": {
+        "block1": "",
+        "block2": "",
+        "block3": "",
+        "block4": "",
+        "block5": "",
+        "block6": "",
+        "block7": "",
+        "block8": ""
+      }
+    }
+    # Get list of random class choices with no repeats
+    # 8 primary choices, 2 secondary choices
+    courseSelection = random.sample(range(0, len(mockCourses)), 10)
+    for courseNum in courseSelection:
+      newStudent["requests"].append(list(mockCourses)[courseNum])
+    mockStudents.append(newStudent)
+
+  return mockStudents
+
+
+# sort real sample data into usable dictionary
+def getSampleStudents(data_dir: str, log: bool = False) -> list[dict]:
+  with open(data_dir, newline='') as csvfile:
+    reader = csv.DictReader(csvfile)
+    for row in reader:
+      exists = False
+      for student in mockStudents:
+        exists = True if student["Pupil #"] == row["Pupil #"] else False
+        if exists: break
+      alternate = True if row["Alternate?"] == 'TRUE' else False
+      if exists:
+        if len(mockStudents[student["studentIndex"]]["requests"]) >= 10 and not alternate and row["CrsNo"] not in flex: alternate = True
+        mockStudents[student["studentIndex"]]["requests"].append({
+          "CrsNo": row["CrsNo"],
+          "Description": row["Description"],
+          "alt": alternate
+        })
+        if row["CrsNo"] not in flex and not alternate and mockStudents[student["studentIndex"]]["expectedClasses"] < 10:
+          mockStudents[student["studentIndex"]]["expectedClasses"] += 1
+      else:
+        newStudent = {
+          "Pupil #": row["Pupil #"],
+          "requests": [{
+            "CrsNo": row["CrsNo"],
+            "Description": row["Description"],
+            "alt": alternate
+          }],
+          "schedule": {
+            "block1": [],
+            "block2": [],
+            "block3": [],
+            "block4": [],
+            "block5": [],
+            "block6": [],
+            "block7": [],
+            "block8": [],
+            "block9": [],
+            "block10": []
+          },
+          "expectedClasses": 1,
+          "classes": 0,
+          "remainingAlts": [],
+          "studentIndex": len(mockStudents)
+        }
+        mockStudents.append(newStudent)
+
+  if log:
+    with open("./output/students.json", "w") as outfile:
+      json.dump(mockStudents, outfile, indent=2)
+
+  return mockStudents
+
+
+if __name__ == '__main__':
+  if len(sys.argv) == 1:
+    print("Missing argument")
+    exit()
+  if sys.argv[1].lower() == 'sample':
+    studentRequests: list[dict] = getSampleStudents("../sample_data/course_selection_data.csv")
+
+    with open("../output/students.json", "w") as outfile:
+      json.dump(studentRequests, outfile, indent=2)
+  elif sys.argv[1].lower() == 'mock':
+    studentRequests: list[dict] = generateMockStudents(400)
+
+    with open("../output/students.json", "w") as outfile:
+      json.dump(studentRequests, outfile, indent=2)
+  else:
+    print("Invalid argument")
+    exit()
+
+  print("done")