public void printComment(
SimplePageComment comment,
UIContainer tofill,
boolean highlight,
boolean anonymous,
boolean showModifiers,
CommentsViewParameters params,
SimplePageItem commentsItem,
SimplePage currentPage) {
if (canEditPage && itemToPageowner != null && comment.getItemId() != lastTitle) {
UIBranchContainer commentContainer = UIBranchContainer.make(tofill, "commentList:");
UIOutput.make(
commentContainer,
"commentTitle",
messageLocator
.getMessage("simplepage.comments-grading")
.replace("{}", itemToPageowner.get(comment.getItemId())));
lastTitle = comment.getItemId();
}
// print title if this is a comment on a different page. Normally this
// shold only happen for subpages of student pages
String pageTitle = null;
if (currentPage.getPageId() != comment.getPageId()) {
SimplePage commentPage = simplePageBean.getPage(comment.getPageId());
pageTitle = commentPage.getTitle();
}
UIBranchContainer commentContainer = UIBranchContainer.make(tofill, "commentList:");
UIOutput.make(commentContainer, "commentDiv");
if (highlight) commentContainer.decorate(new UIStyleDecorator("highlight-comment"));
if (!filter && params.author != null && params.author.equals(comment.getAuthor())) {
commentContainer.decorate(new UIStyleDecorator("backgroundHighlight"));
}
String author;
if (!anonymous) {
try {
User user = UserDirectoryService.getUser(comment.getAuthor());
author = user.getDisplayName();
} catch (Exception ex) {
author = messageLocator.getMessage("simplepage.comment-unknown-user");
ex.printStackTrace();
}
} else {
author = anonymousLookup.get(comment.getAuthor());
if (comment.getAuthor().equals(owner)) {
author = messageLocator.getMessage("simplepage.comment-author-owner");
}
if (author == null) author = "Anonymous User"; // Shouldn't ever occur
if (simplePageBean.getEditPrivs() == 0) {
try {
User user = UserDirectoryService.getUser(comment.getAuthor());
author += " (" + user.getDisplayName() + ")";
} catch (Exception ex) {
author += " (" + messageLocator.getMessage("simplepage.comment-unknown-user") + ")";
}
} else if (comment.getAuthor().equals(currentUserId)) {
author += " (" + messageLocator.getMessage("simplepage.comment-you") + ")";
}
}
UIOutput authorOutput = UIOutput.make(commentContainer, "userId", author);
if (comment.getAuthor().equals(currentUserId)) {
authorOutput.decorate(new UIStyleDecorator("specialCommenter"));
authorOutput.decorate(new UIStyleDecorator("personalComment"));
} else if (comment.getAuthor().equals(owner)) {
authorOutput.decorate(new UIStyleDecorator("specialCommenter"));
authorOutput.decorate(new UIStyleDecorator("ownerComment"));
}
if (pageTitle != null) UIOutput.make(commentContainer, "pageTitle", pageTitle);
String timeDifference = getTimeDifference(comment.getTimePosted().getTime());
UIOutput.make(commentContainer, "timePosted", timeDifference);
if (showModifiers) {
UIOutput.make(commentContainer, "deleteSpan");
CommentsViewParameters eParams = (CommentsViewParameters) params.copy();
eParams.placementId = params.placementId;
eParams.deleteComment = comment.getUUID();
eParams.pageId = params.pageId;
eParams.siteId = params.siteId;
UIInternalLink.make(commentContainer, "deleteCommentURL", eParams);
UIOutput.make(commentContainer, "deleteComment")
.decorate(
new UIFreeAttributeDecorator(
"title",
messageLocator.getMessage("simplepage.comment-delete").replace("{}", author)));
UIOutput.make(commentContainer, "editComment")
.decorate(
new UIFreeAttributeDecorator("onclick", "edit($(this), " + comment.getId() + ");"))
.decorate(
new UIFreeAttributeDecorator(
"title",
messageLocator.getMessage("simplepage.comment-edit").replace("{}", author)));
if (!filter && simplePageBean.getEditPrivs() == 0 && commentsItem.getGradebookId() != null) {
UIOutput.make(commentContainer, "gradingSpan");
UIOutput.make(commentContainer, "commentsUUID", comment.getUUID());
UIOutput.make(
commentContainer,
"commentPoints",
(comment.getPoints() == null ? "" : String.valueOf(comment.getPoints())));
UIOutput.make(commentContainer, "pointsBox")
.decorate(
new UIFreeAttributeDecorator(
"title",
messageLocator
.getMessage("simplepage.grade-for-student")
.replace("{}", author)));
UIOutput.make(commentContainer, "maxpoints", " / " + commentsItem.getGradebookPoints());
UIOutput.make(commentContainer, "authorUUID", comment.getAuthor());
}
}
if (filter && simplePageBean.getEditPrivs() == 0) {
UIOutput.make(commentContainer, "contextSpan");
// because this is called via /faces, the full Sakai context is not set up.
// in particular, UIInternalLink will generate the wrong thing. Thus we
// make up a full URL ourselves.
String pars =
"/portal/tool/"
+ URLEncoder.encode(params.placementId)
+ "/ShowPage?path=none"
+ "&author="
+ URLEncoder.encode(comment.getAuthor());
// Need to provide the item ID
if (!params.studentContentItem && params.pageItemId != -1L) {
pars += "&itemId=" + URLEncoder.encode(Long.toString(params.pageItemId));
}
UILink contextLink =
UILink.make(
commentContainer,
"contextLink",
messageLocator.getMessage("simplepage.show-context"),
pars);
if (itemToPageowner == null)
contextLink.decorate(
new UIFreeAttributeDecorator(
"title",
messageLocator
.getMessage("simplepage.context-link-title-1")
.replace("{}", author)));
else
contextLink.decorate(
new UIFreeAttributeDecorator(
"title",
messageLocator
.getMessage("simplepage.context-link-title-2")
.replace("{1}", author)
.replace("{2}", itemToPageowner.get(comment.getItemId()))));
}
String dateString = df.format(comment.getTimePosted());
if (!filter)
UIOutput.make(commentContainer, "replyTo")
.decorate(
new UIFreeAttributeDecorator(
"onclick",
"replyToComment($(this),'"
+ messageLocator
.getMessage("simplepage.in-reply-to")
.replace("{1}", author)
.replace("{2}", dateString)
+ "')"))
.decorate(
new UIFreeAttributeDecorator(
"title",
messageLocator.getMessage("simplepage.comment-reply").replace("{}", author)));
if (!comment.getHtml()) {
UIOutput.make(commentContainer, "comment", comment.getComment());
} else {
UIVerbatim.make(commentContainer, "comment", comment.getComment());
}
}
public void fillComponents(
UIContainer tofill, ViewParameters viewparams, ComponentChecker checker) {
CommentsViewParameters params = (CommentsViewParameters) viewparams;
filter = params.filter;
// set up locale
String langLoc[] = localeGetter.get().toString().split("_");
if (langLoc.length >= 2) {
if ("en".equals(langLoc[0]) && "ZA".equals(langLoc[1])) {
M_locale = new Locale("en", "GB");
} else {
M_locale = new Locale(langLoc[0], langLoc[1]);
}
} else {
M_locale = new Locale(langLoc[0]);
}
df =
DateFormat.getDateTimeInstance(
DateFormat.DEFAULT, DateFormat.DEFAULT, new ResourceLoader().getLocale());
df.setTimeZone(TimeService.getLocalTimeZone());
dfTime = DateFormat.getTimeInstance(DateFormat.SHORT, M_locale);
dfTime.setTimeZone(TimeService.getLocalTimeZone());
dfDate = DateFormat.getDateInstance(DateFormat.MEDIUM, M_locale);
dfDate.setTimeZone(TimeService.getLocalTimeZone());
// errors redirect back to ShowPage. But if this is embedded in the page, ShowPage
// will call us again. This is very hard for the user to recover from. So trap
// all possible errors. It may result in an incomplete page or something invalid,
// but better that than an infinite recursion.
try {
SimplePage currentPage = simplePageToolDao.getPage(params.pageId);
simplePageBean.setCurrentSiteId(params.siteId);
simplePageBean.setCurrentPage(currentPage);
simplePageBean.setCurrentPageId(params.pageId);
UIOutput.make(tofill, "mainlist")
.decorate(
new UIFreeAttributeDecorator(
"aria-label", messageLocator.getMessage("simplepage.comments-section")));
SimplePageItem commentsItem = simplePageToolDao.findItem(params.itemId);
if (commentsItem != null
&& commentsItem.getSakaiId() != null
&& !commentsItem.getSakaiId().equals("")) {
SimpleStudentPage studentPage =
simplePageToolDao.findStudentPage(Long.valueOf(commentsItem.getSakaiId()));
if (studentPage != null) {
owner = studentPage.getOwner();
}
}
if (params.deleteComment != null) {
simplePageBean.deleteComment(params.deleteComment);
}
List<SimplePageComment> comments;
if (!filter && !params.studentContentItem) {
comments = (List<SimplePageComment>) simplePageToolDao.findComments(params.itemId);
} else if (filter && !params.studentContentItem) {
comments =
(List<SimplePageComment>)
simplePageToolDao.findCommentsOnItemByAuthor(params.itemId, params.author);
} else if (filter && params.studentContentItem) {
List<SimpleStudentPage> studentPages = simplePageToolDao.findStudentPages(params.itemId);
Site site = SiteService.getSite(currentPage.getSiteId());
itemToPageowner = new HashMap<Long, String>();
List<Long> commentsItemIds = new ArrayList<Long>();
for (SimpleStudentPage p : studentPages) {
// If the page is deleted, don't show the comments
if (!p.isDeleted()) {
commentsItemIds.add(p.getCommentsSection());
String pageOwner = p.getOwner();
String pageGroup = p.getGroup();
if (pageGroup != null) pageOwner = pageGroup;
try {
String o = null;
if (pageGroup != null) o = site.getGroup(pageGroup).getTitle();
else o = UserDirectoryService.getUser(pageOwner).getDisplayName();
if (o != null) pageOwner = o;
} catch (Exception ignore) {
}
;
itemToPageowner.put(p.getCommentsSection(), pageOwner);
}
}
comments = simplePageToolDao.findCommentsOnItemsByAuthor(commentsItemIds, params.author);
} else {
List<SimpleStudentPage> studentPages = simplePageToolDao.findStudentPages(params.itemId);
List<Long> commentsItemIds = new ArrayList<Long>();
for (SimpleStudentPage p : studentPages) {
commentsItemIds.add(p.getCommentsSection());
}
comments = simplePageToolDao.findCommentsOnItems(commentsItemIds);
}
// Make sure everything is chronological
Collections.sort(
comments,
new Comparator<SimplePageComment>() {
public int compare(SimplePageComment c1, SimplePageComment c2) {
if (itemToPageowner != null) {
String o1 = itemToPageowner.get(c1.getItemId());
String o2 = itemToPageowner.get(c2.getItemId());
if (o1 != o2) {
if (o1 == null) return 1;
return o1.compareTo(o2);
}
}
return c1.getTimePosted().compareTo(c2.getTimePosted());
}
});
currentUserId = UserDirectoryService.getCurrentUser().getId();
boolean anonymous = simplePageBean.findItem(params.itemId).isAnonymous();
if (anonymous) {
int i = 1;
for (SimplePageComment comment : comments) {
if (!anonymousLookup.containsKey(comment.getAuthor())) {
anonymousLookup.put(
comment.getAuthor(), messageLocator.getMessage("simplepage.anonymous") + " " + i);
i++;
}
}
}
boolean highlighted = false;
// We don't want page owners to edit or grade comments on their page
// at the moment. Perhaps add option?
canEditPage = simplePageBean.getEditPrivs() == 0;
boolean showGradingMessage =
canEditPage && commentsItem.getGradebookId() != null && !params.filter;
Date lastViewed = null; // remains null if never viewed before
SimplePageLogEntry log = simplePageBean.getLogEntry(params.itemId);
if (log != null) lastViewed = log.getLastViewed();
int newItems = 0;
// Remove any "phantom" comments. So that the anonymous order stays the same,
// comments are deleted by removing all content. Also check to see if any comments
// have been graded yet. Finally, if we're filtering, it takes out comments not by
// this author.
for (int i = comments.size() - 1; i >= 0; i--) {
if (comments.get(i).getComment() == null || comments.get(i).getComment().equals("")) {
comments.remove(i);
} else if (params.filter && !comments.get(i).getAuthor().equals(params.author)) {
comments.remove(i);
} else {
if (showGradingMessage && comments.get(i).getPoints() != null) showGradingMessage = false;
if (lastViewed == null) newItems++; // all items are new if never viewed
else if (comments.get(i).getTimePosted().after(lastViewed)) newItems++;
}
}
// update date only if we actually are going to see all the comments, and it's
// not a weird view (i.e. filter is on)
// The situation with items <= 5 is actually dubious. The user has them on the
// screen, but there's no way to know whether he's actually seen them. Some users
// are going to be surprised either way we do it.
if (params.showAllComments || params.showNewComments || (!params.filter && newItems <= 5)) {
if (log != null) {
simplePageBean.update(log);
} else {
log = simplePageToolDao.makeLogEntry(currentUserId, params.itemId, null);
simplePageBean.saveItem(log);
}
}
// Make sure we don't show the grading message if there's nothing to grade.
if (comments.size() == 0) {
showGradingMessage = false;
}
boolean editable = false;
if (comments.size() <= 5 || params.showAllComments || params.filter) {
for (int i = 0; i < comments.size(); i++) {
// We don't want them editing on the grading screen, which is why we also check filter.
boolean canEdit =
simplePageBean.canModifyComment(comments.get(i), canEditPage) && !params.filter;
printComment(
comments.get(i),
tofill,
(params.postedComment == comments.get(i).getId()),
anonymous,
canEdit,
params,
commentsItem,
currentPage);
if (!highlighted) {
highlighted = (params.postedComment == comments.get(i).getId());
}
if (!editable) editable = canEdit;
}
} else {
UIBranchContainer container = UIBranchContainer.make(tofill, "commentList:");
UIOutput.make(container, "commentDiv");
// UIBranchContainer container = UIBranchContainer.make(tofill, "commentDiv:");
CommentsViewParameters eParams = new CommentsViewParameters(VIEW_ID);
eParams.placementId = params.placementId;
eParams.itemId = params.itemId;
eParams.showAllComments = true;
eParams.showNewComments = false;
eParams.pageId = params.pageId;
eParams.siteId = params.siteId;
UIInternalLink.make(container, "to-load", eParams);
UIOutput.make(
container,
"load-more-link",
messageLocator
.getMessage("simplepage.see_all_comments")
.replace("{}", Integer.toString(comments.size())));
if (!params.showNewComments && newItems > 5) {
container = UIBranchContainer.make(tofill, "commentList:");
UIOutput.make(container, "commentDiv");
// UIBranchContainer container = UIBranchContainer.make(tofill, "commentDiv:");
eParams = new CommentsViewParameters(VIEW_ID);
eParams.placementId = params.placementId;
eParams.itemId = params.itemId;
eParams.showAllComments = false;
eParams.showNewComments = true;
eParams.pageId = params.pageId;
eParams.siteId = params.siteId;
UIInternalLink.make(container, "to-load", eParams);
UIOutput.make(
container,
"load-more-link",
messageLocator
.getMessage("simplepage.see_new_comments")
.replace("{}", Integer.toString(newItems)));
}
int start = comments.size() - 5;
if (params.showNewComments) start = 0;
// Show 5 most recent comments
for (int i = start; i < comments.size(); i++) {
if (!params.showNewComments
|| lastViewed == null
|| comments.get(i).getTimePosted().after(lastViewed)) {
boolean canEdit = simplePageBean.canModifyComment(comments.get(i), canEditPage);
printComment(
comments.get(i),
tofill,
(params.postedComment == comments.get(i).getId()),
anonymous,
canEdit,
params,
commentsItem,
currentPage);
if (!highlighted) {
highlighted = (params.postedComment == comments.get(i).getId());
}
if (!editable) editable = canEdit;
}
}
}
if (highlighted) {
// We have something to highlight
UIOutput.make(tofill, "highlightScript");
}
if (showGradingMessage) {
UIOutput.make(tofill, "gradingAlert");
}
if (anonymous && canEditPage && comments.size() > 0 && lastViewed == null) {
// Tells the admin that they can see the names, but everyone else can't
UIOutput.make(tofill, "anonymousAlert");
} else if (editable && simplePageBean.getEditPrivs() != 0) {
// Warns user that they only have 30 mins to edit.
UIOutput.make(tofill, "editAlert");
}
} catch (Exception e) {
e.printStackTrace();
System.out.println("comments error " + e);
}
;
}
public void fillComponents(
UIContainer tofill, ViewParameters viewparams, ComponentChecker checker) {
CommentsGradingPaneViewParameters params = (CommentsGradingPaneViewParameters) viewparams;
SimplePage currentPage = simplePageToolDao.getPage(params.pageId);
simplePageBean.setCurrentSiteId(params.siteId);
simplePageBean.setCurrentPage(currentPage);
simplePageBean.setCurrentPageId(params.pageId);
GeneralViewParameters backParams =
new GeneralViewParameters(ShowPageProducer.VIEW_ID, params.pageId);
backParams.setItemId(params.pageItemId);
backParams.setPath("log");
UIOutput.make(tofill, "html")
.decorate(new UIFreeAttributeDecorator("lang", localeGetter.get().getLanguage()))
.decorate(new UIFreeAttributeDecorator("xml:lang", localeGetter.get().getLanguage()));
UIInternalLink.make(
tofill, "back-link", messageLocator.getMessage("simplepage.go-back"), backParams);
if (simplePageBean.getEditPrivs() != 0) {
UIOutput.make(tofill, "permissionsError");
return;
}
String heading = null;
if (params.studentContentItem) {
heading = messageLocator.getMessage("simplepage.student-comments-grading");
} else {
heading = messageLocator.getMessage("simplepage.comments-grading");
}
SimplePageItem commentItem = simplePageToolDao.findItem(params.commentsItemId);
SimplePage containingPage = simplePageToolDao.getPage(commentItem.getPageId());
heading = heading.replace("{}", containingPage.getTitle());
UIOutput.make(tofill, "page-header", heading);
List<SimplePageComment> comments;
if (!params.studentContentItem) {
comments = simplePageToolDao.findComments(params.commentsItemId);
} else {
List<SimpleStudentPage> studentPages =
simplePageToolDao.findStudentPages(params.commentsItemId);
List<Long> commentsItemIds = new ArrayList<Long>();
for (SimpleStudentPage p : studentPages) {
// If the page is deleted, don't show the comments
if (!p.isDeleted()) {
commentsItemIds.add(p.getCommentsSection());
}
}
comments = simplePageToolDao.findCommentsOnItems(commentsItemIds);
}
ArrayList<String> userIds = new ArrayList<String>();
HashMap<String, SimpleUser> users = new HashMap<String, SimpleUser>();
for (SimplePageComment comment : comments) {
if (comment.getComment() == null || comment.getComment().equals("")) {
continue;
}
if (!userIds.contains(comment.getAuthor())) {
userIds.add(comment.getAuthor());
try {
SimpleUser user = new SimpleUser();
user.displayName = UserDirectoryService.getUser(comment.getAuthor()).getDisplayName();
user.postCount++;
user.userId = comment.getAuthor();
user.grade = comment.getPoints();
user.uuid = comment.getUUID();
if (params.studentContentItem) {
user.pages.add(comment.getPageId());
}
users.put(comment.getAuthor(), user);
} catch (Exception ex) {
}
} else {
SimpleUser user = users.get(comment.getAuthor());
if (user != null) {
user.postCount++;
if (params.studentContentItem && !user.pages.contains(comment.getPageId())) {
user.pages.add(comment.getPageId());
}
}
}
}
ArrayList<SimpleUser> simpleUsers = new ArrayList<SimpleUser>(users.values());
Collections.sort(simpleUsers);
if (params.studentContentItem) {
UIOutput.make(
tofill, "unique-header", messageLocator.getMessage("simplepage.grading-unique"));
}
if (simpleUsers.size() > 0) {
UIOutput.make(tofill, "gradingTable");
} else {
UIOutput.make(tofill, "noEntriesWarning");
}
if (params.studentContentItem) UIOutput.make(tofill, "clickfiller");
UIOutput.make(tofill, "clickToSubmit", messageLocator.getMessage("simplepage.update-points"))
.decorate(
new UIFreeAttributeDecorator(
"title", messageLocator.getMessage("simplepage.update-points")));
for (SimpleUser user : simpleUsers) {
UIBranchContainer branch = UIBranchContainer.make(tofill, "student-row:");
UIOutput.make(branch, "first-row");
UIOutput.make(branch, "details-row");
UIOutput detailsCell = UIOutput.make(branch, "details-cell");
// Set the column span based on which type of item it is. Student content
// items have an extra column, so we have to accommodate.
if (params.studentContentItem) {
detailsCell.decorate(new UIFreeAttributeDecorator("colspan", "5"));
} else {
detailsCell.decorate(new UIFreeAttributeDecorator("colspan", "4"));
}
UIOutput.make(branch, "student-name", user.displayName);
UIOutput.make(branch, "student-total", String.valueOf(user.postCount));
if (params.studentContentItem) {
UIOutput.make(branch, "student-unique", String.valueOf(user.pages.size()));
}
// Add the link that will be fetched using Ajax
CommentsViewParameters eParams = new CommentsViewParameters(CommentsProducer.VIEW_ID);
eParams.placementId = ToolManager.getCurrentPlacement().getId();
eParams.itemId = params.commentsItemId;
eParams.author = user.userId;
eParams.filter = true;
eParams.pageItemId = params.pageItemId;
eParams.studentContentItem = params.studentContentItem;
eParams.siteId = simplePageBean.getCurrentSiteId();
eParams.pageId = containingPage.getPageId();
UIInternalLink.make(branch, "commentsLink", eParams);
// The grading stuff
UIOutput.make(branch, "student-grade");
UIOutput.make(branch, "gradingSpan");
UIOutput.make(branch, "commentsUUID", user.uuid);
UIOutput.make(
branch, "commentPoints", (user.grade == null ? "" : String.valueOf(user.grade)));
UIOutput.make(branch, "pointsBox")
.decorate(
new UIFreeAttributeDecorator(
"title",
messageLocator
.getMessage("simplepage.grade-for-student")
.replace("{}", user.displayName)));
UIOutput.make(
branch,
"maxpoints",
" / "
+ (params.studentContentItem
? commentItem.getAltPoints()
: commentItem.getGradebookPoints()));
UIOutput.make(
branch, "clickToExpand", messageLocator.getMessage("simplepage.click-to-expand"))
.decorate(
new UIFreeAttributeDecorator(
"title",
messageLocator
.getMessage("simplepage.expand-for-student")
.replace("{}", user.displayName)));
UIOutput.make(branch, "authorUUID", user.userId);
}
UIForm gradingForm = UIForm.make(tofill, "gradingForm");
gradingForm.viewparams = new SimpleViewParameters(UVBProducer.VIEW_ID);
UIInput idInput = UIInput.make(gradingForm, "gradingForm-id", "gradingBean.id");
UIInput jsIdInput = UIInput.make(gradingForm, "gradingForm-jsId", "gradingBean.jsId");
UIInput pointsInput = UIInput.make(gradingForm, "gradingForm-points", "gradingBean.points");
UIInput typeInput = UIInput.make(gradingForm, "gradingForm-type", "gradingBean.type");
Object sessionToken = SessionManager.getCurrentSession().getAttribute("sakai.csrf.token");
UIInput csrfInput =
UIInput.make(
gradingForm,
"csrf",
"gradingBean.csrfToken",
(sessionToken == null ? "" : sessionToken.toString()));
UIInitBlock.make(
tofill,
"gradingForm-init",
"initGradingForm",
new Object[] {
idInput, pointsInput, jsIdInput, typeInput, csrfInput, "gradingBean.results"
});
}