From 3557f36069e12617482500f8a16c7d6aa954ef88 Mon Sep 17 00:00:00 2001 From: lauren Date: Sat, 16 Jan 2021 00:54:37 -0500 Subject: [PATCH] automate study guides --- .gitignore | 1 + Pipfile | 3 +- studyguides/apps/courses/admin.py | 3 +- studyguides/apps/courses/forms.py | 9 +++ .../migrations/0009_auto_20210116_0349.py | 28 +++++++++ studyguides/apps/courses/models.py | 15 ++++- studyguides/apps/courses/urls.py | 5 +- studyguides/apps/courses/views.py | 57 ++++++++++++++++++- studyguides/settings/__init__.py | 5 +- studyguides/templates/add.html | 11 ++++ studyguides/templates/approve.html | 23 ++++++++ studyguides/templates/approve_index.html | 14 +++++ studyguides/templates/base.html | 27 +-------- studyguides/templates/course.html | 2 +- studyguides/templates/head_foot.html | 34 +++++++++++ studyguides/templates/home.html | 2 +- studyguides/templates/subject.html | 2 +- studyguides/templates/tag.html | 2 +- 18 files changed, 206 insertions(+), 37 deletions(-) create mode 100644 studyguides/apps/courses/forms.py create mode 100644 studyguides/apps/courses/migrations/0009_auto_20210116_0349.py create mode 100644 studyguides/templates/add.html create mode 100644 studyguides/templates/approve.html create mode 100644 studyguides/templates/approve_index.html create mode 100644 studyguides/templates/head_foot.html diff --git a/.gitignore b/.gitignore index 7167be7..9463804 100644 --- a/.gitignore +++ b/.gitignore @@ -6,3 +6,4 @@ venv .venv db.sqlite3 media +key.json diff --git a/Pipfile b/Pipfile index 3295efe..191bb3d 100644 --- a/Pipfile +++ b/Pipfile @@ -9,4 +9,5 @@ verify_ssl = true django = "*" social-auth-app-django = "*" pillow = "~=6.0" -whitenoise = "*" \ No newline at end of file +whitenoise = "*" +django-googledrive-storage = "*" \ No newline at end of file diff --git a/studyguides/apps/courses/admin.py b/studyguides/apps/courses/admin.py index c42a08a..815d7a9 100644 --- a/studyguides/apps/courses/admin.py +++ b/studyguides/apps/courses/admin.py @@ -1,8 +1,9 @@ from django.contrib import admin -from .models import Subject, Course, Guide, Tag +from .models import Subject, Course, Guide, Tag, Request # Register your models here. admin.site.register(Subject) admin.site.register(Course) admin.site.register(Guide) admin.site.register(Tag) +admin.site.register(Request) diff --git a/studyguides/apps/courses/forms.py b/studyguides/apps/courses/forms.py new file mode 100644 index 0000000..261639f --- /dev/null +++ b/studyguides/apps/courses/forms.py @@ -0,0 +1,9 @@ +from django import forms + +from .models import Request, Course, Tag + +class StudyGuideRequestForm(forms.Form): + name = forms.CharField(max_length=100) + course = forms.ModelChoiceField(queryset=Course.objects.all()) + tags = forms.ModelMultipleChoiceField(queryset=Tag.objects.all(), required=False) + guide = forms.FileField() diff --git a/studyguides/apps/courses/migrations/0009_auto_20210116_0349.py b/studyguides/apps/courses/migrations/0009_auto_20210116_0349.py new file mode 100644 index 0000000..dff9af5 --- /dev/null +++ b/studyguides/apps/courses/migrations/0009_auto_20210116_0349.py @@ -0,0 +1,28 @@ +# Generated by Django 3.0.6 on 2021-01-16 03:49 + +from django.db import migrations, models +import gdstorage.storage + + +class Migration(migrations.Migration): + + dependencies = [ + ('courses', '0008_auto_20201104_1557'), + ] + + operations = [ + migrations.AlterModelOptions( + name='tag', + options={'ordering': ['url']}, + ), + migrations.CreateModel( + name='Request', + fields=[ + ('id', models.AutoField(primary_key=True, serialize=False)), + ('name', models.CharField(max_length=100, unique=True)), + ('guide', models.FileField(storage=gdstorage.storage.GoogleDriveStorage(), upload_to='guides')), + ('course', models.ManyToManyField(related_name='proposed_course', to='courses.Course')), + ('tags', models.ManyToManyField(related_name='proposed_tags', to='courses.Tag')), + ], + ), + ] diff --git a/studyguides/apps/courses/models.py b/studyguides/apps/courses/models.py index aa57066..54d2637 100644 --- a/studyguides/apps/courses/models.py +++ b/studyguides/apps/courses/models.py @@ -1,6 +1,9 @@ from django.db import models from django.core.validators import RegexValidator, FileExtensionValidator +from gdstorage.storage import GoogleDriveStorage + +gd_storage = GoogleDriveStorage() class Subject(models.Model): id = models.AutoField(primary_key=True) @@ -45,4 +48,14 @@ class Tag(models.Model): ordering = ['url'] def __str__(self): - return self.name \ No newline at end of file + return self.name + +class Request(models.Model): + id = models.AutoField(primary_key=True) + course = models.ManyToManyField("Course", related_name="proposed_course") + tags = models.ManyToManyField("Tag", related_name="proposed_tags") + name = models.CharField(max_length=100, unique=True) + guide = models.FileField(upload_to='guides', storage=gd_storage) + + def __str__(self): + return self.name diff --git a/studyguides/apps/courses/urls.py b/studyguides/apps/courses/urls.py index 72aac31..611e411 100644 --- a/studyguides/apps/courses/urls.py +++ b/studyguides/apps/courses/urls.py @@ -8,5 +8,8 @@ urlpatterns = [ path("subject//", views.subject_view, name="subject_view"), path("tag//", views.tag_view, name="tag"), path("course///", views.course_view, name="course_view"), - path("search/", views.search_view, name="search") + path("search/", views.search_view, name="search"), + path("add/", views.add_view, name="add"), + path("approve-index/", views.approve_index_view, name="approve_index_view"), + path("approve//", views.approve_view, name="approve_view"), ] diff --git a/studyguides/apps/courses/views.py b/studyguides/apps/courses/views.py index 84cf442..fbdca24 100644 --- a/studyguides/apps/courses/views.py +++ b/studyguides/apps/courses/views.py @@ -6,8 +6,13 @@ from django import http from django.shortcuts import render, redirect, reverse, get_object_or_404 from django.db.models import Q from django.contrib.auth.decorators import login_required +from gdstorage.storage import GoogleDriveStorage +from django.core.exceptions import PermissionDenied -from .models import Subject, Course, Guide, Tag +from .models import Subject, Course, Guide, Tag, Request +from .forms import StudyGuideRequestForm + +gd_storage = GoogleDriveStorage() @login_required def subject_view(request, subject_url): @@ -41,6 +46,54 @@ def search_view(request): "tag_results": Tag.objects.filter(reduce(operator.or_, (Q(name__icontains=x) for x in q_list))), "sq": q } - return render(request, 'search_results.html', context=context) + return render(request, "search_results.html", context=context) return redirect(request.META["HTTP_REFERER"]) + +@login_required +def add_view(request): + if request.method == "POST": + form = StudyGuideRequestForm(request.POST, request.FILES) + if form.is_valid(): + r = Request(name=form.cleaned_data["name"]) + r.save() + r.course.add(form.cleaned_data["course"]) + for t in form.cleaned_data["tags"]: + r.tags.add(t) + r.guide = form.cleaned_data["guide"] + r.save() + return redirect(reverse("home:index")) + return render(request, "add.html", context={"form": form}) + else: + form = StudyGuideRequestForm() + return render(request, "add.html", context={"form": form}) + +@login_required +def approve_index_view(request): + if request.user.is_superuser or request.user.is_staff: + return render(request, "approve_index.html", context={"guide_requests": Request.objects.all()}) + raise PermissionDenied + +@login_required +def approve_view(request, request_id): + if request.user.is_superuser or request.user.is_staff: + guide_request = Request.objects.get(id=request_id) + if request.method == "POST": + if request.POST.get("approve"): + guide = Guide(name=guide_request.name) + guide.save() + for t in guide_request.tags.all(): + guide.tags.add(t) + guide.course = guide_request.course.all()[0] + guide.url = guide_request.guide.url + guide.save() + guide_request.delete() + return redirect(reverse("courses:approve_index_view")) + else: + ctx = { + "guide_request": guide_request, + "course": guide_request.course.all()[0], + "tags": guide_request.tags.all() + } + return render(request, "approve.html", context=ctx) + raise PermissionDenied diff --git a/studyguides/settings/__init__.py b/studyguides/settings/__init__.py index d375452..cc52204 100644 --- a/studyguides/settings/__init__.py +++ b/studyguides/settings/__init__.py @@ -40,6 +40,7 @@ INSTALLED_APPS = [ 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles', + 'gdstorage', 'social_django', 'studyguides.apps.courses', 'studyguides.apps.auth', @@ -164,9 +165,7 @@ STATICFILES_DIRS = ( os.path.join(BASE_DIR, 'studyguides/static'), ) -MEDIA_ROOT = os.path.join(BASE_DIR, 'studyguides/media') - -MEDIA_URL = "/media/" +GOOGLE_DRIVE_STORAGE_JSON_KEY_FILE = os.path.join(BASE_DIR, 'studyguides/settings/key.json') USE_X_FORWARDED_HOST = True diff --git a/studyguides/templates/add.html b/studyguides/templates/add.html new file mode 100644 index 0000000..7ecbc56 --- /dev/null +++ b/studyguides/templates/add.html @@ -0,0 +1,11 @@ +{% extends "base.html" %} + +{% load static %} + +{% block content %} +
+ {% csrf_token %} + {{ form.as_p }} + +
+{% endblock %} diff --git a/studyguides/templates/approve.html b/studyguides/templates/approve.html new file mode 100644 index 0000000..e7812a6 --- /dev/null +++ b/studyguides/templates/approve.html @@ -0,0 +1,23 @@ +{% extends "base.html" %} + +{% load static %} + +{% block content %} +
+ {% csrf_token %} + Name: {{ guide_request.name }}

