14 |
18 |
15 | {% block content %} {% endblock %}
16 |
17 |
11 |
13 |
14 | {% endblock %}
15 |
16 |
--------------------------------------------------------------------------------
/common/admin.py:
--------------------------------------------------------------------------------
1 | from django.contrib import admin
2 |
3 | # Register your models here.
4 | from .models import *
5 |
6 | # The approved_users field creates some issues when trying to update APIClients,
7 | # so just remove it entirely
8 | class APIClientAdmin(admin.ModelAdmin):
9 | exclude = ('approved_users',)
10 |
11 | admin.site.register(Student)
12 | admin.site.register(RedirectURL)
13 | admin.site.register(APIClient, APIClientAdmin)
--------------------------------------------------------------------------------
/analytics/static/analytics/css/styles.css:
--------------------------------------------------------------------------------
1 | .chart-card {
2 | padding: 8px 16px 16px 16px;
3 | }
4 |
5 | @media (min-width: 767px) {
6 | .analytics-body {
7 | padding: 12px 30px 30px 30px;
8 | }
9 | }
10 |
11 | @media (max-width: 767px) {
12 | .analytics-body {
13 | padding: 12px 12px 36px 12px;
14 | }
15 | }
16 |
17 | .floating-indicator {
18 | position: absolute;
19 | margin: auto;
20 | left: 0;
21 | right: 0;
22 | top: 0;
23 | bottom: 0;
24 | }
25 |
--------------------------------------------------------------------------------
/sync/urls.py:
--------------------------------------------------------------------------------
1 | from django.conf.urls import url
2 |
3 | from . import views
4 |
5 | urlpatterns = [
6 | url('sync_road/', views.sync_road, name='sync_road'),
7 | url('delete_road/', views.delete_road, name='delete_road'),
8 | url('roads/', views.roads, name='roads'),
9 | url('sync_schedule/', views.sync_schedule, name='sync_schedule'),
10 | url('delete_schedule/', views.delete_schedule, name='delete_schedule'),
11 | url('schedules/', views.schedules, name='schedules')
12 | ]
13 |
--------------------------------------------------------------------------------
/common/templates/common/login_fail.html:
--------------------------------------------------------------------------------
1 | {% extends "common/auth_base.html" %}
2 | {% load static %}
3 |
4 | {% block pagebody %}
5 | Login successful, syncing your account...
12 |
6 |
8 | 12 |
13 |
14 | {% endblock %}
15 |
--------------------------------------------------------------------------------
/courseupdater/sem-spring-2018/delta-1.txt:
--------------------------------------------------------------------------------
1 | spring#,#2018
2 | 1
3 | 1
4 | 2
5 | 3
6 | 4
7 | 5
8 | 6
9 | 7
10 | 8
11 | 9
12 | 10
13 | 11
14 | 12
15 | 14
16 | 15
17 | 16
18 | 17
19 | 18
20 | 20
21 | 21
22 | 21A
23 | 21G
24 | 21H
25 | 21L
26 | 21M
27 | 21W
28 | 22
29 | 24
30 | AS
31 | CC
32 | CMS
33 | condensed_0
34 | condensed_1
35 | condensed_2
36 | condensed_3
37 | departments
38 | enrollment
39 | CSB
40 | EC
41 | EM
42 | ES
43 | HST
44 | IDS
45 | MAS
46 | MS
47 | NS
48 | related
49 | SCM
50 | SP
51 | STS
52 | SWE
53 | WGS
54 |
--------------------------------------------------------------------------------
/courseupdater/sem-spring-2018/delta-2.txt:
--------------------------------------------------------------------------------
1 | spring#,#2018
2 | 2
3 | 1
4 | 2
5 | 3
6 | 4
7 | 5
8 | 6
9 | 7
10 | 8
11 | 9
12 | 10
13 | 11
14 | 12
15 | 14
16 | 15
17 | 16
18 | 17
19 | 18
20 | 20
21 | 21
22 | 21A
23 | 21G
24 | 21H
25 | 21L
26 | 21M
27 | 21W
28 | 22
29 | 24
30 | AS
31 | CC
32 | CMS
33 | condensed_0
34 | condensed_1
35 | condensed_2
36 | condensed_3
37 | departments
38 | enrollment
39 | CSB
40 | EC
41 | EM
42 | ES
43 | HST
44 | IDS
45 | MAS
46 | MS
47 | NS
48 | related
49 | SCM
50 | SP
51 | STS
52 | SWE
53 | WGS
54 |
--------------------------------------------------------------------------------
/courseupdater/sem-fall-2017/delta-1.txt:
--------------------------------------------------------------------------------
1 | fall#,#2017
2 | 1
3 | 1
4 | 2
5 | 3
6 | 4
7 | 5
8 | 6
9 | 7
10 | 8
11 | 9
12 | 10
13 | 11
14 | 12
15 | 14
16 | 15
17 | 16
18 | 17
19 | 18
20 | 20
21 | 21
22 | 21A
23 | 21G
24 | 21H
25 | 21L
26 | 21M
27 | 21W
28 | 22
29 | 24
30 | AS
31 | CC
32 | CMS
33 | condensed_0
34 | condensed_1
35 | condensed_2
36 | condensed_3
37 | condensed
38 | departments
39 | enrollment
40 | CSB
41 | EC
42 | EM
43 | ES
44 | HST
45 | IDS
46 | MAS
47 | MS
48 | NS
49 | related
50 | SCM
51 | SP
52 | STS
53 | SWE
54 | WGS
55 |
--------------------------------------------------------------------------------
/courseupdater/templates/courseupdater/update_error.html:
--------------------------------------------------------------------------------
1 | {% extends "common/base.html" %}
2 | {% load static %}
3 | {% block title %}
4 | Login failed: {{ message }}
7 |8 | 12 |
10 | There was an error updating the catalog: {{ error }}
11 |
12 | Try Again 13 |
14 | {% endblock %}
15 |
--------------------------------------------------------------------------------
/common/templates/common/dev_login.html:
--------------------------------------------------------------------------------
1 | {% extends "common/auth_base.html" %}
2 | {% load static %}
3 |
4 | {% block pagebody %}
5 | 12 | Try Again 13 |
6 |
17 | {% endblock %}
18 |
--------------------------------------------------------------------------------
/common/static/common/css/auth.css:
--------------------------------------------------------------------------------
1 | @media screen and (min-width: 480px) {
2 | #par {
3 | width: 60%;
4 | margin: auto;
5 | }
6 | }
7 | @media screen and (max-width: 480px) {
8 | #par {
9 | padding-left: 25px;
10 | padding-right: 25px;
11 | }
12 |
13 | h2 {
14 | font-size: 2.5em;
15 | }
16 | }
17 |
18 | p {
19 | font-weight: 300;
20 | }
21 |
22 | #buttons {
23 | display: flex;
24 | justify-content: center;
25 | flex-wrap: wrap;
26 | }
27 |
28 | .mbtn {
29 | margin: 12px;
30 | }
31 |
32 | .fineprint {
33 | font-size: 0.7em;
34 | }
35 |
36 |
--------------------------------------------------------------------------------
/manage.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python
2 | import os
3 | import sys
4 |
5 | if __name__ == "__main__":
6 | os.environ.setdefault("DJANGO_SETTINGS_MODULE", "fireroad.settings")
7 | try:
8 | from django.core.management import execute_from_command_line
9 | except ImportError:
10 | raise ImportError(
11 | "Couldn't import Django. Are you sure it's installed and "
12 | "available on your PYTHONPATH environment variable? Did you "
13 | "forget to activate a virtual environment?"
14 | )
15 | execute_from_command_line(sys.argv)
16 |
--------------------------------------------------------------------------------
/courseupdater/static/courseupdater/css/style.css:
--------------------------------------------------------------------------------
1 | .diff-list {
2 | width: 100%;
3 | overflow-y: scroll !important;
4 | }
5 |
6 | .vertical-center {
7 | position: absolute;
8 | margin: auto;
9 | top: 0;
10 | right: 0;
11 | bottom: 0;
12 | left: 0;
13 | width: 400px;
14 | height: 100px;
15 | }
16 |
17 | @media (min-width: 767px) {
18 | .corrections-body {
19 | padding: 12px 30px 30px 30px;
20 | }
21 |
22 | .bottom-btn {
23 | position: absolute;
24 | bottom: 6px;
25 | right: 0;
26 | }
27 | }
28 |
29 | @media (max-width: 767px) {
30 | .corrections-body {
31 | padding: 12px 12px 36px 12px;
32 | }
33 | }
34 |
--------------------------------------------------------------------------------
/courseupdater/templates/courseupdater/update_success.html:
--------------------------------------------------------------------------------
1 | {% extends "common/base.html" %}
2 | {% load static %}
3 | {% block title %}
4 | Dev Mode Login
7 | 16 |
10 | The catalog has been scheduled to update at the next database refresh.
11 |
12 | Cancel Update 13 | Home 14 |
15 | {% endblock %}
16 |
--------------------------------------------------------------------------------
/fireroad/wsgi.py:
--------------------------------------------------------------------------------
1 | """
2 | WSGI config for fireroad project.
3 |
4 | It exposes the WSGI callable as a module-level variable named ``application``.
5 |
6 | For more information on this file, see
7 | https://docs.djangoproject.com/en/2.0/howto/deployment/wsgi/
8 | """
9 |
10 | import os
11 | import sys
12 |
13 | from django.core.wsgi import get_wsgi_application
14 |
15 | # Add the root path for the Django server to sys.path so WSGI can find the
16 | # right settings module
17 | sys.path.insert(0, os.path.dirname(os.path.dirname(__file__)))
18 | os.environ.setdefault("DJANGO_SETTINGS_MODULE", "fireroad.settings")
19 |
20 | application = get_wsgi_application()
21 |
--------------------------------------------------------------------------------
/analytics/urls.py:
--------------------------------------------------------------------------------
1 | from django.conf.urls import url
2 |
3 | from . import views
4 |
5 | urlpatterns = [
6 | url(r'total_requests/(?P12 | Cancel Update 13 | Home 14 |
13 |
19 | {% endblock %}
20 |
21 | {% block pagescripts %}
22 |
30 | {% block scripts %}{% endblock %}
31 | {% endblock %}
32 |
--------------------------------------------------------------------------------
/common/static/common/css/shared.css:
--------------------------------------------------------------------------------
1 | .logo-img {
2 | vertical-align: middle;
3 | margin-top: -5px;
4 | margin-right: 12px;
5 | }
6 | @media screen and (max-width: 480px) {
7 | .logo-img {
8 | margin-right: 2px !important;
9 | }
10 | }
11 | .nav-wrapper {
12 | padding-left: 12px;
13 | }
14 | .mbtn {
15 | margin: 8px;
16 | }
17 |
18 | .material-icons{
19 | display: inline-flex;
20 | vertical-align: top;
21 | }
22 |
23 | a {
24 | color: rgb(224, 20, 20);
25 | }
26 |
27 | .file-example-content {
28 | overflow-y: scroll;
29 | max-height: 240px;
30 | }
31 |
32 | pre.code {
33 | margin: 0 !important;
34 | }
35 |
36 | .json-key {
37 | color: #1976D2 !important;
38 | }
39 |
40 | .json-string-value {
41 | color: #e91e63 !important;
42 | }
43 |
44 | .json-number-value {
45 | color: #4CAF50 !important;
46 | }
47 |
48 | .login-pane {
49 | max-width: 450px;
50 | }
--------------------------------------------------------------------------------
/requirements/static/requirements/js/edit.js:
--------------------------------------------------------------------------------
1 | var previewMode = 0;
2 |
3 | function onPreviewButtonClicked(editTitle, textSelector, editorSelector) {
4 | if (previewMode == 0) {
5 | // Go to preview
6 | $("#preview-button").text(editTitle);
7 | $("#preview-loading-ind").addClass("active");
8 | previewMode = 1;
9 | $.ajax({
10 | url: "/requirements/preview/",
11 | type: "POST",
12 | data: $(textSelector).val(),
13 | contentType:"text/plain; charset=utf-8",
14 | success: function(data) {
15 | $("#preview").html(data);
16 | $("#preview").toggle();
17 | $("#preview-loading-ind").removeClass("active");
18 | }
19 | });
20 |
21 | } else {
22 | // Go back to edit
23 | $("#preview-button").text("Preview");
24 | previewMode = 0;
25 | $("#preview").toggle();
26 | }
27 | $(editorSelector).toggle();
28 | }
29 |
--------------------------------------------------------------------------------
/catalog_parse/utils/parse_equivalences.py:
--------------------------------------------------------------------------------
1 | import json
2 | from .catalog_constants import *
3 |
4 | def parse_equivalences(equiv_path, courses):
5 | """
6 | Reads equivalences from the given path, and adds them to the "Parent" and
7 | "Children" attributes of the appropriate courses.
8 |
9 | equiv_path: path to a JSON file containing equivalences, for example:
10 | [[["6.0001", "6.0002"], "6.00"], ...]
11 | courses: a dictionary of subject IDs to courses
12 | """
13 |
14 | with open(equiv_path, 'r') as file:
15 | equiv_data = json.loads(file.read())
16 |
17 | for equivalence in equiv_data:
18 | children, parent = equivalence
19 | for child in children:
20 | if child not in courses: continue
21 | courses[child][CourseAttribute.parent] = parent
22 | if parent in courses:
23 | courses[parent][CourseAttribute.children] = ','.join(children)
24 |
--------------------------------------------------------------------------------
/courseupdater/urls.py:
--------------------------------------------------------------------------------
1 | from django.conf.urls import url
2 |
3 | from . import views
4 |
5 | urlpatterns = [
6 | url(r'^$', views.index, name='index'),
7 | url('check/', views.check, name='check'),
8 | url('semesters/', views.semesters, name='semesters'),
9 |
10 | url(r'update_catalog/', views.update_catalog, name='update_catalog'),
11 | url(r'update_progress/', views.update_progress, name='update_progress'),
12 | url(r'reset_update/', views.reset_update, name='reset_update'),
13 |
14 | url(r'corrections/delete/(?P
10 | There is currently no catalog update in progress. Enter a semester name to start one.
11 |
12 |
13 | 28 |
29 | {% endblock %}
30 |
--------------------------------------------------------------------------------
/recommend/models.py:
--------------------------------------------------------------------------------
1 | from django.db import models
2 | from django.forms import ModelForm
3 | from django.contrib.auth.models import User
4 |
5 | MAX_RATING_VALUE = 5
6 | DEFAULT_RECOMMENDATION_TYPE = "for-you"
7 |
8 | # Create your models here.
9 | class Rating(models.Model):
10 | user = models.ForeignKey(User, null=True, on_delete=models.CASCADE)
11 | #user_id = models.BigIntegerField(default=0) # DEPRECATED
12 | subject_id = models.CharField(max_length=50)
13 | value = models.IntegerField(default=0)
14 |
15 | def __str__(self):
16 | return "User {} rated {} as {}".format(self.user_id, self.subject_id, self.value)
17 |
18 | class Recommendation(models.Model):
19 | user = models.ForeignKey(User, null=True, on_delete=models.CASCADE)
20 | #user_id = models.BigIntegerField(default=0) # DEPRECATED
21 | rec_type = models.CharField(max_length=20)
22 | subjects = models.CharField(max_length=500)
23 |
24 | def __str__(self):
25 | return "Recommendation ({}) for user {}: {}".format(self.rec_type, self.user_id, self.subjects)
26 |
--------------------------------------------------------------------------------
/license.txt:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2018 Venkatesh Sivaraman
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/requirements/urls.py:
--------------------------------------------------------------------------------
1 | from django.conf.urls import url
2 |
3 | from . import views
4 | from . import editor
5 |
6 | from django.views.generic import TemplateView
7 |
8 | urlpatterns = [
9 | url(r'^edit/(?P12 |
13 | 28 |
FireRoad API Reference
9 |The FireRoad server provides a comprehensive API, with both read-only interfaces for course catalogs and major/minor requirements and read-write endpoints for interfacing with users' roads and schedules.
10 |The read-only API is open-access, and logging in with your MIT credentials allows you to test the read-write APIs within your own account. Please contact us if you would like to use the read-write APIs to create a FireRoad client that accesses other user data.
11 |IMPORTANT: Please use the development server at fireroad-dev.mit.edu for all testing.
12 | 13 | 23 | {% endblock %} 24 | -------------------------------------------------------------------------------- /common/templates/common/signup.html: -------------------------------------------------------------------------------- 1 | {% extends "common/auth_base.html" %} 2 | {% load static %} 3 | 4 | {% block pagebody %} 5 |
6 |
11 |
15 |
16 | {% endblock %}
17 |
--------------------------------------------------------------------------------
/common/templates/common/client_approval.html:
--------------------------------------------------------------------------------
1 | {% extends "common/auth_base.html" %}
2 | {% load static %}
3 |
4 | {% block pagebody %}
5 | Sync and Recommendations
7 |Would you like to sync your roads and schedules with CourseRoad and across your devices? FireRoad will also provide you with personalized suggestions based on your subject selections.
8 |Tap Allow and Continue to enable this feature. You can also do so later in the settings view.
9 |Sync and Recommendations requires MIT credentials. By enabling this feature, you are allowing FireRoad to store your roads, schedules, and subject ratings on a secure MIT server. FireRoad uses various machine learning algorithms to provide you with subject recommendations and to improve other users' recommendations anonymously. Recommendations are solely suggestions - please consult with faculty and course administrators for the most reliable and up-to-date information.
10 |
6 |
23 | {% endblock %}
24 |
--------------------------------------------------------------------------------
/fireroad/settings_prod.py:
--------------------------------------------------------------------------------
1 | """
2 | Django settings for fireroad project in prod environment only.
3 | """
4 |
5 | import os
6 | from .settings import *
7 |
8 | # Location of catalog files on the server
9 | CATALOG_BASE_DIR = "/var/www/html/catalogs"
10 |
11 | # URL used to log in (e.g. to admin)
12 | LOGIN_URL = "/login_touchstone"
13 |
14 | # Security settings
15 | RESTRICT_AUTH_REDIRECTS = True
16 | DEBUG = False
17 |
18 | # For building URLs and validating hosts
19 | ALLOWED_HOSTS = ['fireroad.mit.edu']
20 | MY_BASE_URL = 'https://fireroad.mit.edu'
21 |
22 | # MySQL database
23 | import dbcreds
24 |
25 | DATABASES = {
26 | 'default': {
27 | 'ENGINE': 'django.db.backends.mysql',
28 | 'NAME': dbcreds.dbname, # For scripts: venkats+fireroad
29 | 'USER': dbcreds.username,
30 | 'PASSWORD': dbcreds.password,
31 | 'HOST': dbcreds.host, # For scripts: sql.mit.edu
32 | 'PORT': '3306',
33 | }
34 | }
35 |
36 | MIDDLEWARE_CLASSES = [
37 | 'django.contrib.sessions.middleware.SessionMiddleware',
38 | 'django.middleware.common.CommonMiddleware',
39 | 'django.middleware.csrf.CsrfViewMiddleware',
40 | 'django.contrib.auth.middleware.AuthenticationMiddleware',
41 | 'django.contrib.messages.middleware.MessageMiddleware',
42 | 'django.middleware.clickjacking.XFrameOptionsMiddleware',
43 | 'analytics.request_counter.RequestCounterMiddleware'
44 | ]
45 |
--------------------------------------------------------------------------------
/setup_catalog.sh:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 |
3 | # This script handles setting up the catalog for local development.
4 |
5 | GREEN='\033[0;32m'
6 | NC='\033[0m' # No Color
7 |
8 | CATALOG_DIR=$( python -c "from fireroad.settings import CATALOG_BASE_DIR; print(CATALOG_BASE_DIR)" )
9 | if [ ! -d $CATALOG_DIR ]; then
10 | echo "It looks like the course catalog directory is currently empty. You can download a copy (https://fireroad.mit.edu/courseupdater/download_data) and unzip it in the data directory."
11 | echo
12 | echo "Alternatively, you can begin without initial data using the instructions in data/readme.md."
13 | echo
14 | echo
15 |
16 | read -p "Would you like to begin without initial data? (y/n) " ready
17 | if [[ $ready != "y" ]]; then
18 | echo "Run this script again after downloading and placing the catalog data."
19 | exit 0
20 | fi
21 |
22 | # Set up directories
23 | mkdir -p $CATALOG_DIR
24 | mkdir -p $CATALOG_DIR/raw
25 | mkdir -p $CATALOG_DIR/requirements
26 | mkdir -p $CATALOG_DIR/deltas
27 | mkdir -p $CATALOG_DIR/deltas/requirements
28 |
29 | echo "Done creating directories at $CATALOG_DIR. Follow the instructions in data/readme.md to run the catalog parser and create requirements lists."
30 | exit 0
31 | fi
32 |
33 | # Set location of settings file
34 | export DJANGO_SETTINGS_MODULE="fireroad.settings"
35 | echo -e "${GREEN}Running database update script...${NC}"
36 | python update_db.py
--------------------------------------------------------------------------------
/fireroad/settings_dev.py:
--------------------------------------------------------------------------------
1 | """
2 | Django settings for fireroad project in dev server environment only.
3 | """
4 |
5 | import os
6 | from .settings import *
7 |
8 | # Location of catalog files on the server
9 | CATALOG_BASE_DIR = "/var/www/html/catalogs"
10 |
11 | # URL used to log in
12 | LOGIN_URL = "/login_touchstone"
13 |
14 | # Security settings more relaxed on dev server
15 | RESTRICT_AUTH_REDIRECTS = False
16 | DEBUG = True
17 |
18 | # For building URLs and validating hosts
19 | ALLOWED_HOSTS = ['fireroad-dev.mit.edu']
20 | MY_BASE_URL = 'https://fireroad-dev.mit.edu'
21 |
22 | # MySQL database
23 | import dbcreds
24 |
25 | DATABASES = {
26 | 'default': {
27 | 'ENGINE': 'django.db.backends.mysql',
28 | 'NAME': dbcreds.dbname, # For scripts: venkats+fireroad
29 | 'USER': dbcreds.username,
30 | 'PASSWORD': dbcreds.password,
31 | 'HOST': dbcreds.host, # For scripts: sql.mit.edu
32 | 'PORT': '3306',
33 | }
34 | }
35 |
36 | MIDDLEWARE_CLASSES = [
37 | 'django.contrib.sessions.middleware.SessionMiddleware',
38 | 'django.middleware.common.CommonMiddleware',
39 | 'django.middleware.csrf.CsrfViewMiddleware',
40 | 'django.contrib.auth.middleware.AuthenticationMiddleware',
41 | 'django.contrib.messages.middleware.MessageMiddleware',
42 | 'django.middleware.clickjacking.XFrameOptionsMiddleware',
43 | 'analytics.request_counter.RequestCounterMiddleware'
44 | ]
45 |
--------------------------------------------------------------------------------
/courseupdater/templates/courseupdater/corrections.html:
--------------------------------------------------------------------------------
1 | {% extends "common/base.html" %}
2 | {% load static %}
3 | {% block title %}
4 | Approve Client
7 |"{{ client_name }}" is requesting access to your FireRoad account. This client will be granted the following capabilities:
8 |-
9 | {% for permission in client_permissions %}
10 |
- {{ permission }} 11 | {% endfor %} 12 |
WARNING: This site is authenticating you through the FireRoad development server, which is subject to potential vulnerabilities and does not restrict client sites to specific permissions. This means of authentication must not be used for production applications.
15 | {% endif %} 16 |Would you like to allow this?
17 |If you have questions, comments, or concerns, please contact the developer of this client or the FireRoad dev team.
18 | 22 |
11 |
32 | {% endblock %}
33 |
--------------------------------------------------------------------------------
/courseupdater/templates/courseupdater/review_update.html:
--------------------------------------------------------------------------------
1 | {% extends "common/base.html" %}
2 | {% load static %}
3 | {% block title %}
4 |
12 |
17 |
31 |
13 |
15 | add New Correction
16 | Catalog Corrections
14 |
10 |
35 | {% endblock %}
36 |
--------------------------------------------------------------------------------
/common/templates/common/docs/recommender.html:
--------------------------------------------------------------------------------
1 | {% extends "common/docs/base.html" %}
2 |
3 | {% block nav %}
4 | {% include "common/docs/sidebar.html" with active_id="recommender" %}
5 | {% endblock %}
6 |
7 | {% block content %}
8 |
11 |
15 |
12 |
14 | Review Catalog Update
13 |
16 | {% for diff in diffs %}
17 |
18 | {% autoescape off %}{{ diff }}{% endautoescape %}
19 |
20 | {% endfor %}
21 |
22 |
23 |
24 |
33 |
34 | Review the changes above, then press Deploy Update to publish the changes at the next nightly database refresh.
Recommender
9 |Use these endpoints to update and access various course recommendations generated by the FireRoad recommendation engine.
10 | 11 |/recommend/rate (POST)
12 |Sends a subject rating to the FireRoad server. The body of the request should be a JSON list of dictionaries, each containing s (subject ID) and v (rating value). Updates the ratings for each item.
13 | 14 |/recommend/get (GET)
15 |Takes an optional parameter t indicating the type of recommendation to return. Returns a dictionary of recommendation types mapped to JSON strings indicating the recommended subjects and their rating values.
16 | 17 | 28 | {% endblock %} 29 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Created by https://www.gitignore.io 2 | 3 | ### OSX ### 4 | .DS_Store 5 | .AppleDouble 6 | .LSOverride 7 | 8 | # Icon must end with two \r 9 | Icon 10 | 11 | 12 | # Thumbnails 13 | ._* 14 | 15 | # Files that might appear on external disk 16 | .Spotlight-V100 17 | .Trashes 18 | 19 | # Directories potentially created on remote AFP share 20 | .AppleDB 21 | .AppleDesktop 22 | Network Trash Folder 23 | Temporary Items 24 | .apdisk 25 | 26 | 27 | ### Python ### 28 | # Byte-compiled / optimized / DLL files 29 | __pycache__/ 30 | *.py[cod] 31 | 32 | # C extensions 33 | *.so 34 | 35 | # Distribution / packaging 36 | .Python 37 | env/ 38 | build/ 39 | develop-eggs/ 40 | dist/ 41 | downloads/ 42 | eggs/ 43 | lib/ 44 | lib64/ 45 | parts/ 46 | sdist/ 47 | var/ 48 | *.egg-info/ 49 | .installed.cfg 50 | *.egg 51 | 52 | # PyInstaller 53 | # Usually these files are written by a python script from a template 54 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 55 | *.manifest 56 | *.spec 57 | 58 | # Installer logs 59 | pip-log.txt 60 | pip-delete-this-directory.txt 61 | 62 | # Unit test / coverage reports 63 | htmlcov/ 64 | .tox/ 65 | .coverage 66 | .cache 67 | nosetests.xml 68 | coverage.xml 69 | 70 | # Translations 71 | *.mo 72 | *.pot 73 | 74 | # Sphinx documentation 75 | docs/_build/ 76 | 77 | # PyBuilder 78 | target/ 79 | 80 | 81 | ### Django ### 82 | *.log 83 | *.pot 84 | *.pyc 85 | __pycache__/ 86 | local_settings.py 87 | 88 | .env 89 | db.sqlite3 90 | 91 | .ipynb_checkpoints 92 | */migrations/* 93 | static/**/* 94 | 95 | data/catalogs/** -------------------------------------------------------------------------------- /common/templates/common/docs/sidebar.html: -------------------------------------------------------------------------------- 1 | 32 | -------------------------------------------------------------------------------- /setup.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | SECRETPATH="fireroad/secret.txt" 4 | DBCREDPATH="fireroad/dbcreds.py" 5 | RED='\033[0;31m' 6 | GREEN='\033[0;32m' 7 | YELLOW='\033[1;33m' 8 | NC='\033[0m' # No Color 9 | 10 | # Installing dependencies 11 | pip install django==1.11.15 pandas nltk==3.4 lxml scipy scikit-learn requests pyjwt==1.6.4 12 | echo 13 | echo 14 | 15 | # Secret key 16 | if [ ! -f $SECRETPATH ]; then 17 | openssl rand -base64 80 > $SECRETPATH 18 | echo -e "${GREEN}Generated secret key at $SECRETPATH ${NC}" 19 | fi 20 | 21 | # Prompt for database type 22 | BACKEND=$( python -c "from fireroad.settings import DATABASES; print(DATABASES['default']['ENGINE'])" ) 23 | NAME=$( python -c "from fireroad.settings import DATABASES; print(DATABASES['default']['NAME'])" ) 24 | read -p "You are set to use the database '$NAME' (backend: $BACKEND). Would you like to migrate to this backend? (y/n) " keepbackend 25 | if [[ $keepbackend == "y" ]]; then 26 | # Migrate database 27 | echo "Migrating to database $NAME..." 28 | 29 | # Migrations 30 | python manage.py makemigrations analytics common catalog courseupdater sync recommend requirements 31 | read -p "Ready to migrate? (y/n) " ready 32 | if [[ $ready != "y" ]]; then 33 | echo "Use the following command to migrate the database when ready:" 34 | echo 35 | echo " python manage.py migrate" 36 | echo 37 | exit 0 38 | fi 39 | python manage.py migrate 40 | 41 | echo "Done migrating." 42 | exit 0 43 | elif [[ $keepbackend == "n" ]]; then 44 | echo -e "${YELLOW}Please modify the fireroad/settings.py file to use the appropriate database, or specify a different settings module when running the server (such as settings_dev or settings_prod).${NC}" 45 | else 46 | echo -e "${RED}Unrecognized symbol $keepbackend; quitting ${NC}" 47 | exit 1 48 | fi 49 | 50 | 51 | -------------------------------------------------------------------------------- /courseupdater/templates/courseupdater/update_progress.html: -------------------------------------------------------------------------------- 1 | {% extends "common/base.html" %} 2 | {% load static %} 3 | {% block title %} 4 |
10 | {% if not update.is_started %}
11 |
20 | Cancel Update 21 |
22 | {% endblock %}
23 |
24 | {% block pagescripts %}
25 |
48 | {% endblock %}
49 |
--------------------------------------------------------------------------------
/analytics/request_counter.py:
--------------------------------------------------------------------------------
1 | """This module counts basic information about incoming requests to the
2 | FireRoad server.
3 |
4 | NOTE: The data that is collected contains potential user-identifying
5 | information (namely, the user's unique ID and current semester). This info will
6 | not leave the FireRoad server unless it is aggregated such that users are no
7 | longer identifiable.
8 | """
9 |
10 | from .models import *
11 |
12 | EXCLUDE_PATH_PREFIXES = [
13 | "/favicon.ico",
14 | "/admin",
15 | "/analytics",
16 | "/apple"
17 | ]
18 |
19 | EXCLUDE_USER_AGENTS = [
20 | "check_http",
21 | "monitoring",
22 | "bot",
23 | "crawl",
24 | "spider"
25 | ]
26 |
27 | class RequestCounterMiddleware(object):
28 | """A middleware that saves a RequestCount object each time a page is requested."""
29 |
30 | def process_response(self, request, response):
31 | """Called after Django calls the request's view. We will use this hook
32 | to log basic information about the request (performed after request
33 | to make sure we have login info)."""
34 | if any(request.path.startswith(prefix) for prefix in EXCLUDE_PATH_PREFIXES):
35 | return response
36 | user_agent = request.META.get("HTTP_USER_AGENT", "")
37 | if any(element in user_agent.lower() for element in EXCLUDE_USER_AGENTS):
38 | return response
39 |
40 | tally = RequestCount.objects.create()
41 | tally.path = request.path
42 | if len(user_agent) > 150:
43 | user_agent = user_agent[:150]
44 | tally.user_agent = user_agent
45 | if hasattr(request, "user") and request.user and request.user.is_authenticated():
46 | tally.is_authenticated = True
47 | try:
48 | student = request.user.student
49 | except:
50 | pass
51 | else:
52 | tally.student_unique_id = student.unique_id
53 | tally.student_semester = student.current_semester
54 | tally.save()
55 | return response
56 |
--------------------------------------------------------------------------------
/common/templates/common/auth_base.html:
--------------------------------------------------------------------------------
1 | {% load static %}
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 | {% block title %}
15 | Waiting to start update...
12 | {% else %} 13 |{{ update.progress_message }}
14 | {% endif %} 15 |
16 |
17 |
18 |
19 | 20 | Cancel Update 21 |
37 |
61 |
62 | {% endblock %}
63 |
--------------------------------------------------------------------------------
/fireroad/urls.py:
--------------------------------------------------------------------------------
1 | """fireroad URL Configuration
2 |
3 | The `urlpatterns` list routes URLs to views. For more information please see:
4 | https://docs.djangoproject.com/en/2.0/topics/http/urls/
5 | Examples:
6 | Function views
7 | 1. Add an import: from my_app import views
8 | 2. Add a URL to urlpatterns: path('', views.home, name='home')
9 | Class-based views
10 | 1. Add an import: from other_app.views import Home
11 | 2. Add a URL to urlpatterns: path('', Home.as_view(), name='home')
12 | Including another URLconf
13 | 1. Import the include() function: from django.urls import include, path
14 | 2. Add a URL to urlpatterns: path('blog/', include('blog.urls'))
15 | """
16 | from django.conf.urls import url, include
17 | from django.contrib.admin.views.decorators import staff_member_required
18 | from django.views.generic.base import RedirectView
19 | from django.contrib import admin
20 | from common.views import dev_login
21 | from django.conf import settings
22 |
23 | # admin.autodiscover()
24 | # admin.site.login = staff_member_required(admin.site.login, login_url=settings.LOGIN_URL)
25 |
26 | urlpatterns = [
27 | url(r'courses/', include('catalog.urls')),
28 | url(r'courseupdater/', include('courseupdater.urls')),
29 | url(r'recommend/', include('recommend.urls')),
30 | url(r'admin/', admin.site.urls),
31 | url(r'sync/', include('sync.urls')),
32 | url(r'analytics/', include('analytics.urls')),
33 | url(r'requirements/', include('requirements.urls')),
34 | url(r'', include('common.urls')),
35 | ]
36 |
37 | # Redirect to the appropriate login page if one is specified in the settings module
38 | if settings.LOGIN_URL:
39 | if settings.LOGIN_URL.strip("/") != 'dev_login':
40 | urlpatterns.insert(0, url(r'^admin/login/$', RedirectView.as_view(url=settings.LOGIN_URL,
41 | permanent=True,
42 | query_string=True)))
43 | urlpatterns.insert(0, url(r'^dev_login/$', RedirectView.as_view(url=settings.LOGIN_URL,
44 | permanent=True,
45 | query_string=True)))
46 | if settings.LOGIN_URL.strip("/") != 'login':
47 | urlpatterns.insert(0, url(r'^login/$', RedirectView.as_view(url=settings.LOGIN_URL,
48 | permanent=True,
49 | query_string=True)))
50 |
51 |
52 |
--------------------------------------------------------------------------------
/requirements/templates/requirements/review.html:
--------------------------------------------------------------------------------
1 | {% extends "requirements/base.html" %}
2 | {% block title %}
3 |
38 |
55 |
39 |
40 |
50 |
54 | 40 |
Light your path through MIT with FireRoad.
41 |FireRoad is the new best way to plan your path through MIT. Plan for both the upcoming semester and the years ahead, all in one place. You can view up-to-date course requirements and add them directly to your roads, and browse subjects by any criteria. FireRoad even learns from your selections to recommend other subjects you might be interested in!
42 |
43 |
48 |
49 | 50 |
51 | Created by Venkatesh Sivaraman, MIT 2020.
52 |
53 |
56 |
60 |
57 | 
58 |
59 |
7 |
19 |
8 |
10 | {% if edit_req.type == "Create" %}
11 | Edit
12 | {% else %}
13 | {% if edit_req.list_id %}
14 | Edit
15 | {% endif %}
16 | {% endif %}
17 | Preview
18 | {{ action }} {{ medium_title }}
9 |
20 |
21 |
35 | {% autoescape off %}{{ diff }}{% endautoescape %}
22 |
23 |
24 |
34 |
25 |
33 |
26 |
27 |
28 |
29 |
30 |
31 |
32 |
36 |
49 | {% endblock %}
50 | {% block scripts %}
51 |
57 | {% endblock %}
58 |
--------------------------------------------------------------------------------
/common/urls.py:
--------------------------------------------------------------------------------
1 | from django.conf.urls import url
2 |
3 | from . import views
4 |
5 | from django.views.generic import TemplateView
6 | from django.contrib.auth.views import logout
7 |
8 | urlpatterns = [
9 | url('verify/', views.verify, name='verify'),
10 | url('new_user/', views.new_user, name='new_user'),
11 | url('signup/', views.signup, name='signup'),
12 | url('^login/', views.login_oauth, name='login'),
13 | url('^dev_login/', views.dev_login, name='dev_login'),
14 | url('login_touchstone/', views.login_touchstone, name='login_touchstone'),
15 | url('logout/', logout, {'next_page': 'index'}, name='logout'),
16 | url('set_semester/', views.set_semester, name='set_semester'),
17 | url('prefs/favorites/', views.favorites, name='favorites'),
18 | url('prefs/set_favorites/', views.set_favorites, name='set_favorites'),
19 | url('prefs/progress_overrides/', views.progress_overrides, name='progress_overrides'),
20 | url('prefs/set_progress_overrides/', views.set_progress_overrides, name='set_progress_overrides'),
21 | url('prefs/notes/', views.notes, name='notes'),
22 | url('prefs/set_notes/', views.set_notes, name='set_notes'),
23 | url('prefs/custom_courses/', views.custom_courses, name='custom_courses'),
24 | url('prefs/set_custom_course/', views.set_custom_course, name='set_custom_course'),
25 | url('prefs/remove_custom_course/', views.remove_custom_course, name='remove_custom_course'),
26 | url('decline/', TemplateView.as_view(template_name='common/decline.html'), name='decline'),
27 | url('fetch_token/', views.fetch_token, name='fetch_token'),
28 | url('user_info/', views.user_info, name='user_info'),
29 | url('^disapprove_client/', views.approval_page_failure, name='approval_page_failure'),
30 | url('^approve_client/', views.approval_page_success, name='approval_page_success'),
31 |
32 | # reference
33 | url('reference/$', TemplateView.as_view(template_name='common/docs/overview.html'), name='overview'),
34 | url('reference/auth', TemplateView.as_view(template_name='common/docs/auth.html'), name='auth'),
35 | url('reference/catalog', TemplateView.as_view(template_name='common/docs/catalog.html'), name='catalog'),
36 | url('reference/requirements', TemplateView.as_view(template_name='common/docs/requirements.html'), name='requirements'),
37 | url('reference/sync', TemplateView.as_view(template_name='common/docs/sync.html'), name='sync'),
38 | url('reference/recommender', TemplateView.as_view(template_name='common/docs/recommender.html'), name='recommender'),
39 | url('reference/file_formats', TemplateView.as_view(template_name='common/docs/file_formats.html'), name='file_formats'),
40 |
41 | # index
42 | url(r'^$', TemplateView.as_view(template_name='common/index.html'), name='index'),
43 | ]
44 |
--------------------------------------------------------------------------------
/courseupdater/templates/courseupdater/edit_correction.html:
--------------------------------------------------------------------------------
1 | {% extends "common/base.html" %}
2 | {% load static %}
3 | {% block title %}
4 |
37 |
40 |
48 | Edit request submitted by {{ edit_req.email_address|urlize }} on {{ edit_req.timestamp|date:'M d Y' }}.
38 |Reason: {{ edit_req.reason|urlize }}
39 |
11 |
59 | {% endblock %}
60 |
61 | {% block pagescripts %}
62 |
63 | {% endblock %}
64 |
--------------------------------------------------------------------------------
/analytics/models.py:
--------------------------------------------------------------------------------
1 | from django.db import models
2 | from django.utils import timezone
3 |
4 | class RequestCount(models.Model):
5 | """Keeps track of a single request."""
6 |
7 | path = models.CharField(max_length=50, null=True)
8 | timestamp = models.DateTimeField(auto_now_add=True, db_index=True)
9 | user_agent = models.CharField(max_length=150, null=True)
10 | is_authenticated = models.BooleanField(default=False)
11 | student_unique_id = models.CharField(max_length=50, null=True)
12 | student_semester = models.CharField(max_length=25, null=True)
13 |
14 | def __str__(self):
15 | return "{} by {} at {}{}".format(
16 | self.path,
17 | self.user_agent,
18 | self.timestamp,
19 | " (logged in)" if self.is_authenticated else ""
20 | )
21 |
22 | @staticmethod
23 | def tabulate_requests(early_time, interval=None, attribute_func=None, distinct_users=False):
24 | """Retrieves request counts from the given time to present,
25 | bucketed by the given interval.
26 |
27 | Args:
28 | early_time: A timezone.datetime object indicating the minimum time
29 | to retrieve requests for.
30 | interval: A timezone.timedelta object indicating the period of time
31 | spanned by each returned bucket. If None, counts all requests
32 | together and returns a single dictionary.
33 | attribute_func: A function taking a RequestCount and returning a
34 | value to tabulate for each bucket.
35 | distinct_users: If True, count only one request per unique user.
36 |
37 | Returns:
38 | A list of tuples (time, dict), where time is a timezone.datetime
39 | object indicating the start time of the bucket, and dict is a
40 | dictionary mapping values returned by attribute_func to their
41 | counts in the bucket.
42 | """
43 | now = timezone.now()
44 | buckets = []
45 | if interval:
46 | curr = early_time
47 | while curr < now:
48 | buckets.append((curr, {}))
49 | curr += interval
50 | else:
51 | buckets.append((early_time, {}))
52 |
53 | seen_users = set()
54 | for request in RequestCount.objects.filter(timestamp__gte=early_time).iterator():
55 | if distinct_users and (not request.student_unique_id or request.student_unique_id in seen_users):
56 | continue
57 | seen_users.add(request.student_unique_id)
58 | for time, bucket in buckets:
59 | if request.timestamp >= time and (not interval or request.timestamp < time + interval):
60 | value = attribute_func(request) if attribute_func else None
61 | bucket[value] = bucket.get(value, 0) + 1
62 | break
63 |
64 | if not interval:
65 | return buckets[0][1]
66 | return buckets
67 |
--------------------------------------------------------------------------------
/recommend/views.py:
--------------------------------------------------------------------------------
1 | from django.shortcuts import render, redirect
2 | from django.http import HttpResponse, HttpResponseBadRequest
3 | from django.views.decorators.csrf import csrf_exempt
4 | from .models import *
5 | from common.models import *
6 | import random
7 | from django.contrib.auth import login, authenticate, logout
8 | from django.core.exceptions import PermissionDenied
9 | from common.decorators import logged_in_or_basicauth, require_token_permissions
10 | import json
11 | from django.utils import timezone
12 | from dateutil.relativedelta import relativedelta
13 |
14 | def update_rating(user, subject_id, value):
15 | Rating.objects.filter(user=user, subject_id=subject_id).delete()
16 |
17 | r = Rating(user=user, subject_id=subject_id, value=value)
18 | r.save()
19 |
20 | @logged_in_or_basicauth
21 | @require_token_permissions("can_view_recommendations")
22 | def get(request):
23 | rec_type = request.GET.get('t', '')
24 | if len(rec_type) == 0:
25 | recs = Recommendation.objects.filter(user=request.user)
26 | else:
27 | recs = Recommendation.objects.filter(user=request.user, rec_type=rec_type)
28 | if recs.count() == 0:
29 | return HttpResponse('No recommendations yet. Try again tomorrow!')
30 | resp = {rec.rec_type: json.loads(rec.subjects) for rec in recs}
31 | return HttpResponse(json.dumps(resp), content_type="application/json")
32 |
33 | @csrf_exempt
34 | @logged_in_or_basicauth
35 | @require_token_permissions("can_view_recommendations", "can_edit_student_info")
36 | def rate(request):
37 | batch = request.body
38 | if len(batch) > 0:
39 | batch_items = json.loads(batch)
40 | for item in batch_items:
41 | try:
42 | value = int(item['v'])
43 | if item['s'] == None or len(item['s']) > 10:
44 | return HttpResponseBadRequest('
12 |
19 |
58 |
13 |
15 | {% if is_new %}New Correction{% else %}Edit Correction{% endif %}
14 |
16 |
18 | Enter a subject ID and values for the fields that you would like to modify. Original values from the catalog parser will be used for any fields left blank. Hint: You can use the '*' character in the subject ID to match any number in a position.
17 |Missing subject ID
') 45 | if value is None: 46 | return HttpResponseBadRequest('Missing rating value
') 47 | update_rating(request.user, item['s'], value) 48 | except: 49 | return HttpResponseBadRequest('Bad input
') 50 | resp = { 'received': True } 51 | else: 52 | subject_id = request.POST.get('s', '') 53 | value = request.POST.get('v', '') 54 | try: 55 | value = int(value) 56 | if subject_id == None or len(subject_id) == 0 or len(subject_id) > 10: 57 | return HttpResponseBadRequest('Missing subject ID
') 58 | if value is None: 59 | return HttpResponseBadRequest('Missing rating value
') 60 | if request.user.username != str(user_id): 61 | raise PermissionDenied 62 | update_rating(request.user, subject_id, value) 63 | resp = { 'u': request.user.username, 's': subject_id, 'v': value, 'received': True } 64 | except: 65 | return HttpResponseBadRequest('Bad input
') 66 | return HttpResponse(json.dumps(resp), content_type="application/json") 67 | -------------------------------------------------------------------------------- /requirements/static/requirements/css/editor.css: -------------------------------------------------------------------------------- 1 | .editor { 2 | resize: none; 3 | border: none; 4 | display: table-cell; 5 | flex: 1; /* same as flex: 1 1 auto; */ 6 | } 7 | .code, .editor { 8 | font-family: 'Inconsolata', Menlo, Monaco, Courier, monospace; 9 | line-height: 1.5em; 10 | } 11 | .code { 12 | padding: 2px; 13 | } 14 | .editor-card { 15 | width: 100%; 16 | padding: 8px; 17 | display: flex; 18 | flex-direction: column; 19 | } 20 | .editor-card { 21 | flex-grow: 1; 22 | margin-bottom: 32px !important; 23 | } 24 | .content { 25 | margin-left: 32px; 26 | margin-right: 32px; 27 | display: flex; 28 | flex-direction: column; 29 | margin-bottom: 12px; 30 | } 31 | .content-full-screen { 32 | margin-left: 32px; 33 | margin-right: 32px; 34 | display: flex; 35 | flex-direction: column; 36 | margin-bottom: 12px; 37 | } 38 | @media (min-width: 767px) { 39 | .edit-head { 40 | margin-top: 12px; 41 | } 42 | .content { 43 | margin-top: -64px; 44 | padding-top: 64px; 45 | } 46 | .content-full-screen { 47 | margin-top: -64px; 48 | padding-top: 64px; 49 | } 50 | } 51 | .mbtn:hover { 52 | color: #940404; 53 | text-decoration: none; 54 | } 55 | .input-field:focus { 56 | border-bottom: 1px solid #a10000 !important; 57 | box-shadow: 0 1px 0 0 #a10000 !important; 58 | } 59 | ::-webkit-input-placeholder { color: #996767 !important; } 60 | :-moz-placeholder { /* Firefox 18- */ color: #996767 !important; } 61 | ::-moz-placeholder { /* Firefox 19+ */ color: #996767 !important; } 62 | :-ms-input-placeholder { color: #996767 !important; } 63 | 64 | .real-ul > li { 65 | margin-left: 20px !important; 66 | list-style-type: square !important; 67 | } 68 | 69 | ::selection { 70 | background-color: #f46565; 71 | } 72 | 73 | body, html, .content, .content-full-screen { 74 | height: 100%; 75 | } 76 | 77 | .diff-line { 78 | margin-bottom: -8px; 79 | word-wrap: break-word; 80 | } 81 | 82 | .insertion { 83 | color: rgb(48, 162, 93); 84 | background-color: rgba(82, 213, 134, 0.2); 85 | padding: 2px; 86 | border-radius: 2px; 87 | } 88 | 89 | .deletion { 90 | color: rgb(179, 32, 1); 91 | background-color: rgba(210, 47, 12, 0.2); 92 | padding: 2px; 93 | border-radius: 2px; 94 | text-decoration: line-through; 95 | } 96 | 97 | .edit-req-list-card { 98 | width: 100%; 99 | padding: 8px; 100 | display: flex; 101 | flex-direction: column; 102 | flex-grow: 1; 103 | } 104 | 105 | .edit-req-list-row { 106 | display: flex; 107 | flex-direction: row; 108 | overflow: hidden; 109 | } 110 | 111 | .edit-req-list-left { 112 | display: flex; 113 | flex-direction: column; 114 | width: 50%; 115 | margin-right: 12px; 116 | } 117 | 118 | .edit-req-list-right { 119 | display: flex; 120 | flex-direction: column; 121 | width: 50%; 122 | } 123 | 124 | .edit-req-list { 125 | overflow-y: scroll !important; 126 | } 127 | 128 | .edit-req-list > .collection-item:hover { 129 | background-color: #eeeeee; 130 | -webkit-transition: background-color 250ms linear; 131 | -ms-transition: background-color 2500ms linear; 132 | transition: background-color 250ms linear; 133 | } 134 | -------------------------------------------------------------------------------- /catalog_parse/utils/parse_evaluations.py: -------------------------------------------------------------------------------- 1 | import re 2 | from .catalog_constants import * 3 | import json 4 | import requests 5 | 6 | class EvaluationConstants: 7 | rating = "rating" 8 | term = "term" 9 | in_class_hours = "ic_hours" 10 | out_of_class_hours = "oc_hours" 11 | eligible_raters = "eligible" 12 | responded_raters = "resp" 13 | iap_term = "JA" 14 | 15 | KEYS_TO_AVERAGE = { 16 | EvaluationConstants.rating: CourseAttribute.averageRating, 17 | EvaluationConstants.in_class_hours: CourseAttribute.averageInClassHours, 18 | EvaluationConstants.out_of_class_hours: CourseAttribute.averageOutOfClassHours, 19 | EvaluationConstants.eligible_raters: CourseAttribute.enrollment 20 | } 21 | 22 | def load_evaluation_data(eval_path): 23 | """ 24 | Reads evaluation data from the given .js file. 25 | """ 26 | 27 | with open(eval_path, 'r') as file: 28 | eval_contents = file.read() 29 | begin_range = eval_contents.find("{") 30 | end_range = eval_contents.rfind(";") 31 | return json.loads(eval_contents[begin_range:end_range]) 32 | 33 | def parse_evaluations(evals, courses): 34 | """ 35 | Adds attributes to each course based on eval data in the given dictionary. 36 | """ 37 | for i, course in courses.iterrows(): 38 | # i is the index of the DataFrame, which is the subject ID 39 | subject_ids = list(filter(None, [i, course[CourseAttribute.oldID]])) 40 | if not any(x in evals for x in subject_ids): 41 | continue 42 | 43 | averaging_data = {} 44 | for subject_id in subject_ids: 45 | if subject_id not in evals: 46 | continue 47 | for term_data in evals[subject_id]: 48 | # if course is offered fall/spring but an eval is for IAP, ignore 49 | if (EvaluationConstants.iap_term in term_data[EvaluationConstants.term] and 50 | (course[CourseAttribute.offeredFall] == "Y" or 51 | course[CourseAttribute.offeredSpring] == "Y")): 52 | continue 53 | # if no respondents, ignore 54 | if term_data[EvaluationConstants.responded_raters] == 0: 55 | continue 56 | 57 | for key in KEYS_TO_AVERAGE: 58 | if key not in term_data: 59 | continue 60 | value = term_data[key] 61 | # Get which academic year this is, so that we can weight 62 | # appropriately in the average 63 | year = int(term_data[EvaluationConstants.term][:-2]) 64 | averaging_data.setdefault(key, []).append((value, year)) 65 | 66 | for eval_key, course_key in KEYS_TO_AVERAGE.items(): 67 | if eval_key not in averaging_data: continue 68 | values = [value for value, year in averaging_data[eval_key]] 69 | max_year = max(year for value, year in averaging_data[eval_key]) 70 | weights = [0.5 ** (max_year - year) 71 | for value, year in averaging_data[eval_key]] 72 | total = sum(v * w for v, w in zip(values, weights)) 73 | average = total / sum(weights) 74 | course.loc[course_key] = "{:.2f}".format(average) 75 | -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | # FireRoad Server 2 | 3 | FireRoad is an iOS/Android application that allows MIT students to plan their course selections, view up-to-date major/minor requirements, and discover new courses. The FireRoad Server is a Django server that provides a data backend and document "cloud" for the native apps as well as the web-based CourseRoad application. 4 | 5 | ## Cloning and Setup 6 | 7 | Follow these instructions to set up and run your own instance of the FireRoad server. You may want to create a new virtual environment using `conda`, for example: 8 | 9 | ``` 10 | conda create -n fireroad python=2.7 11 | conda activate fireroad 12 | ``` 13 | 14 | Then, enter the repo directory and run the setup script, which will install any necessary packages and set up the database. 15 | 16 | ``` 17 | cd fireroad-server 18 | ./setup.sh 19 | ``` 20 | 21 | To set up a catalog (including courses and requirements lists): 22 | 23 | ``` 24 | ./setup_catalog.sh 25 | ``` 26 | 27 | This script will prompt you to download a copy of the course catalog from the [prod site](https://fireroad.mit.edu/courseupdater/download_data) if you have not already. Otherwise, you can run the catalog setup script without pre-initialized catalogs, then run the scraper yourself following the instructions in `data/readme.md`. 28 | 29 | ## Running the Server 30 | 31 | To run the server (with the conda environment activated), use 32 | 33 | ``` 34 | python manage.py runserver 35 | ``` 36 | 37 | By default, the server runs on port 8000. You can specify a different port by simply adding the port number after the `runserver` command. (The `manage.py` script is [provided by Django](https://docs.djangoproject.com/en/1.11/ref/django-admin/) and provides other useful commands such as migrating the database, collecting static files, and opening an interactive shell.) 38 | 39 | ## Database Settings 40 | 41 | Note that the project contains three Django settings modules: `fireroad/settings.py` (local development), `fireroad/settings_dev.py` (dev server), and `fireroad_settings_prod.py` (prod server). When making changes to the settings, please make sure to change the file appropriate to the environment on which you want the changes to take effect (and note that the latter two import the base `settings.py` file). In order to specify which settings module should be used, you will need to set the `DJANGO_SETTINGS_MODULE` environment variable to `fireroad.settings{VARIANT}`, and change the default value specified in `fireroad/wsgi.py` if deploying with WSGI. 42 | 43 | Depending on your settings, there may be additional files that you can add to enable certain capabilities: 44 | 45 | * To use a MySQL database, add a `fireroad/dbcreds.py` file that specifies the necessary authentication info as Python variables `dbname`, `username`, `password`, and `host`. 46 | * To enable sending emails to admins for unresolved edit requests, etc., create an email address with two-factor authentication disabled (gmail works well). Then add a `fireroad/email_creds.py` file that specifies authentication info as a comma-delimited string with three components: the email server (e.g. `smtp.gmail.com`), the email address, and the password for the email account. 47 | 48 | ## API Endpoints 49 | 50 | The FireRoad API is fully documented at [fireroad.mit.edu/reference](https://fireroad.mit.edu/reference) (dev version at [fireroad-dev.mit.edu/reference](https://fireroad-dev.mit.edu/reference)). When submitting PRs that modify the behavior of these endpoints or add new ones, please update the docs in `common/templates/docs` accordingly. 51 | -------------------------------------------------------------------------------- /requirements/templates/requirements/base.html: -------------------------------------------------------------------------------- 1 | {% extends "common/base.html" %} 2 | {% load static %} 3 | {% block title %} 4 |
61 | {% block content %} {% endblock %}
62 |
63 | {% endblock %}
64 |
65 | {% block pagescripts %}
66 |
74 | {% block scripts %}{% endblock %}
75 | {% endblock %}
76 |
--------------------------------------------------------------------------------
/data/readme.md:
--------------------------------------------------------------------------------
1 | # FireRoad Catalog Data
2 |
3 | FireRoad's functionality depends on managing an up-to-date data source for both course catalogs and requirements. This data is expected to be located in the directory named in the settings file (`fireroad.settings` for local testing, `fireroad.settings_dev` for the dev server, and `fireroad.settings_prod` for the prod server). You can obtain an up-to-date copy of the data through the Django admin menu on either deployed service.
4 |
5 | The catalog data is structured this way (in addition to the database model) for ease of managing specific files corresponding to catalogs or requirements lists; also, the files are statically served for the mobile apps.
6 |
7 | ## Structure
8 |
9 | The catalogs directory should be structured as follows:
10 |
11 | ```
12 | - requirements
13 | - major1.reql
14 | - ...
15 | - sem-fall-2019
16 | - 1.txt
17 | - ...
18 | - sem-spring-2020
19 | - 1.txt
20 | - ...
21 | - ...
22 | - raw
23 | - sem-spring-2020
24 | - 1.txt
25 | - ...
26 | - ...
27 | - deltas
28 | - requirements
29 | - delta-1.txt
30 | - ...
31 | - sem-fall-2019
32 | - delta-1.txt
33 | - ...
34 | - sem-spring-2020
35 | - delta-1.txt
36 | - ...
37 | ```
38 |
39 | The top-level directories contain the data files for `requirements` and semesters (prefixed by `sem-`). The `raw` directory contains intermediate files generated during catalog parse operations (see below). The `deltas` directory contains a directory named for each of those top-level directories, which contains the delta files for each version of the catalog.
40 |
41 | Each delta file is named `delta-[VERSION-NUMBER].txt` and formatted as follows (filenames are listed without extension):
42 |
43 | ```
44 | [SEASON]#,#[YEAR]
45 | [VERSION NUMBER]
46 | [CHANGED FILENAME 1]
47 | [CHANGED FILENAME 2]
48 | ...
49 | ```
50 |
51 | ## Update Scripts
52 |
53 | The course catalog update process is automated and can largely be managed through the web interface. However, because this is a singleton process that must occur outside a single server-client connection, it relies on the external script `update_catalog.py`, which is run as a cron job every few minutes on deployed servers. Similarly, the `update_db.py` script is scheduled to run daily during the early morning, to avoid performing database tasks during normal usage hours.
54 |
55 | You can run these scripts manually in the command line as well. First, set the `DJANGO_SETTINGS_MODULE` environment variable in your terminal:
56 |
57 | ```
58 | export DJANGO_SETTINGS_MODULE="fireroad.settings"
59 | ```
60 |
61 | Then, run the script as directed below.
62 |
63 | ### Catalog Updates
64 |
65 | On a local version, you can easily start this script manually by the command
66 |
67 | ```
68 | python update_catalog.py [SEASON]-[YEAR]
69 | ```
70 |
71 | where `[SEASON]-[YEAR]` specifies the current semester (e.g. `fall-2020` for the fall semester in the calendar year 2020 — note that this does not follow the internal convention of calling the semester `2021fa` because it is in the 2020-21 academic year). Once this script is started, you can navigate to the catalog update page in the UI to watch the progress and review the results. When it is finished, you will need to click Deploy Update. Finally, run the database update script:
72 |
73 | ```
74 | python update_db.py
75 | ```
76 |
77 | Note that each of these scripts may take several minutes to run.
78 |
79 | ### Requirements Updates
80 |
81 | Requirements list updating follows a similar process to the course catalog, except that updates are entered manually instead of scraped. Therefore, you can create and edit the requirements lists directly in the Requirements Editor, deploy them, and then run the database update script:
82 |
83 | ```
84 | python update_db.py
85 | ```
86 |
--------------------------------------------------------------------------------
/common/token_gen.py:
--------------------------------------------------------------------------------
1 | import jwt
2 | import json
3 | import os
4 | from django.contrib.auth.models import User
5 | from django.conf import settings
6 | from django.utils.dateparse import parse_datetime
7 | from django.utils.timezone import is_aware, make_aware
8 | from django.utils import timezone
9 | import datetime
10 | from oauth_client import generate_random_string, LOGIN_TIMEOUT
11 | from .models import TemporaryCode, APIClient
12 | from django.core.exceptions import PermissionDenied
13 |
14 | FIREROAD_ISSUER = 'com.base12innovations.fireroad-server'
15 |
16 | def get_aware_datetime(date_str):
17 | ret = parse_datetime(date_str)
18 | if not is_aware(ret):
19 | ret = make_aware(ret)
20 | return ret
21 |
22 | def generate_token(request, user, expire_time, api_client=None):
23 | """Generates a JWT token for the given user that expires after the given
24 | number of seconds."""
25 | expiry_date = str(timezone.now() + datetime.timedelta(seconds=expire_time))
26 | # Specify which permissions this access token is allowed to authorize.
27 | # If no API client is given to this method, a universal permission is granted (this
28 | # corresponds to the mobile app use case!)
29 | payload = {
30 | 'username': user.username,
31 | 'permissions': (api_client.permissions_flag() if api_client else
32 | APIClient.universal_permission_flag()),
33 | 'iss': FIREROAD_ISSUER,
34 | 'expires': expiry_date
35 | }
36 | encoded = jwt.encode(payload, settings.SECRET_KEY, algorithm='HS256')
37 | return encoded
38 |
39 | def extract_token_info(request, token):
40 | """Decodes the given JWT token and determines if it is valid. If so, returns
41 | the user associated with that token, an integer flag representing the permissions granted,
42 | and an error object of None. If not, returns None, None, and a dictionary explaining the error."""
43 | try:
44 | payload = jwt.decode(token, settings.SECRET_KEY, algorithms=['HS256'])
45 | except:
46 | return None, None, {'error': 'decode_error', 'error_description': 'The token could not be decoded'}
47 | try:
48 | if payload['iss'] != FIREROAD_ISSUER:
49 | return None, None, {'error': 'invalid_issuer', 'error_description': 'The issuer of this token does not have the correct value'}
50 | date = get_aware_datetime(payload['expires'])
51 | if date < timezone.now():
52 | return None, None, {'error': 'expired', 'error_description': 'The token has expired'}
53 | username = payload['username']
54 |
55 | permissions = payload['permissions']
56 | except KeyError:
57 | return None, None, {'error': 'incomplete_token', 'error_description': 'The token is missing one or more keys'}
58 |
59 | try:
60 | user = User.objects.get(username=username)
61 | except:
62 | return None, None, {'error': 'invalid_user', 'error_description': 'The token represents a non-existent user'}
63 |
64 | return user, permissions, None
65 |
66 | def save_temporary_code(access_info):
67 | """Generates, saves, and returns a temporary code associated with the
68 | given access information JSON object."""
69 |
70 | code_storage = TemporaryCode.objects.create(access_info=json.dumps(access_info), code=generate_random_string(80))
71 | code_storage.save()
72 | return code_storage.code
73 |
74 | def get_access_info_with_temporary_code(code):
75 | """Validates the given temporary code and retrieves the access info associated
76 | with it as a JSON object, deleting the code storage afterward. Raises
77 | PermissionDenied if the code is not found or is expired."""
78 |
79 | try:
80 | code_storage = TemporaryCode.objects.get(code=code)
81 | expiry_date = code_storage.date + datetime.timedelta(seconds=LOGIN_TIMEOUT)
82 | if expiry_date < timezone.now():
83 | raise PermissionDenied
84 | ret = json.loads(code_storage.access_info)
85 | code_storage.delete()
86 | return ret
87 | except:
88 | raise PermissionDenied
89 |
--------------------------------------------------------------------------------
/requirements/static/requirements/css/req_preview.css:
--------------------------------------------------------------------------------
1 | #preview {
2 | overflow: scroll;
3 | padding: 0 6px 6px 6px;
4 | }
5 |
6 | #preview-loading-ind {
7 | position: absolute;
8 | margin: auto;
9 | left: 0;
10 | right: 0;
11 | top: 0;
12 | bottom: 0;
13 | }
14 |
15 | .req-title {
16 | margin-top: 4px !important;
17 | }
18 |
19 | h3.req-title {
20 | padding-left: 6px;
21 | font-size: 14pt;
22 | font-weight: 700;
23 | }
24 |
25 | h4.req-title {
26 | padding-left: 6px;
27 | font-size: 12pt;
28 | font-weight: 600;
29 | }
30 |
31 | h1.req-title {
32 | padding-left: 6px;
33 | font-size: 18pt;
34 | font-weight: 800;
35 | }
36 |
37 | h2.req-title {
38 | padding-left: 6px;
39 | font-size: 16pt;
40 | font-weight: 700;
41 | }
42 |
43 | p.req {
44 | padding-left: 6px;
45 | color: #888;
46 | }
47 |
48 | .course-list {
49 | overflow-x: auto;
50 | overflow-y: visible;
51 | white-space: nowrap;
52 | width: 100%;
53 | }
54 |
55 | .course-list-inner {
56 | display: table-row;
57 | overflow-y: visible;
58 | }
59 |
60 | .course-tile-outer {
61 | top: 0;
62 | overflow-y: visible;
63 | display: table-cell;
64 | padding: 2px 8px 2px 8px;
65 | }
66 |
67 | .course-tile {
68 | display: block;
69 | text-align: center;
70 | white-space: normal;
71 | overflow: hidden;
72 | padding: 6px;
73 | width: 140px;
74 | height: 76px;
75 | line-height: 1.15em;
76 | }
77 |
78 | .course-id {
79 | font-weight: 200;
80 | font-size: 13pt;
81 | }
82 |
83 | .course-title {
84 | font-weight: 400;
85 | font-size: 9pt;
86 | }
87 |
88 | /* Department classes */
89 |
90 | .course-none { background-color: #999 !important; }
91 |
92 | .course-1 { background-color: #DE4343 !important; }
93 | .course-2 { background-color: #DE7643 !important; }
94 | .course-3 { background-color: #4369DE !important; }
95 | .course-4 { background-color: #57B563 !important; }
96 | .course-5 { background-color: #43DEAF !important; }
97 | .course-6 { background-color: #4390DE !important; }
98 | .course-7 { background-color: #5779B5 !important; }
99 | .course-8 { background-color: #8157B5 !important; }
100 | .course-9 { background-color: #8143DE !important; }
101 | .course-10 { background-color: #B55757 !important; }
102 | .course-11 { background-color: #B55773 !important; }
103 | .course-12 { background-color: #43DE4F !important; }
104 | .course-14 { background-color: #DE9043 !important; }
105 | .course-15 { background-color: #B55C57 !important; }
106 | .course-16 { background-color: #43B2DE !important; }
107 | .course-17 { background-color: #DE43B7 !important; }
108 | .course-18 { background-color: #575DB5 !important; }
109 | .course-20 { background-color: #57B56E !important; }
110 | .course-21 { background-color: #57B567 !important; }
111 | .course-21A { background-color: #57B573 !important; }
112 | .course-21W { background-color: #57B580 !important; }
113 | .course-CMS { background-color: #57B58C !important; }
114 | .course-21G { background-color: #57B599 !important; }
115 | .course-21H { background-color: #57B5A5 !important; }
116 | .course-21L { background-color: #57B5B2 !important; }
117 | .course-21M { background-color: #57ACB5 !important; }
118 | .course-WGS { background-color: #579FB5 !important; }
119 | .course-22 { background-color: #B55757 !important; }
120 | .course-24 { background-color: #7657B5 !important; }
121 | .course-CC { background-color: #4FDE43 !important; }
122 | .course-CSB { background-color: #579AB5 !important; }
123 | .course-EC { background-color: #76B557 !important; }
124 | .course-EM { background-color: #576EB5 !important; }
125 | .course-ES { background-color: #5A57B5 !important; }
126 | .course-HST { background-color: #5779B5 !important; }
127 | .course-IDS { background-color: #57B586 !important; }
128 | .course-MAS { background-color: #57B55A !important; }
129 | .course-SCM { background-color: #57B573 !important; }
130 | .course-STS { background-color: #8F57B5 !important; }
131 | .course-SWE { background-color: #B56B57 !important; }
132 | .course-SP { background-color: #4343DE !important; }
133 |
--------------------------------------------------------------------------------
/sync/models.py:
--------------------------------------------------------------------------------
1 | from django.db import models
2 | from django.contrib.auth.models import User
3 | from django.forms import ModelForm
4 |
5 | road_compressions = {
6 | ('"overrideWarnings":', '"ow":'),
7 | ('"semester":', '"sm":'),
8 | ('"title":', '"t":'),
9 | ('"units":', '"u":')
10 | }
11 |
12 | schedule_compressions = {
13 | ('"selectedSubjects":', '"ssub":'),
14 | ('"selectedSections":', '"ssec":'),
15 | ('"allowedSections":', '"as":'),
16 | }
17 |
18 | class Road(models.Model):
19 | user = models.ForeignKey(User, null=True, on_delete=models.CASCADE)
20 | name = models.CharField(max_length=50)
21 | contents = models.TextField()
22 | modified_date = models.DateTimeField(auto_now=True)
23 | last_agent = models.CharField(max_length=50, default="")
24 |
25 | def __str__(self):
26 | return "{}: {}, last modified {}".format(self.user.username, self.name.encode('utf-8'), self.modified_date)
27 |
28 | @staticmethod
29 | def compress(road_text):
30 | road_text = road_text.replace("\n", "")
31 | road_text = road_text.replace("\t", "")
32 | road_text = road_text.replace('" : ', '":')
33 | for expr, sub in road_compressions:
34 | road_text = road_text.replace(expr, sub)
35 | return road_text
36 |
37 | @staticmethod
38 | def expand(road_text):
39 | for expr, sub in road_compressions:
40 | road_text = road_text.replace(sub, expr)
41 | return road_text
42 |
43 | class RoadForm(ModelForm):
44 | class Meta:
45 | model = Road
46 | fields = ['name', 'contents']
47 |
48 | class RoadBackup(models.Model):
49 | """Represents a timestamped snapshot of a particular road."""
50 | document = models.ForeignKey(Road, null=True, on_delete=models.CASCADE)
51 | timestamp = models.DateTimeField()
52 | last_agent = models.CharField(max_length=50, default="")
53 | name = models.CharField(max_length=50)
54 | contents = models.TextField()
55 |
56 | def __str__(self):
57 | return "Backup of {}, saved {} by {}".format(self.document.name.encode("utf-8") if self.document else "Invalid request
') 28 | 29 | # Extract POST contents 30 | 31 | id = form_contents.get('id', 0) 32 | if id is None or id == 0: 33 | id = NEW_FILE_ID 34 | else: 35 | try: 36 | id = int(id) 37 | except ValueError: 38 | return HttpResponseBadRequest('Invalid ID
') 39 | 40 | contents = form_contents.get('contents', {}) 41 | if contents is None or len(contents) == 0: 42 | return None, HttpResponseBadRequest('Missing contents
') 43 | 44 | change_date = get_datetime(form_contents, 'changed') 45 | if change_date is None: 46 | return None, HttpResponseBadRequest('Missing or invalid changed date
') 47 | 48 | down_date = get_datetime(form_contents, 'downloaded') 49 | name = form_contents.get('name', '') 50 | agent = form_contents.get('agent', ANONYMOUS_AGENT) 51 | override = form_contents.get('override', False) 52 | 53 | return SyncOperation(id, name, contents, change_date, down_date, agent, override_conflict=override), None 54 | 55 | def delete_helper(request, model_cls): 56 | try: 57 | form_contents = json.loads(request.body) 58 | except: 59 | return None, HttpResponseBadRequest('Invalid request
') 60 | 61 | # Extract POST contents 62 | 63 | id = form_contents.get('id', 0) 64 | if id is None or id == 0: 65 | return HttpResponseBadRequest('Missing file ID
') 66 | try: 67 | id = int(id) 68 | except ValueError: 69 | return HttpResponseBadRequest('Invalid file ID
') 70 | 71 | resp = delete(request, model_cls, id) 72 | return HttpResponse(json.dumps(resp), content_type="application/json") 73 | 74 | @csrf_exempt 75 | @logged_in_or_basicauth 76 | @require_token_permissions("can_edit_roads") 77 | def sync_road(request): 78 | operation, err_resp = get_operation(request) 79 | if operation is None: 80 | return err_resp 81 | 82 | resp = sync(request, Road, operation) 83 | return HttpResponse(json.dumps(resp), content_type="application/json") 84 | 85 | @logged_in_or_basicauth 86 | @require_token_permissions("can_view_roads") 87 | def roads(request): 88 | road_id = request.GET.get('id', None) 89 | 90 | if road_id is not None: 91 | try: 92 | road_id = int(road_id) 93 | except ValueError: 94 | return HttpResponseBadRequest('Invalid road ID
') 95 | 96 | resp = browse(request, Road, road_id) 97 | return HttpResponse(json.dumps(resp), content_type="application/json") 98 | 99 | @csrf_exempt 100 | @logged_in_or_basicauth 101 | @require_token_permissions("can_delete_roads") 102 | def delete_road(request): 103 | return delete_helper(request, Road) 104 | 105 | @csrf_exempt 106 | @logged_in_or_basicauth 107 | @require_token_permissions("can_edit_schedules") 108 | def sync_schedule(request): 109 | operation, err_resp = get_operation(request) 110 | if operation is None: 111 | return err_resp 112 | 113 | resp = sync(request, Schedule, operation) 114 | return HttpResponse(json.dumps(resp), content_type="application/json") 115 | 116 | @logged_in_or_basicauth 117 | @require_token_permissions("can_view_schedules") 118 | def schedules(request): 119 | schedule_id = request.GET.get('id', None) 120 | 121 | if schedule_id is not None: 122 | try: 123 | schedule_id = int(schedule_id) 124 | except ValueError: 125 | return HttpResponseBadRequest('Invalid schedule ID
') 126 | 127 | resp = browse(request, Schedule, schedule_id) 128 | return HttpResponse(json.dumps(resp), content_type="application/json") 129 | 130 | @csrf_exempt 131 | @logged_in_or_basicauth 132 | @require_token_permissions("can_delete_schedules") 133 | def delete_schedule(request): 134 | return delete_helper(request, Schedule) 135 | -------------------------------------------------------------------------------- /requirements/templates/requirements/review_all.html: -------------------------------------------------------------------------------- 1 | {% extends "requirements/base.html" %} 2 | {% block title %} 3 |
7 |
14 |
8 |
13 | Review Edit Requests
9 | {% if deployments > 0 %} 10 |{{ deployments }} deployment{% if deployments != 1 %}s{% endif %} pending execution at the next database refresh.
11 | {% endif %} 12 |
15 |
65 |
16 |
64 |
17 |
40 | Pending Review
18 | {% if pending %} 19 |
20 | {% for edit_req in pending %}
21 |
22 | more_horiz
23 |
24 | {{ edit_req.list_id }}
25 | {{ edit_req.email_address }}: {{ edit_req.reason }} 26 | 27 | 28 |
34 | {% endfor %}
35 |
36 | {% else %}
37 | 25 | {{ edit_req.email_address }}: {{ edit_req.reason }} 26 | 27 | 28 |
-
29 |
- Review... 30 |
- Commit 31 |
- Resolve without Committing 32 |
No pending edit requests!
38 | {% endif %} 39 |
41 |
63 | Committed
42 | {% if committed %} 43 |
44 | {% for edit_req in committed %}
45 |
46 | Uncommit
47 |
48 | {{ edit_req.list_id }}
49 | {{ edit_req.email_address }}: {{ edit_req.reason }} 50 | 51 | 52 | 56 |
57 | {% endfor %}
58 |
59 | {% else %}
60 | 49 | {{ edit_req.email_address }}: {{ edit_req.reason }} 50 | 51 | 52 | 56 |
No changes committed yet.
61 | {% endif %} 62 |
66 |
71 |
94 |
95 | {% endblock %}
96 | {% block scripts %}
97 |
104 | {% endblock %}
105 |
--------------------------------------------------------------------------------
/requirements/templates/requirements/edit.html:
--------------------------------------------------------------------------------
1 | {% extends "requirements/base.html" %}
2 | {% block title %}
3 | Be sure all edit requests are correctly formatted, and add a descriptive change summary before deploying.
67 | {% if conflicts > 0 %}
68 |
You have committed {{ conflicts }} edit request{% if conflicts != 1 %}s{% endif %} that will overwrite a previous pending deployment.
69 | {% endif %}
70 |
7 |
12 |
8 |
10 | Preview
11 | {{ action }} {{ req.medium_title }}
9 |
13 |
14 |
15 |
27 |
16 |
26 |
17 |
25 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
28 | {% if not is_staff %}
29 |
30 |
{% if action == "Create" %}To submit a new requirements list, please enter the requirements in the box above{% else %}To submit a modification request, please identify and/or correct the appropriate location in the above requirements definition{% endif %} (following the rules described in the Format Specification). Then provide your email address (in case of any clarifications) and a brief message explaining the change, and press Submit.