Add module that allows students to get completion certificate (#3477)

* Add student certificate module

* Fix certificate indentation and table

* Change error to redirect

* Escape program name in certificate

* One more escaped program name

* Add tag to specify which students can get certificates

Co-authored-by: Katherine <[email protected]>

Author: willgearty

esp/esp/program/forms.py

@@ -88,6 +88,7 @@ def __init__(self, *args, **kwargs):
                                                         ('Do students have to apply to individual classes?', [x.id for x in ProgramModule.objects.filter(admin_title__in=['Application Review for Admin', 'Admin Admissions Dashboard'])]),
                                                         ('If yes, can teachers admit them (as opposed to just admins)?', [x.id for x in ProgramModule.objects.filter(admin_title__in=['Teacher Admissions Dashboard', 'Application Reviews for Teachers', 'Application Review for Admin', 'Admin Admissions Dashboard'])]),
                                                         ('Will you have moderators or assistants for individual class sections?', [x.id for x in ProgramModule.objects.filter(admin_title='Moderator Signup')]),
+                                                        ('Do you want students to be able to download a completion certificate after the program ends?', [x.id for x in ProgramModule.objects.filter(admin_title='Student Certificate Module')]),
                                                        ])
         # Include additional or new modules that haven't been added to the list
         for x in ProgramModule.objects.filter(choosable=0):

esp/esp/program/modules/handlers/programprintables.py

@@ -1019,12 +1019,10 @@ def get_msg_vars(self, user, key):
         return u''
 
     @staticmethod
-    def get_student_classlist(program, student):
+    def get_student_classlist(program, student, verbs = ['Enrolled'], valid_only = True):
         # get list of valid classes
-        classes = [ cls for cls in student.getEnrolledSections()]
-        classes = [ cls for cls in classes
-                    if cls.parent_program == program
-                    and cls.isAccepted()                       ]
+        classes = [ cls for cls in student.getSections(program = program, verbs = verbs, valid_only = valid_only)]
+        classes = [ cls for cls in classes if cls.isAccepted() ]
         classes.sort()
         return classes
 
@@ -1053,7 +1051,7 @@ def get_teacher_classlist(program, teacher, teaching = True, moderating = False)
         return scheditems
 
     @staticmethod
-    def getTranscript(program, student, format='text'):
+    def getTranscript(program, student, format='text', verbs = ['Enrolled'], valid_only = True):
         from django.template import Template
         from esp.middleware.threadlocalrequest import AutoRequestContext as Context
 
@@ -1070,7 +1068,7 @@ def getTranscript(program, student, format='text'):
 
         t = get_template(template_filename)
 
-        context = {'classlist': ProgramPrintables.get_student_classlist(program, student)}
+        context = {'classlist': ProgramPrintables.get_student_classlist(program, student, verbs = verbs, valid_only = valid_only)}
 
         return t.render(context)
 
@@ -1713,9 +1711,15 @@ def certificate(self, request, tl, one, two, module, extra, prog):
         else:
             file_type = 'pdf'
 
+        attended = Tag.getProgramTag('student_certificate', prog) == 'class_attendance'
+        if attended:
+            verbs = ['Attended']
+        else:
+            verbs = ['Enrolled']
+
         context = {'user': user, 'prog': prog,
-                    'schedule': ProgramPrintables.getTranscript(prog, user, 'latex'),
-                    'descriptions': ProgramPrintables.getTranscript(prog, user, 'latex_desc')}
+                   'schedule': ProgramPrintables.getTranscript(prog, user, 'latex', verbs, valid_only = (not attended)),
+                   'descriptions': ProgramPrintables.getTranscript(prog, user, 'latex_desc', verbs, valid_only = (not attended))}
 
         return render_to_latex(self.baseDir()+'completion_certificate.tex', context, file_type)
 

esp/esp/program/modules/handlers/studentcertmodule.py

