Skip to content

Ptx-based template for student pages #1280

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ascholerChemeketa wants to merge 11 commits into
base: main
Choose a base branch
from
Open

Ptx-based template for student pages #1280

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
2999e90
DB: fetch_assignment_questions returns chapter and subchapter with qu…
Jul 3, 2026
f305475
Drop hardcoded old pretext css from static_assets
Jul 3, 2026
157a6be
Move safe_join and construct_course_url to response_helpers
Jul 3, 2026
08e63df
Add get_jinja_templates to load templates from multiple directories
Jul 3, 2026
630708b
Move macro_with_errors to editlibrary (only consumer)
Jul 3, 2026
c165638
Split main.css into ptx-based and not
Jul 3, 2026
2c40f1e
Gate some static_assets to not apply in RS pages using ptx-based _bas…
Jul 3, 2026
e5efae2
Update assignment styles
Jul 3, 2026
3fbb40c
Move doAssignment and chooseAssignment to ptx-based _base
Jul 3, 2026
c2830ba
Move course homepage to ptx-based _base
Jul 3, 2026
91bf115
Require opt in for ptx-based student pages
Jul 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion bases/rsptx/admin_server_api/routers/instructor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -423,6 +423,9 @@ async def get_course_settings(
"show_points": course_attrs.get("show_points") == "true",
"groupsize": course_attrs.get("groupsize", "3"),
"enable_async_llm_modes": course_attrs.get("enable_async_llm_modes", "false"),
"use_pretext_student_pages": str(
course_attrs.get("use_pretext_student_pages", "false")
).lower(),
}