+ Course: {{ course }}

+ Tags: +
    + {% for t in tags %} +
  • + {{ t }} +
    • + {% endfor %} +
+ Guide: {{ guide_request.guide }}
+
+ + +
+{% endblock %} diff --git a/studyguides/templates/approve_index.html b/studyguides/templates/approve_index.html new file mode 100644 index 0000000..166583d --- /dev/null +++ b/studyguides/templates/approve_index.html @@ -0,0 +1,14 @@ +{% extends "base.html" %} + +{% load static %} + +{% block content %} + Click on a guide below to view and approve or reject it. +
    + {% for r in guide_requests %} +
  • + {{ r }} +
    • + {% endfor %} +
+{% endblock %} diff --git a/studyguides/templates/base.html b/studyguides/templates/base.html index d1befde..f2f9edc 100644 --- a/studyguides/templates/base.html +++ b/studyguides/templates/base.html @@ -30,35 +30,14 @@
{% block disclaimer %}{% endblock %} - {% if user.is_authenticated %} -
- - -
-
- {% endif %} + {% block search %}{% endblock %}
{% block path %}{% endblock %}
{% block content %}{% endblock %}
- {% if user.is_authenticated %} -
- {% if user.is_teacher %} - Report a Study Guide - {% elif user.is_superuser or user.is_staff %} - Report a Study Guide - Access Admin Console - {% endif %} - Add Study Guide -
-
-
- Logout -
- {% endif %} + + {% block links %}{% endblock %} diff --git a/studyguides/templates/course.html b/studyguides/templates/course.html index 6d9db13..8b550f4 100644 --- a/studyguides/templates/course.html +++ b/studyguides/templates/course.html @@ -1,4 +1,4 @@ -{% extends "base.html" %} {% load static %} +{% extends "head_foot.html" %} {% load static %} {% block path %} diff --git a/studyguides/templates/head_foot.html b/studyguides/templates/head_foot.html new file mode 100644 index 0000000..11ee007 --- /dev/null +++ b/studyguides/templates/head_foot.html @@ -0,0 +1,34 @@ +{% extends "base.html" %} + +{% load static %} + +{% block search %} + {% if user.is_authenticated %} +
+ + +
+
+ {% endif %} +{% endblock %} + +{% block links %} + {% if user.is_authenticated %} +
+ {% if user.is_teacher %} + Report a Study Guide + {% elif user.is_superuser or user.is_staff %} + Report a Study Guide + Access Admin Console + Approve Study Guides + {% endif %} + Add Study Guide +
+
+
+ Logout +
+ {% endif %} +{% endblock %} diff --git a/studyguides/templates/home.html b/studyguides/templates/home.html index feb95db..f0e60e7 100644 --- a/studyguides/templates/home.html +++ b/studyguides/templates/home.html @@ -1,4 +1,4 @@ -{% extends "base.html" %} {% load static %} +{% extends "head_foot.html" %} {% load static %} {% block disclaimer %}

DISCLAIMER: Please note these materials are student-made study guides over the past years. Some information may be outdated or not 100% reflective of the content your teacher is teaching. It is also possible the information is not 100% accurate. Therefore, make sure to not solely rely on these study guides. If you see an inconsistency in a study guide that confuses you, ask your teacher to clarify. SGA maintains this site but is not liable for the credibility of the information found. To contact SGA, please email SGA.tjhsst@gmail.com. diff --git a/studyguides/templates/subject.html b/studyguides/templates/subject.html index aec460f..eb36811 100644 --- a/studyguides/templates/subject.html +++ b/studyguides/templates/subject.html @@ -1,4 +1,4 @@ -{% extends "base.html" %} {% load static %} +{% extends "head_foot.html" %} {% load static %} {% block path %} diff --git a/studyguides/templates/tag.html b/studyguides/templates/tag.html index c424e2b..e7177f6 100644 --- a/studyguides/templates/tag.html +++ b/studyguides/templates/tag.html @@ -1,4 +1,4 @@ -{% extends "base.html" %} +{% extends "head_foot.html" %} {% load static %}