@@ -0,0 +1,102 @@
+
+__author__    = "Individual contributors (see AUTHORS file)"
+__date__      = "$DATE$"
+__rev__       = "$REV$"
+__license__   = "AGPL v.3"
+__copyright__ = """
+This file is part of the ESP Web Site
+Copyright (c) 2012 by the individual contributors
+  (see AUTHORS file)
+The ESP Web Site is free software; you can redistribute it and/or
+modify it under the terms of the GNU Affero 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 Affero General Public License for more details.
+You should have received a copy of the GNU Affero General Public
+License along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+Contact information:
+MIT Educational Studies Program
+  84 Massachusetts Ave W20-467, Cambridge, MA 02139
+  Phone: 617-253-4882
+  Email: [email protected]
+Learning Unlimited, Inc.
+  527 Franklin St, Cambridge, MA 02139
+  Phone: 617-379-0178
+  Email: [email protected]
+"""
+
+from esp.middleware.threadlocalrequest import get_current_request
+from esp.program.modules.base import ProgramModuleObj, main_call, needs_student, meets_cap
+from esp.program.modules.handlers.programprintables import ProgramPrintables
+from esp.program.models import StudentRegistration
+from esp.tagdict.models import Tag
+from esp.users.models import Record
+from esp.utils.latex  import render_to_latex
+
+from datetime import datetime
+
+class StudentCertModule(ProgramModuleObj):
+    doc = """Allows students to download a completion certificate
+             for the program once the program has ended."""
+
+    @classmethod
+    def module_properties(cls):
+        return {
+            "link_title": "Print Completion Certificate",
+            "admin_title": "Student Certificate Module",
+            "module_type": "learn",
+            "required": False,
+            "seq": 999999,
+            "choosable": 0,
+            }
+
+    @main_call
+    @needs_student
+    @meets_cap
+    def certificate(self, request, tl, one, two, module, extra, prog):
+        if not self.isStep():
+            return self.goToCore(tl)
+
+        user = request.user
+
+        if extra:
+            file_type = extra.strip()
+        else:
+            file_type = 'pdf'
+
+        attended = Tag.getProgramTag('student_certificate', prog) == 'class_attendance'
+        if attended:
+            verbs = ['Attended']
+        else:
+            verbs = ['Enrolled']
+
+        context = {'user': user, 'prog': prog,
+                   'schedule': ProgramPrintables.getTranscript(prog, user, 'latex', verbs, valid_only = (not attended)),
+                   'descriptions': ProgramPrintables.getTranscript(prog, user, 'latex_desc', verbs, valid_only = (not attended))}
+
+        return render_to_latex('program/modules/programprintables/completion_certificate.tex', context, file_type)
+
+    def isStep(self):
+        if hasattr(self, 'user'):
+            user = self.user
+        else:
+            request = get_current_request()
+            user = request.user
+        cert_tag = Tag.getProgramTag('student_certificate', self.program)
+        slots = self.program.getTimeSlots()
+        if slots and datetime.now() > max(slots).end:
+            if cert_tag == 'all':
+                return True
+            elif cert_tag == 'program_attendance':
+                return Record.user_completed(user, "attended", self.program)
+            elif cert_tag == 'class_attendance':
+                return StudentRegistration.objects.filter(user = user, section__parent_class__parent_program=self.program, relationship__name = 'Attended').exists()
+        return False
+
+    class Meta:
+        proxy = True
+        app_label = 'modules'

esp/esp/program/modules/migrations/0038_studentcertmodule.py

@@ -0,0 +1,25 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.11.29 on 2022-01-18 20:41
+from __future__ import unicode_literals
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('modules', '0037_medliab_split'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='StudentCertModule',
+            fields=[
+            ],
+            options={
+                'proxy': True,
+                'indexes': [],
+            },
+            bases=('modules.programmoduleobj',),
+        ),
+    ]

esp/esp/tagdict/__init__.py

@@ -1052,6 +1052,18 @@
         'category': 'teach',
         'is_setting': True,
     },
+    'student_certificate': {
+        'is_boolean': False,
+        'help_text': 'Which students will be offered a completion certificate via the student certificate module \
+                      following the end of the program? If based on class attendance, the certificate will be filtered to \
+                      only attended classes (as will the program printable version).',
+        'default': 'program_attendance',
+        'category': 'learn',
+        'is_setting': True,
+        'field': forms.ChoiceField(choices=[('all', 'All students'),
+                                            ('program_attendance', 'Only students who attended the program'),
+                                            ('class_attendance', 'Only students who attended at least one class')]),
+    },
 }
 
 # Dictionary of categories that tags fall into (for grouping on the tag settings page)

esp/templates/outlines/letter_base.tex

@@ -9,6 +9,7 @@
 \usepackage{subfigure}
 \usepackage{boxedminipage}
 \usepackage{wallpaper}
+\usepackage{tabularx}
 
 \ULCornerWallPaper{1}{% templatetag openbrace %}{{ MEDIA_ROOT }}latex_media/letterhead.pdf}
 \pagestyle{empty}

esp/templates/program/modules/programprintables/completion_certificate.tex