return templates.TemplateResponse("admin/instructor/course_settings.html", context)
Expand Down Expand Up @@ -1151,7 +1154,7 @@ async def _copy_one_assignment(
assignment_questions = await fetch_assignment_questions(old_assignment_id)

for question_data in assignment_questions:
question, assignment_question = question_data
question, assignment_question, chapter, subchapter = question_data

new_assignment_question_data = AssignmentQuestionValidator(
assignment_id=new_assignment.id,
Expand Down
7 changes: 3 additions & 4 deletions bases/rsptx/assignment_server_api/routers/instructor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@
from rsptx.auth.session import auth_manager, is_instructor
from rsptx.templates import template_folder
from rsptx.configuration import settings
from rsptx.response_helpers import construct_course_url
from rsptx.response_helpers.core import (
make_json_response,
get_webpack_static_imports,
Expand Down Expand Up @@ -116,8 +117,6 @@
from rsptx.data_types.language import LanguageOptions
from rsptx.data_types.question_type import QuestionType

from .student import get_course_url

# Routing
# =======
# See `APIRouter config` for an explanation of this approach.
Expand Down Expand Up @@ -184,9 +183,9 @@ async def review_peer_assignment(
# This replacement is to render images
bts = q.Question.htmlsrc
htmlsrc = bts.replace(
'src="../_static/', 'src="' + get_course_url(course, "_static/")
'src="../_static/', 'src="' + construct_course_url(course, "_static/")
)
htmlsrc = htmlsrc.replace("../_images", get_course_url(course, "_images"))
htmlsrc = htmlsrc.replace("../_images", construct_course_url(course, "_images"))

# Rewrite xref links and knowls in fillintheblank questions
if "fillintheblank" in htmlsrc:
Expand Down
170 changes: 117 additions & 53 deletions bases/rsptx/assignment_server_api/routers/student.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,8 @@
from rsptx.db.models import GradeValidator, UseinfoValidation, CoursesValidator
from rsptx.db.crud.assignment import is_assignment_visible_to_students
from rsptx.auth.session import auth_manager, is_instructor
from rsptx.templates import template_folder
from rsptx.templates import template_folder, get_jinja_templates
from rsptx.response_helpers import construct_course_url, safe_join
from rsptx.response_helpers.core import (
make_json_response,
get_webpack_static_imports,
Expand Down Expand Up @@ -103,8 +104,11 @@ async def get_assignments(

sid = user.username
course = await fetch_course(user.course_name)
course_attrs = await fetch_all_course_attributes(course.id)
is_lti1p1_course = await fetch_lti_version(course.id) == "1.1"
templates = Jinja2Templates(directory=template_folder)

course_markup_system = course_attrs.get("markup_system", "Runestone")

user_is_instructor = await is_instructor(request, user=user)
if user_is_instructor:
# if the user is an instructor, we need to show all assignments
Expand Down Expand Up @@ -167,20 +171,45 @@ def sort_key(assignment):
for a in assignments:
visibility_map[a.id] = is_assignment_visible_to_students(a)

use_pretext_student_pages = (
str(course_attrs.get("use_pretext_student_pages", "false")).lower()
== "true"
)
if use_pretext_student_pages:
book_path = safe_join(
settings.book_path,
course.base_course,
"published",
course.base_course,
)
templates = get_jinja_templates(book_path)
else:
templates = Jinja2Templates(directory=template_folder)
Comment thread
ascholerChemeketa marked this conversation as resolved.

context = dict(
course=course,
course_name=user.course_name,
request=request,
assignment_list=assignments,
readings='null', #force bookfuncs to not render assignment tracker
stats=stats,
user=sid,
is_logged_in="true",
is_instructor="true" if user_is_instructor else "false",
student_page="true",
lti1p1=is_lti1p1_course,
Comment on lines +196 to +200
now=now,
visibility_map=visibility_map,
settings=settings,
base_url=construct_course_url(course),
activity_info='{}',
downloads_enabled="true" if course.downloads_enabled else "false",
allow_pairs="true" if course.allow_pairs else "false",
origin=course_markup_system,
**course_attrs,
)
return templates.TemplateResponse(
"assignment/student/chooseAssignment.html",
{
"assignment_list": assignments,
"stats": stats,
"course": course,
"user": sid,
"request": request,
"is_instructor": user_is_instructor,
"student_page": True,
"lti1p1": is_lti1p1_course,
"now": now,
"visibility_map": visibility_map,
},
"assignment/student/chooseAssignment.html" , context
)


Expand Down Expand Up @@ -563,20 +592,6 @@ async def update_submit(
await upsert_grade(grade)

return make_json_response(detail=dict(success=True))


def get_course_url(course: CoursesValidator, *args) -> str:
"""Get the URL for the course.

:param course: _description_
:type course: CourseValidator
:return: _description_
:rtype: str
"""
rest = "/".join(args)
return f"/ns/books/published/{course.course_name}/{rest}"


@router.get("/doAssignment")
async def doAssignment(
request: Request,
Expand Down Expand Up @@ -677,6 +692,7 @@ async def doAssignment(
questions_score = 0
readings = dict()
readings_score = 0
needs_manual_grading = False

# For each question, accumulate information, and add it to either the readings or questions data structure
# If scores have not been released for the question or if there are no scores yet available, the scoring information will be recorded as empty strings
Expand All @@ -688,11 +704,11 @@ async def doAssignment(
# This replacement is to render images
bts = q.Question.htmlsrc
htmlsrc = bts.replace(
'src="../_static/', 'src="' + get_course_url(course, "_static/")
'src="../_static/', 'src="' + construct_course_url(course, "_static/")
)
htmlsrc = htmlsrc.replace("../_images", get_course_url(course, "_images"))
htmlsrc = htmlsrc.replace("../_images", construct_course_url(course, "_images"))
htmlsrc = htmlsrc.replace(
'src=\\"external', 'src=\\"' + get_course_url(course, "external")
'src=\\"external', 'src=\\"' + construct_course_url(course, "external")
)
# htmlsrc = htmlsrc.replace(
# "generated/webwork", get_course_url(course, "generated/webwork")
Expand Down Expand Up @@ -735,27 +751,52 @@ async def doAssignment(
if score is None:
score = 0

chap_name = q.Question.chapter
subchap_name = q.Question.subchapter
is_incorrect = score == 0 and comment != "ungraded"

chap_label = q.Question.chapter
subchap_label = q.Question.subchapter
if q.Question.base_course not in preambles:
preambles[q.Question.base_course] = await addPreamble(
q.Question.base_course
)

# Temporarily prevent chapter numbers from being duplicated while we unwind
# number being added to chapter name in DB. Assume any leaning numbers are
# not part of the chapter name and should be stripped off.
chapter_name = q.Chapter.chapter_name
chapter_name = re.sub(r"^\d+\s*", "", chapter_name)
chapter_chapter_name = q.SubChapter.sub_chapter_name
chapter_chapter_name = re.sub(r"^[\d\.]+\s*", "", chapter_chapter_name)

info = dict(
htmlsrc=htmlsrc,
score=score,
is_incorrect=is_incorrect,
points=q.AssignmentQuestion.points,
comment=comment,
chapter=q.Question.chapter,
subchapter=q.Question.subchapter,
chapter_name=chap_name,
subchapter_name=subchap_name,
name=q.Question.name,
qnumber=q.Question.qnumber,
question_type=q.Question.question_type,
activities_required=q.AssignmentQuestion.activities_required,
chapter_name=chapter_name,
chapter_label=chap_label,
chapter_num=q.Chapter.chapter_num,
chapter_chapter_name=chapter_chapter_name,
sub_chapter_label=subchap_label,
chapter_chapter_num=q.SubChapter.sub_chapter_num,
base_url=construct_course_url(course),
# for rendering with ptx template, we need these for the menu
is_logged_in="true",
is_instructor="true" if user_is_instructor else "false",
readings=[],
activity_info='{}',
downloads_enabled="true" if course.downloads_enabled else "false",
allow_pairs="true" if course.allow_pairs else "false",
**course_attrs,
)
if q.AssignmentQuestion.autograde == "manual":
if comment == "ungraded":
needs_manual_grading = True
info["how_graded"] = "Needs Manual Grading"
elif q.AssignmentQuestion.which_to_grade == "first_answer":
info["how_graded"] = "First Answer"
Expand All @@ -766,9 +807,9 @@ async def doAssignment(

if q.AssignmentQuestion.reading_assignment:
# add to readings
if chap_name not in readings:
if chap_label not in readings:
# add chapter info
completion = await fetch_user_chapter_progress(user, chap_name)
completion = await fetch_user_chapter_progress(user, chap_label)
if not completion:
status = "notstarted"
elif completion.status == 1:
Expand All @@ -777,12 +818,12 @@ async def doAssignment(
status = "started"
else:
status = "notstarted"
readings[chap_name] = dict(status=status, subchapters=[])
readings[chap_label] = dict(status=status, subchapters=[], chapter_label=chap_label, chapter_name=chapter_name, chapter_num=q.Chapter.chapter_num)

# add subchapter info
# add completion status to info
subch_completion = await fetch_user_sub_chapter_progress(
user, chap_name, subchap_name
user, chap_label, subchap_label
)

if not subch_completion:
Expand All @@ -797,8 +838,8 @@ async def doAssignment(

# Make sure we don't create duplicate entries for older courses. New style
# courses only have the base course in the database, but old will have both
if info not in readings[chap_name]["subchapters"]:
readings[chap_name]["subchapters"].append(info)
if info not in readings[chap_label]["subchapters"]:
readings[chap_label]["subchapters"].append(info)
readings_score += info["score"]

else:
Expand Down Expand Up @@ -833,7 +874,7 @@ async def doAssignment(
readings_names = []
for chapname in readings:
readings_names = readings_names + [
"{}/{}.html".format(d["chapter"], d["subchapter"])
"{}/{}.html".format(d["chapter_label"], d["sub_chapter_label"])
for d in readings[chapname]["subchapters"]
]

Expand All @@ -848,8 +889,7 @@ async def doAssignment(
parsed_js = {}
parsed_js["readings"] = readings_names

c_origin = course_attrs.get("markup_system", "Runestone")
print("ORIGIN", c_origin)
course_markup_system = course_attrs.get("markup_system", "Runestone")

# grabs the row for the current user and and assignment in the grades table
grade = await fetch_grade(user.id, assignment_id)
Expand Down Expand Up @@ -883,37 +923,61 @@ async def doAssignment(
overdue = False
if timestamp > deadline:
overdue = True
templates = Jinja2Templates(directory=template_folder)

use_pretext_student_pages = (
str(course_attrs.get("use_pretext_student_pages", "false")).lower()
== "true"
)
if use_pretext_student_pages:
book_path = safe_join(
settings.book_path,
course.base_course,
"published",
course.base_course,
)
templates = get_jinja_templates(book_path)
else:
templates = Jinja2Templates(directory=template_folder)
Comment on lines +932 to +940

@ascholerChemeketa ascholerChemeketa Jul 4, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added


# templates = Jinja2Templates(directory=template_folder)
# reverse the order of the keys in the preambles dictionary so that the first key I added is now the last
# this will ensure that when multiple preamble definitions are used the last one is from the current course
preambles = dict((k, v) for k, v in reversed(preambles.items()))
context = dict( # This is all the variables that will be used in the doAssignment.html document
course=course,
request=request,
course_name=user.course_name,
assignment=assignment,
questioninfo=questionslist,
course_id=user.course_name,
readings=readings,
readings='null', #force bookfuncs to not render assignment tracker
readings_full=readings,
questions_score=questions_score,
readings_score=readings_score,
user=user,
# gradeRecordingUrl=URL('assignments', 'record_grade'),
# calcTotalsURL=URL('assignments', 'calculate_totals'),
released=assignment.released,
is_instructor=user_is_instructor,
student_page=True,
origin=c_origin,
is_logged_in="true",
is_instructor="true" if user_is_instructor else "false",
needs_manual_grading=needs_manual_grading,
student_page="true",
origin=course_markup_system,
Comment on lines +961 to +965
is_submit=grade.is_submit,
is_graded=is_graded,
overdue=overdue,
enforce_pastdue=enforce_pastdue,
ptx_js_version=course_attrs.get("ptx_js_version", "0.2"),
webwork_js_version=course_attrs.get("webwork_js_version", "2.20"),
request=request,
latex_preamble_dict=preambles,
wp_imports=get_webpack_static_imports(course),
settings=settings,
course_attrs=course_attrs,
base_url=construct_course_url(course),
activity_info='{}',
downloads_enabled="true" if course.downloads_enabled else "false",
allow_pairs="true" if course.allow_pairs else "false",
**course_attrs,
)
response = templates.TemplateResponse(
"assignment/student/doAssignment.html", context
Expand Down
Loading
Loading