/**
* Add a published assessment to gradebook.
*
* @param publishedAssessment the published assessment
* @param g the Gradebook Service
* @return false: cannot add to gradebook
* @throws java.lang.Exception
*/
public boolean addToGradebook(PublishedAssessmentData publishedAssessment, GradebookService g)
throws Exception {
// log.info("total point(s) is/are =" +
// publishedAssessment.getTotalScore().longValue());
// log.info("gradebookId =" + GradebookFacade.getGradebookUId());
boolean added = false;
// log.info("GradebookService instance=" + g);
String gradebookUId = GradebookFacade.getGradebookUId();
if (gradebookUId == null) {
return false;
}
// log.info("inside addToGradebook, gradebook exists? " +
// g.isGradebookDefined(gradebookUId));
if (g.isGradebookDefined(gradebookUId)) {
// Tool name code added by Josh Holtzman
Tool tool = ToolManager.getTool("sakai.samigo");
String appName = null;
if (tool == null) {
log.warn(
"could not get tool named sakai.samigo, "
+ "so we're going to assume we're called 'Tests & Quizzes'");
appName = "Tests & Quizzes";
} else {
appName = tool.getTitle();
}
String title = StringEscapeUtils.unescapeHtml(publishedAssessment.getTitle());
if (!g.isAssignmentDefined(gradebookUId, title)) {
g.addExternalAssessment(
gradebookUId,
publishedAssessment.getPublishedAssessmentId().toString(),
null,
title,
publishedAssessment.getTotalScore().doubleValue(),
publishedAssessment.getAssessmentAccessControl().getDueDate(),
appName); // Use the app name from sakai
added = true;
}
}
return added;
}
public Map<String, String> transferCopyEntitiesRefMigrator(
String fromContext, String toContext, List<String> ids) {
Map<String, String> transversalMap = new HashMap<String, String>();
try {
logger.debug("transfer copy syllbus itmes by transferCopyEntitiesRefMigrator");
String fromPage = fromContext;
SyllabusItem fromSyllabusItem = syllabusManager.getSyllabusItemByContextId(fromPage);
if (fromSyllabusItem != null) {
Set fromSyDataSet = syllabusManager.getSyllabiForSyllabusItem(fromSyllabusItem);
if ((fromSyDataSet != null && fromSyDataSet.size() > 0)
|| fromSyllabusItem.getRedirectURL() != null) {
String toPage =
addSyllabusToolToPage(toContext, SiteService.getSite(toContext).getTitle());
SyllabusItem toSyItem = syllabusManager.getSyllabusItemByContextId(toPage);
if (toSyItem == null) {
toSyItem =
syllabusManager.createSyllabusItem(
UserDirectoryService.getCurrentUser().getId(),
toPage,
fromSyllabusItem.getRedirectURL());
} else if (fromSyllabusItem.getRedirectURL() != null) {
toSyItem.setRedirectURL(fromSyllabusItem.getRedirectURL());
syllabusManager.saveSyllabusItem(toSyItem);
}
Iterator fromSetIter = fromSyDataSet.iterator();
while (fromSetIter.hasNext()) {
SyllabusData toSyData = (SyllabusData) fromSetIter.next();
Integer positionNo =
new Integer(syllabusManager.findLargestSyllabusPosition(toSyItem).intValue() + 1);
SyllabusData newToSyData =
syllabusManager.createSyllabusDataObject(
toSyData.getTitle(),
positionNo,
toSyData.getAsset(),
toSyData.getView(),
toSyData.getStatus(),
toSyData.getEmailNotification());
Set attachSet = syllabusManager.getSyllabusAttachmentsForSyllabusData(toSyData);
Iterator attachIter = attachSet.iterator();
Set newAttachSet = new TreeSet();
while (attachIter.hasNext()) {
SyllabusAttachment thisAttach = (SyllabusAttachment) attachIter.next();
ContentResource oldAttachment =
contentHostingService.getResource(thisAttach.getAttachmentId());
ContentResource attachment =
contentHostingService.addAttachmentResource(
oldAttachment
.getProperties()
.getProperty(ResourceProperties.PROP_DISPLAY_NAME),
toContext,
ToolManager.getTool("sakai.syllabus").getTitle(),
oldAttachment.getContentType(),
oldAttachment.getContent(),
oldAttachment.getProperties());
SyllabusAttachment thisSyllabusAttach =
syllabusManager.createSyllabusAttachmentObject(
attachment.getId(),
attachment.getProperties().getProperty(ResourceProperties.PROP_DISPLAY_NAME));
newAttachSet.add(thisSyllabusAttach);
}
newToSyData.setAttachments(newAttachSet);
syllabusManager.addSyllabusToSyllabusItem(toSyItem, newToSyData);
}
} else {
logger.debug(
"importResources: no data found for syllabusItem id"
+ fromSyllabusItem.getSurrogateKey().toString());
}
logger.debug("importResources: End importing syllabus data");
}
} catch (Exception e) {
e.printStackTrace();
logger.error(e.getMessage(), e);
}
return transversalMap;
}
private String addOrCreateTool(Map payload, boolean trustedConsumer, User user, Site site)
throws LTIException {
// Check if the site already has the tool
String toolPlacementId = null;
String tool_id = (String) payload.get("tool_id");
try {
site = SiteService.getSite(site.getId());
ToolConfiguration toolConfig = site.getToolForCommonId(tool_id);
if (toolConfig != null) {
toolPlacementId = toolConfig.getId();
}
} catch (Exception e) {
M_log.warn(e.getLocalizedMessage(), e);
throw new LTIException("launch.tool.search", "tool_id=" + tool_id, e);
}
if (M_log.isDebugEnabled()) {
M_log.debug("toolPlacementId=" + toolPlacementId);
}
// If tool not in site, and we are a trusted consumer, error
// Otherwise, add tool to the site
ToolConfiguration toolConfig = null;
if (BasicLTIUtil.isBlank(toolPlacementId)) {
try {
SitePage sitePageEdit = null;
sitePageEdit = site.addPage();
sitePageEdit.setTitle(tool_id);
toolConfig = sitePageEdit.addTool();
toolConfig.setTool(tool_id, ToolManager.getTool(tool_id));
toolConfig.setTitle(tool_id);
Properties propsedit = toolConfig.getPlacementConfig();
propsedit.setProperty(
BASICLTI_RESOURCE_LINK, (String) payload.get(BasicLTIConstants.RESOURCE_LINK_ID));
pushAdvisor();
try {
SiteService.save(site);
M_log.info("Tool added, tool_id=" + tool_id + ", siteId=" + site.getId());
} catch (Exception e) {
throw new LTIException(
"launch.site.save", "tool_id=" + tool_id + ", siteId=" + site.getId(), e);
} finally {
popAdvisor();
}
toolPlacementId = toolConfig.getId();
} catch (Exception e) {
throw new LTIException(
"launch.tool.add", "tool_id=" + tool_id + ", siteId=" + site.getId(), e);
}
}
// Get ToolConfiguration for tool if not already setup
if (toolConfig == null) {
toolConfig = site.getToolForCommonId(tool_id);
}
// Check user has access to this tool in this site
if (!ToolManager.isVisible(site, toolConfig)) {
M_log.warn(
"Not allowed to access tool user_id="
+ user.getId()
+ " site="
+ site.getId()
+ " tool="
+ tool_id);
throw new LTIException(
"launch.site.tool.denied",
"user_id=" + user.getId() + " site=" + site.getId() + " tool=" + tool_id,
null);
}
return toolPlacementId;
}
protected void validate(Map payload, boolean isTrustedConsumer) throws LTIException {
// check parameters
String lti_message_type = (String) payload.get(BasicLTIConstants.LTI_MESSAGE_TYPE);
String lti_version = (String) payload.get(BasicLTIConstants.LTI_VERSION);
String oauth_consumer_key = (String) payload.get("oauth_consumer_key");
String resource_link_id = (String) payload.get(BasicLTIConstants.RESOURCE_LINK_ID);
String user_id = (String) payload.get(BasicLTIConstants.USER_ID);
String context_id = (String) payload.get(BasicLTIConstants.CONTEXT_ID);
boolean launch = true;
if (BasicLTIUtil.equals(lti_message_type, "basic-lti-launch-request")) {
launch = true;
} else if (BasicLTIUtil.equals(lti_message_type, "ContentItemSelectionRequest")) {
launch = false;
} else {
throw new LTIException("launch.invalid", "lti_message_type=" + lti_message_type, null);
}
if (!BasicLTIUtil.equals(lti_version, "LTI-1p0")) {
throw new LTIException("launch.invalid", "lti_version=" + lti_version, null);
}
if (BasicLTIUtil.isBlank(oauth_consumer_key)) {
throw new LTIException("launch.missing", "oauth_consumer_key", null);
}
if (launch && BasicLTIUtil.isBlank(resource_link_id)) {
throw new LTIException("launch.missing", "resource_link_id", null);
}
if (BasicLTIUtil.isBlank(user_id)) {
throw new LTIException("launch.missing", "user_id", null);
}
if (M_log.isDebugEnabled()) {
M_log.debug("user_id=" + user_id);
}
// check tool_id
String tool_id = (String) payload.get("tool_id");
if (tool_id == null) {
throw new LTIException("launch.tool_id.required", null, null);
}
// Trim off the leading slash and any trailing space
tool_id = tool_id.substring(1).trim();
if (M_log.isDebugEnabled()) {
M_log.debug("tool_id=" + tool_id);
}
// store modified tool_id back in payload
payload.put("tool_id", tool_id);
final String allowedToolsConfig =
ServerConfigurationService.getString("basiclti.provider.allowedtools", "");
final String[] allowedTools = allowedToolsConfig.split(":");
final List<String> allowedToolsList = Arrays.asList(allowedTools);
if (launch && allowedTools != null && !allowedToolsList.contains(tool_id)) {
throw new LTIException("launch.tool.notallowed", tool_id, null);
}
final Tool toolCheck = ToolManager.getTool(tool_id);
if (launch && toolCheck == null) {
throw new LTIException("launch.tool.notfound", tool_id, null);
}
// Check for the ext_sakai_provider_eid param. If set, this will contain the eid that we are to
// use
// in place of using the user_id parameter
// WE still need that parameter though, so translate it from the given eid.
boolean useProvidedEid = false;
String ext_sakai_provider_eid = (String) payload.get(BasicLTIConstants.EXT_SAKAI_PROVIDER_EID);
if (BasicLTIUtil.isNotBlank(ext_sakai_provider_eid)) {
useProvidedEid = true;
try {
user_id = UserDirectoryService.getUserId(ext_sakai_provider_eid);
} catch (Exception e) {
M_log.error(e.getLocalizedMessage(), e);
throw new LTIException(
"launch.provided.eid.invalid", "ext_sakai_provider_eid=" + ext_sakai_provider_eid, e);
}
}
if (M_log.isDebugEnabled()) {
M_log.debug("ext_sakai_provider_eid=" + ext_sakai_provider_eid);
}
// Contextualize the context_id with the OAuth consumer key
// Also use the resource_link_id for the context_id if we did not get a context_id
// BLTI-31: if trusted, context_id is required and use the param without modification
if (BasicLTIUtil.isBlank(context_id)) {
if (isTrustedConsumer) {
throw new LTIException("launch.missing", context_id, null);
} else {
context_id = "res:" + resource_link_id;
payload.put(BasicLTIConstants.CONTEXT_ID, context_id);
}
}
// Check if context_id is simply a ~. If so, get the id of that user's My Workspace site
// and use that to construct the full context_id
if (BasicLTIUtil.equals(context_id, "~")) {
if (useProvidedEid) {
String userSiteId = null;
try {
userSiteId = SiteService.getUserSiteId(user_id);
} catch (Exception e) {
M_log.warn("Failed to get My Workspace site for user_id:" + user_id);
M_log.error(e.getLocalizedMessage(), e);
throw new LTIException("launch.user.site.unknown", "user_id=" + user_id, e);
}
context_id = userSiteId;
payload.put(BasicLTIConstants.CONTEXT_ID, context_id);
}
}
if (M_log.isDebugEnabled()) {
M_log.debug("context_id=" + context_id);
}
// Lookup the secret
final String configPrefix = "basiclti.provider." + oauth_consumer_key + ".";
final String oauth_secret = ServerConfigurationService.getString(configPrefix + "secret", null);
if (oauth_secret == null) {
throw new LTIException("launch.key.notfound", oauth_consumer_key, null);
}
final OAuthMessage oam = (OAuthMessage) payload.get("oauth_message");
final String forcedURIScheme =
ServerConfigurationService.getString("basiclti.provider.forcedurischeme", null);
if (forcedURIScheme != null) {
try {
URI testURI = new URI(oam.URL);
URI newURI = new URI(forcedURIScheme, testURI.getSchemeSpecificPart(), null);
oam.URL = newURI.toString();
} catch (URISyntaxException use) {
}
}
final OAuthValidator oav = new SimpleOAuthValidator();
final OAuthConsumer cons =
new OAuthConsumer(
"about:blank#OAuth+CallBack+NotUsed", oauth_consumer_key, oauth_secret, null);
final OAuthAccessor acc = new OAuthAccessor(cons);
String base_string = null;
try {
base_string = OAuthSignatureMethod.getBaseString(oam);
} catch (Exception e) {
M_log.error(e.getLocalizedMessage(), e);
base_string = null;
}
try {
oav.validateMessage(oam, acc);
} catch (Exception e) {
M_log.warn("Provider failed to validate message");
M_log.warn(e.getLocalizedMessage(), e);
if (base_string != null) {
M_log.warn(base_string);
}
throw new LTIException("launch.no.validate", context_id, e);
}
final Session sess = SessionManager.getCurrentSession();
if (sess == null) {
throw new LTIException("launch.no.session", context_id, null);
}
}
private void handleContentItem(
HttpServletRequest request, HttpServletResponse response, Map payload)
throws ServletException, IOException {
String allowedToolsConfig =
ServerConfigurationService.getString("basiclti.provider.allowedtools", "");
String[] allowedTools = allowedToolsConfig.split(":");
List<String> allowedToolsList = Arrays.asList(allowedTools);
String tool_id = (String) request.getParameter("install");
if (tool_id == null) {
ArrayList<Tool> tools = new ArrayList<Tool>();
for (String toolId : allowedToolsList) {
Tool theTool = ToolManager.getTool(toolId);
if (theTool == null) continue;
tools.add(theTool);
}
request.setAttribute("tools", tools);
} else {
if (!allowedToolsList.contains(tool_id)) {
doError(request, response, "launch.tool.notallowed", tool_id, null);
return;
}
final Tool toolCheck = ToolManager.getTool(tool_id);
if (toolCheck == null) {
doError(request, response, "launch.tool.notfound", tool_id, null);
return;
}
String content_item_return_url = (String) payload.get("content_item_return_url");
if (content_item_return_url == null) {
doError(request, response, "content_item.return_url.notfound", tool_id, null);
return;
}
ContentItemResponse resp = SakaiContentItemUtil.getContentItemResponse(tool_id);
if (resp == null) {
doError(request, response, "launch.tool.notfound", tool_id, null);
return;
}
String content_items = resp.prettyPrintLog();
// Set up the return
Map<String, String> ltiMap = new HashMap<String, String>();
Map<String, String> extra = new HashMap<String, String>();
ltiMap.put(
BasicLTIConstants.LTI_MESSAGE_TYPE,
BasicLTIConstants.LTI_MESSAGE_TYPE_CONTENTITEMSELECTION);
ltiMap.put(BasicLTIConstants.LTI_VERSION, BasicLTIConstants.LTI_VERSION_1);
ltiMap.put("content_items", content_items);
String data = (String) payload.get("data");
if (data != null) ltiMap.put("data", data);
M_log.debug("ltiMap=" + ltiMap);
boolean dodebug = M_log.isDebugEnabled();
boolean autosubmit = false;
String launchtext = rb.getString("content_item.install.button");
String back_to_store = rb.getString("content_item.back.to.store");
extra.put(
"button_html",
"<input type=\"submit\" value=\""
+ back_to_store
+ "\"onclick=\"location.href='content.item'; return false;\">");
String launch_html =
BasicLTIUtil.postLaunchHTML(
ltiMap, content_item_return_url, launchtext, autosubmit, dodebug, extra);
request.setAttribute("back_to_store", rb.getString("content_item.back.to.store"));
request.setAttribute("install", tool_id);
request.setAttribute("launch_html", launch_html);
request.setAttribute("tool", toolCheck);
}
// Forward to the JSP
ServletContext sc = this.getServletContext();
RequestDispatcher rd = sc.getRequestDispatcher("/contentitem.jsp");
try {
rd.forward(request, response);
} catch (Exception e) {
e.printStackTrace();
}
}