@@ -4,32 +4,32 @@
 {% block maincontent %}
 {{ block.super }}
 
-{\bf {\underline {\Large Certificate of Completion \hspace{2.5in} \normalsize {{ prog.niceName }} {{ date_range }} }}} \\
+\noindent {\bf {\underline {\Large Certificate of Completion \hspace{2.5in} \normalsize {{ prog.niceName|texescape }} {{ date_range }} }}} \\
 
 \vspace{0.3in}
 
-This is to certify that \underline{ {{ user.first_name }} {{ user.last_name }} } attended {{ prog.niceName|texescape }} and completed the following classes: \\
+\noindent This is to certify that \underline{% templatetag openbrace %}{{ user.first_name }} {{ user.last_name }}} attended {{ prog.niceName|texescape }} and completed the following classes:
 
-\hspace{1in} {{ schedule }}
+\vspace{0.25in} {{ schedule }}
 
 \vspace{0.25in}
 
 {% autoescape off %}
-{{ prog.program_type }} courses are taught by volunteers, primarily {{ settings.INSTITUTION_NAME|texescape }} students.
+\noindent {{ prog.program_type }} courses are taught by volunteers, primarily {{ settings.INSTITUTION_NAME|texescape }} students.
 The content and difficulty of the subjects varies significantly, from non-academic to college-level.
 Our program is not accredited to issue credit for any class, however, we leave it to school administrators to decide whether {{ settings.ORGANIZATION_SHORT_NAME|texescape }} courses can be counted as substitutes for school classes.
 You may view the teachers' course descriptions on the attached pages.
-If you would like to talk to an administrator or teacher about the content of a particular course, please email us at {\tt {{ settings.DEFAULT_EMAIL_ADDRESSES.default|texescape }} }. \\
+If you would like to talk to an administrator or teacher about the content of a particular course, please email us at {\tt {{ settings.DEFAULT_EMAIL_ADDRESSES.default|texescape }}}. \\
 
-\hspace{3in}\begin{minipage}{4in}{{ prog.niceName }} Directors \\
+\hspace{3in}\begin{minipage}{4in}{{ prog.niceName|texescape }} Directors \\
 {{ settings.INSTITUTION_NAME|texescape }} {{ settings.ORGANIZATION_SHORT_NAME|texescape }} \end{minipage}
 
 {% endautoescape %}
 {% endblock %}
 
 {% block additionalcontent %}
 \clearpage
-\noindent {\bf \underline{ {{ prog.niceName }} courses taken by {{ user.first_name }} {{ user.last_name }} } } \\
+\noindent {\bf \underline{% templatetag openbrace %}{{ prog.niceName|texescape }} courses taken by {{ user.first_name }} {{ user.last_name }}}} \\
 \hspace{0.5in}
 {{ descriptions }}
 {% endblock %}

esp/templates/program/modules/programprintables/courses_inline.tex

@@ -2,11 +2,11 @@
 {% autoescape off %}
 
 {% for cls in classlist %}
-\noindent \textbf{ {{cls.emailcode}}: {{ cls.title|texescape }} } - {{cls.parent_class.getTeacherNames|join:", "|texescape }}  ~\\
+\noindent \textbf{% templatetag openbrace %}{{cls.emailcode}}: {{ cls.title|texescape }}} - {{cls.parent_class.getTeacherNames|join:", "|texescape }}  ~\\
 
 \noindent {{ cls.parent_class.class_info|texescape }} ~\\
 
-\noindent \textit{Open to students in grades {{ cls.parent_class.grade_min }} through {{ cls.parent_class.grade_max }} } ~\\
+\noindent \textit{Open to students in grades {{ cls.parent_class.grade_min }} through {{ cls.parent_class.grade_max }}} ~\\
 \textit{Maximum size: {{cls.parent_class.class_size_max }} } ~\\
 \textit{Meeting times: {{ cls.friendly_times|join:"\\" }} } ~\\
 \rule{7in}{0.25pt} ~\\

esp/templates/program/modules/programprintables/transcript.tex

@@ -1,8 +1,8 @@
 {% load latex %}
 {% autoescape off %}
-\begin{tabular}{ll}
+\noindent \begin{tabularx}{\textwidth}{p{.6\textwidth}|X}
 {\bf Course} & {\bf Teacher[s]} \\ \hline
 {% for cls in classlist %}{{ cls.title|texescape }} & {{cls.parent_class.getTeacherNames|join:", "|texescape }}\\
 {% endfor %}
-\end{tabular}
+\end{tabularx}
 {% endautoescape %}