def fetch_overview(session):
"""Fetch gradebook information. Returns (assignments, students)."""
assert isinstance(session, BlackboardSession)
url = (
'https://bb.au.dk/webapps/gradebook/do/instructor/getJSONData' +
'?course_id=%s' % session.course_id)
l = blackboard.slowlog()
response = session.get(url)
l("Fetching gradebook took %.1f s")
try:
o = response.json()
except JSONDecodeError:
raise ParserError("Couldn't decode JSON", response)
if 'cachedBook' in o:
o = o['cachedBook']
try:
columns = o['colDefs']
except KeyError:
raise ParserError("No colDefs", response)
assignments = {}
for c in columns:
if c.get('src') != 'resource/x-bb-assignment':
continue
assignments[c['id']] = c
users = {}
for row in o['rows']:
user_id = row[0]['uid']
user_available = row[0]['avail']
user_cells = {cell['c']: cell for cell in row if 'c' in cell}
user_data = {cell['c']: cell['v'] for cell in row if 'v' in cell}
user_assignments = {}
for a in assignments.keys():
try:
cell = user_cells[a]
except KeyError:
continue
needs_grading = bool(cell.get('ng'))
user_assignments[a] = {
'score': cell['v'],
'needs_grading': needs_grading,
'attempts': None,
}
users[user_id] = dict(
first_name=user_data['FN'],
last_name=user_data['LN'],
username=user_data['UN'],
student_number=user_data['SI'],
last_access=user_data['LA'],
id=user_id,
available=user_available,
assignments=user_assignments,
)
return assignments, users
def dwr_get_groups(session):
session_id = session.get_cookie('JSESSIONID', '/webapps/gradebook')
payload = dict(
callCount=1,
page='/webapps/gradebook/do/instructor/enterGradeCenter' +
'?course_id=%s&cvid=fullGC' % session.course_id,
httpSessionId=session_id,
scriptSessionId=get_script_session_id(session),
batchId=42)
course_id_raw = session.course_id.split('_')[1]
i = 0
call_data = dict(
scriptName='GradebookDWRFacade',
methodName='getGroups',
id=i,
param0='string:%s' % course_id_raw)
payload.update(('c%d-%s' % (i, k), v) for k, v in call_data.items())
url = ('https://bb.au.dk/webapps/gradebook/dwr/call/plaincall/' +
'GradebookDWRFacade.getGroups.dwr')
response = session.post(url, payload)
try:
results = parse_js(response.text)
except ValueError as exn:
raise ParserError(exn.args[0], response)
return results[i]
def dwr_get_attempts_info_single_request(session, attempts):
session_id = session.get_cookie('JSESSIONID', '/webapps/gradebook')
payload = dict(
callCount=len(attempts),
page='/webapps/gradebook/do/instructor/enterGradeCenter' +
'?course_id=%s&cvid=fullGC' % session.course_id,
httpSessionId=session_id,
scriptSessionId=get_script_session_id(session),
batchId=42)
course_id_raw = session.course_id.split('_')[1]
for i, (student_id, handin_id) in enumerate(attempts):
call_data = dict(
scriptName='GradebookDWRFacade',
methodName='getAttemptsInfo',
id=i,
param0='number:%s' % course_id_raw,
param1='string:%s' % student_id,
param2='string:%s' % handin_id)
payload.update(('c%d-%s' % (i, k), v) for k, v in call_data.items())
url = ('https://bb.au.dk/webapps/gradebook/dwr/call/plaincall/' +
'GradebookDWRFacade.getAttemptsInfo.dwr')
response = session.post(url, payload)
try:
results = parse_js(response.text)
except ValueError as exn:
raise ParserError(exn.args[0], response)
return [results[i] for i in range(len(attempts))]
def __init__(self, session, url, form_xpath):
# We need to fetch the page to get the nonce
self._session = session
if isinstance(url, str):
response = session.get(url)
else:
# Presumably a response object
response = url
url = response.url
self._history = response.history + [response]
document = html5lib.parse(response.content,
transport_encoding=response.encoding)
form = document.find(form_xpath, NS)
if form is None:
raise ParserError("No %s" % form_xpath, response)
self.enctype_formdata = form.get('enctype') == 'multipart/form-data'
self.post_url = urljoin(response.url, form.get('action', ''))
# TODO: <select>?
fields = (form.findall('.//h:input', NS) +
form.findall('.//h:textarea', NS))
self._data = [
(field.get('name'), form_field_value(field)) for field in fields
if field.get('name') and
(field.get('type') != 'radio' or field.get('checked') is not None)
and field.get('type') != 'submit'
]
self._data_lookup = {k: i for i, (k, v) in enumerate(self._data)}
self.files = []
def require_success_message(self, response):
document = html5lib.parse(response.content,
transport_encoding=response.encoding)
msg = document.find('.//h:span[@id="goodMsg1"]', NS)
if msg is None:
raise ParserError("No goodMsg1 in POST response", response,
'Post data:\n%s' % pprint.pformat(self._data),
'Files:\n%s' % pprint.pformat(self.files))
logger.debug("goodMsg1: %s", element_text_content(msg))
def _log_badmsg(self, response):
document = html5lib.parse(response.content,
transport_encoding=response.encoding)
badmsg = document.find('.//h:span[@id="badMsg1"]', NS)
if badmsg is not None:
raise ParserError("badMsg1: %s" % element_text_content(badmsg),
response,
'Post data:\n%s' % pprint.pformat(self._data),
'Files:\n%s' % pprint.pformat(self.files))
def fetch_rubric(session, assoc_id, rubric_object):
rubric_id = rubric_object['id']
rubric_title = rubric_object['title']
prefix = 'BBFETCH'
url = ('https://%s/webapps/rubric/do/course/gradeRubric' % DOMAIN +
'?mode=grid&isPopup=true&rubricCount=1&prefix=%s' % prefix +
'&course_id=%s' % session.course_id +
'&maxValue=1.0&rubricId=%s' % rubric_id +
'&viewOnly=false&displayGrades=true&type=grading' +
'&rubricAssoId=%s' % assoc_id)
l = blackboard.slowlog()
response = session.get(url)
l("Fetching attempt rubric took %.1f s")
document = html5lib.parse(response.content,
transport_encoding=response.encoding)
def is_desc(div_element):
classes = (div_element.get('class') or '').split()
return ('u_controlsWrapper' in classes and 'radioLabel' not in classes
and 'feedback' not in classes)
table = document.find('.//h:table[@id="%s_rubricGradingTable"]' % prefix,
NS)
column_headers = list(
map(element_text_content,
table.findall('./h:thead/h:tr/h:th', NS)[1:]))
rubric_rows = []
row_tags = table.findall('./h:tbody/h:tr', NS)
for row in row_tags:
row_id = row.get('rubricrowid')
if row_id is None:
raise ParserError("Could not get rubric row id", response)
row_title = element_text_content(row.find('./h:th', NS))
row_cells = row.findall('./h:td', NS)
if len(row_cells) != len(column_headers):
raise ParserError(
"Number of row cells does not equal " +
"number of table header cells", response)
rubric_row_cells = []
for cell in row_cells:
cell_id = cell.get('rubriccellid')
if cell_id is None:
raise ParserError("Could not get rubric cell id", response)
cell_container = cell.find('./h:div[@class="rubricCellContainer"]',
NS)
cell_percentage_element = cell_container.find(
'.//h:input[@class="selectedPercentField"]', NS)
if cell_percentage_element is None:
raise ParserError("No selectedPercentField", response)
percentage = form_field_value(cell_percentage_element)
desc = list(filter(is_desc, cell_container.findall('./h:div', NS)))
if len(desc) != 1:
raise ParserError("Could not get description", response)
else:
desc_text = element_text_content(desc[0])
rubric_row_cells.append(
dict(id=cell_id, desc=desc_text, percentage=percentage))
rubric_rows.append(
dict(id=row_id, title=row_title, cells=rubric_row_cells))
return dict(id=rubric_id,
title=rubric_title,
columns=column_headers,
rows=rubric_rows)
def fetch_attempt(session, attempt_id, is_group_assignment):
assert isinstance(session, BlackboardSession)
if is_group_assignment:
url = ('https://%s/webapps/assignment/' % DOMAIN +
'gradeAssignmentRedirector' +
'?course_id=%s' % session.course_id +
'&groupAttemptId=%s' % attempt_id)
else:
url = ('https://%s/webapps/assignment/' % DOMAIN +
'gradeAssignmentRedirector' +
'?course_id=%s' % session.course_id +
'&attempt_id=%s' % attempt_id)
l = blackboard.slowlog()
response = session.get(url)
l("Fetching attempt took %.1f s")
document = html5lib.parse(response.content,
transport_encoding=response.encoding)
currentAttempt_container = document.find('.//h:div[@id="currentAttempt"]',
NS)
if currentAttempt_container is None:
not_yet_submitted = ('This attempt has not yet been submitted and ' +
'is not available to view at present.')
if not_yet_submitted in response.text:
raise NotYetSubmitted
raise blackboard.ParserError('No <div id="currentAttempt">',
response=response)
submission_text = document.find('.//h:div[@id="submissionTextView"]', NS)
if submission_text is not None:
submission_text = element_to_markdown(submission_text)
comments = document.find('.//h:div[@id="currentAttempt_comments"]', NS)
if comments is not None:
xpath = './/h:div[@class="vtbegenerated"]'
comments = [
element_to_markdown(e) for e in comments.findall(xpath, NS)
]
if not comments:
raise blackboard.ParserError(
"Page contains currentAttempt_comments, " +
"but it contains no comments", response)
comments = '\n\n'.join(comments)
files = []
submission_list = document.find(
'.//h:ul[@id="currentAttempt_submissionList"]', NS)
if submission_list is None:
if comments is None and submission_text is None:
logger.warning("The submission is completely empty.")
elif submission_text is None:
logger.warning(
"No submission; the student only uploaded a comment.")
else:
logger.warning("The student only uploaded a text submission.")
submission_list = ()
for submission in submission_list:
filename = element_text_content(submission)
download_button = submission.find('.//h:a[@class="dwnldBtn"]', NS)
if download_button is not None:
download_link = urljoin(response.url, download_button.get('href'))
files.append(dict(filename=filename, download_link=download_link))
else:
s = 'currentAttempt_attemptFilesubmissionText'
a = submission.find('.//h:a[@id="' + s + '"]', NS)
if a is not None:
# This <li> is for the submission_text
if not submission_text:
raise blackboard.ParserError(
"%r in file list, but no " % (filename, ) +
"accompanying submission text contents", response)
else:
raise blackboard.ParserError(
"No download link for file %r" % (filename, ), response)
score_input = document.find('.//h:input[@id="currentAttempt_grade"]', NS)
if score_input is None:
score = None
else:
score = form_field_value(score_input)
try:
score = float(score)
except ValueError:
if score:
raise blackboard.ParserError(
"Couldn't parse currentAttempt_grade: %r" % (score, ),
response)
score = None
feedbacktext_input = document.find('.//*[@id="feedbacktext"]', NS)
if feedbacktext_input is None:
feedback = ''
else:
feedback = form_field_value(feedbacktext_input)
if '<' in feedback:
feedback = html_to_markdown(feedback)
gradingNotestext_input = document.find('.//*[@id="gradingNotestext"]', NS)
if gradingNotestext_input is None:
grading_notes = ''
else:
grading_notes = form_field_value(gradingNotestext_input)
feedbackfiles_rows = document.find(
'.//h:tbody[@id="feedbackFiles_table_body"]', NS)
feedbackfiles = []
for i, row in enumerate(feedbackfiles_rows or []):
try:
link = row.findall('.//h:a', NS)[0]
except IndexError:
raise blackboard.ParserError(
"feedbackFiles_table_body row %s: no link" % i, response)
download_link = urljoin(response.url, link.get('href'))
filename = element_text_content(link)
feedbackfiles.append(
dict(filename=filename, download_link=download_link))
rubric_data = None
if is_group_assignment:
rubric_input = document.find(
'.//h:input[@id="%s_rubricEvaluation"]' % attempt_id, NS)
if rubric_input is not None:
rubric_data_str = form_field_value(rubric_input)
try:
rubric_data = json.loads(unquote(rubric_data_str))
except JSONDecodeError:
raise ParserError("Couldn't decode JSON", response)
t1 = 'blackboard.platform.gradebook2.GroupAttempt'
t2 = 'blackboard.plugin.rubric.api.core.data.EvaluationEntity'
if rubric_data['evalDataType'] == t1:
if rubric_data['evalEntityId'] != attempt_id:
raise ParserError(
"evalEntityId is %r, expected %r" %
(rubric_data['evalEntityId'], attempt_id), response)
elif rubric_data['evalDataType'] == t2:
# Seems to indicate an already filled-out rubric
pass
else:
raise ParserError(
"Unknown evalDataType %r" % rubric_data['evalDataType'],
response)
return dict(
submission=submission_text,
comments=comments,
files=files,
feedback=feedback,
feedbackfiles=feedbackfiles,
score=score,
grading_notes=grading_notes,
rubric_data=rubric_data,
)
def submit_grade(session, attempt_id, is_group_assignment,
grade, text, filenames, rubrics):
assert isinstance(session, BlackboardSession)
if is_group_assignment:
url = ('https://bb.au.dk/webapps/assignment/' +
'gradeAssignmentRedirector' +
'?course_id=%s' % session.course_id +
'&groupAttemptId=%s' % attempt_id)
else:
url = ('https://bb.au.dk/webapps/assignment/' +
'gradeAssignmentRedirector' +
'?course_id=%s' % session.course_id +
'&attempt_id=%s' % attempt_id)
# We need to fetch the page to get the nonce
response = session.get(url)
document = html5lib.parse(response.content, encoding=response.encoding)
form = document.find('.//h:form[@id="currentAttempt_form"]', NS)
if form is None:
raise ParserError("No <form id=currentAttempt_form>", response)
fields = (form.findall('.//h:input', NS) +
form.findall('.//h:textarea', NS))
data = [
(field.get('name'), form_field_value(field))
for field in fields
if field.get('name')
]
data_lookup = {k: i for i, (k, v) in enumerate(data)}
def data_get(k, *args):
if args:
d, = args
try:
return data[data_lookup[k]][1]
except KeyError:
if args:
return d
raise
def data_set(k, v):
try:
data[data_lookup[k]] = k, v
except KeyError:
data_lookup[k] = len(data)
data.append((k, v))
def data_extend(kvs):
for k, v in kvs:
data_lookup[k] = len(data)
data.append((k, v))
data_set('grade', str(grade))
data_set('feedbacktext', text)
data_set('gradingNotestext',
'Submitted with https://github.com/Mortal/bbfetch')
if rubrics:
rubric_input = '%s_rubricEvaluation' % attempt_id
rubric_data_str = data_get(rubric_input)
rubric_data = json.loads(unquote(rubric_data_str))
for rubric_cells, rubric in zip(rubrics, rubric_data['rubrics']):
rubric['client_changed'] = True
for input_row, row in zip(rubric_cells, rubric['rows']):
row['cell_id'] = input_row
rubric_data_str = quote(json.dumps(rubric_data))
data_set(rubric_input, rubric_data_str)
files = []
for i, filename in enumerate(filenames):
base = os.path.basename(filename)
data_extend([
('feedbackFiles_attachmentType', 'L'),
('feedbackFiles_fileId', 'new'),
('feedbackFiles_artifactFileId', 'undefined'),
('feedbackFiles_artifactType', 'undefined'),
('feedbackFiles_artifactTypeResourceKey', 'undefined'),
('feedbackFiles_linkTitle', base),
])
with open(filename, 'rb') as fp:
fdata = fp.read()
files.append(('feedbackFiles_LocalFile%d' % i, (base, fdata)))
if is_group_assignment:
post_url = (
'https://bb.au.dk/webapps/assignment//gradeGroupAssignment/submit')
else:
post_url = (
'https://bb.au.dk/webapps/assignment//gradeAssignment/submit')
if not files:
# Blackboard requires the POST to be
# Content-Type: multipart/form-data.
# Unfortunately, requests can only make a form-data POST
# if it has file-like input in the files list.
files = [('dummy', io.StringIO(''))]
try:
response = session.post(post_url, data=data, files=files)
except:
logger.exception("data=%r files=%r", data, files)
raise
document = html5lib.parse(response.content, encoding=response.encoding)
badmsg = document.find('.//h:span[@id="badMsg1"]', NS)
if badmsg is not None:
raise ParserError(
"badMsg1: %s" % element_text_content(badmsg), response,
'Post data:\n%s' % pprint.pformat(data),
'Files:\n%s' % pprint.pformat(files))
msg = document.find('.//h:span[@id="goodMsg1"]', NS)
if msg is None:
raise ParserError(
"No goodMsg1 in POST response", response,
'Post data:\n%s' % pprint.pformat(data),
'Files:\n%s' % pprint.pformat(files))
logger.debug("goodMsg1: %s", element_text_content(msg))