Skip to content
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

SAK-50950 Assignments support sub page navigation #13274

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from
Draft

SAK-50950 Assignments support sub page navigation #13274

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0c8c38f
SAK-50950 Assignments support sub page navigation
ern Feb 3, 2025
057c865
add missing deps
ern Feb 3, 2025
c48b318
update prequisites logic
ern Feb 4, 2025
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
8 changes: 8 additions & 0 deletions assignment/impl/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,10 @@
<groupId>org.sakaiproject.tags</groupId>
<artifactId>tags-api</artifactId>
</dependency>
<dependency>
<groupId>org.sakaiproject.portal</groupId>
<artifactId>sakai-portal-api</artifactId>
</dependency>
<dependency>
<groupId>commons-codec</groupId>
<artifactId>commons-codec</artifactId>
Expand Down Expand Up @@ -138,6 +142,10 @@
<groupId>org.springframework</groupId>
<artifactId>spring-test</artifactId>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-web</artifactId>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-core</artifactId>
Expand Down
96 changes: 90 additions & 6 deletions assignment/impl/src/java/org/sakaiproject/assignment/impl/AssignmentServiceImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
import java.time.Instant;
import java.time.ZonedDateTime;
import java.time.format.DateTimeFormatter;
import java.time.format.FormatStyle;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
Expand All @@ -46,7 +47,6 @@
import java.util.HashSet;
import java.util.Iterator;
import java.util.LinkedHashSet;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
Expand Down Expand Up @@ -105,7 +105,6 @@
import org.sakaiproject.authz.api.Member;
import org.sakaiproject.authz.api.SecurityAdvisor;
import org.sakaiproject.authz.api.SecurityService;
import org.sakaiproject.lti.util.SakaiLTIUtil;
import org.sakaiproject.calendar.api.Calendar;
import org.sakaiproject.calendar.api.CalendarEvent;
import org.sakaiproject.calendar.api.CalendarService;
Expand Down Expand Up @@ -148,7 +147,9 @@
import org.sakaiproject.grading.api.GradebookInformation;
import org.sakaiproject.grading.api.GradingService;
import org.sakaiproject.lti.api.LTIService;
import org.sakaiproject.util.foorm.Foorm;
import org.sakaiproject.portal.api.PortalService;
import org.sakaiproject.portal.api.PortalSubPageData;
import org.sakaiproject.portal.api.PortalSubPageNavProvider;
import org.sakaiproject.messaging.api.Message;
import org.sakaiproject.messaging.api.MessageMedium;
import org.sakaiproject.messaging.api.UserMessagingService;
Expand All @@ -157,6 +158,7 @@
import org.sakaiproject.search.api.SearchService;
import org.sakaiproject.site.api.Group;
import org.sakaiproject.site.api.Site;
import org.sakaiproject.site.api.SitePage;
import org.sakaiproject.site.api.SiteService;
import org.sakaiproject.site.api.ToolConfiguration;
import org.sakaiproject.taggable.api.TaggingManager;
Expand Down Expand Up @@ -190,6 +192,7 @@
import org.springframework.transaction.support.TransactionCallbackWithoutResult;
import org.springframework.transaction.support.TransactionTemplate;
import org.springframework.util.Assert;
import org.springframework.web.util.UriComponentsBuilder;
import org.w3c.dom.CDATASection;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
Expand All @@ -207,7 +210,7 @@
*/
@Slf4j
@Transactional(readOnly = true)
public class AssignmentServiceImpl implements AssignmentService, EntityTransferrer, ContentExistsAware, ApplicationContextAware {
public class AssignmentServiceImpl implements ApplicationContextAware, AssignmentService, ContentExistsAware, EntityTransferrer, PortalSubPageNavProvider {

@Setter private AnnouncementService announcementService;
@Setter private ApplicationContext applicationContext;
Expand All @@ -230,6 +233,7 @@ public class AssignmentServiceImpl implements AssignmentService, EntityTransferr
@Setter private GradingService gradingService;
@Setter private LearningResourceStoreService learningResourceStoreService;
@Setter private LinkMigrationHelper linkMigrationHelper;
@Setter private PortalService portalService;
@Setter private TransactionTemplate transactionTemplate;
@Setter private ResourceLoader resourceLoader;
@Setter private RubricsService rubricsService;
Expand Down Expand Up @@ -266,6 +270,7 @@ public void init() {
exposeContentReviewErrorsToUI = serverConfigurationService.getBoolean("contentreview.expose.errors.to.ui", true);
createGroupsOnImport = serverConfigurationService.getBoolean("assignment.create.groups.on.import", true);

portalService.registerSubPageNavProvider(this);
// register as an entity producer
entityManager.registerEntityProducer(this, REFERENCE_ROOT);

Expand Down Expand Up @@ -294,6 +299,11 @@ public boolean isTimeSheetEnabled(String siteId) {
return timeSheetService.isTimeSheetEnabled(siteId);
}

@Override
public String getSubPageProviderName() {
return getToolId();
}

@Override
public String getLabel() {
return "assignment";
Expand Down Expand Up @@ -417,6 +427,80 @@ public String archive(String siteId, Document doc, Stack<Element> stack, String
return results.toString();
}

@Override
public void getSubPageData(PortalSubPageData data, Collection<String> pageIds) {
String siteId = data.getSiteId();
for (String pageId : pageIds) {
String toolId = siteService.getOptionalSite(siteId)
.map(site -> site.getPage(pageId))
.filter(Objects::nonNull)
.map(SitePage::getTools)
.filter(tools -> !tools.isEmpty())
.map(tools -> tools.get(0).getId())
.orElse("");

if (toolId.isEmpty()) {
log.warn("could not fetch tool id on page [{}], in site [{}]", pageId, siteId);
continue;
}

data.getPages().computeIfAbsent(toolId, key -> new ArrayList<>());

Collection<Assignment> assignments = getAssignmentsForContext(siteId);
for (Assignment assignment : assignments) {
String assignmentReference = AssignmentReferenceReckoner.reckoner().assignment(assignment).reckon().getReference();
PortalSubPageData.PageData pageData = new PortalSubPageData.PageData();
pageData.setSiteId(siteId);
pageData.setToolId(toolId);
pageData.setItemId(assignment.getId());
pageData.setName(assignment.getTitle());
pageData.setDescription(assignment.getInstructions());
pageData.setDisabled(assignment.getDeleted() || assignment.getDraft());
pageData.setHidden(assignment.getDeleted() || assignment.getDraft());

DateTimeFormatter dtf = DateTimeFormatter.ofLocalizedDateTime(FormatStyle.SHORT).withLocale(rb.getLocale());
ZonedDateTime zonedDateTime = ZonedDateTime.ofInstant(assignment.getOpenDate(), userTimeService.getLocalTimeZone().toZoneId());
pageData.setReleaseDate(dtf.format(zonedDateTime));

UriComponentsBuilder uriBuilder = UriComponentsBuilder.fromHttpUrl(serverConfigurationService.getPortalUrl());
uriBuilder.pathSegment("site", pageData.getSiteId(), "tool", toolId);
uriBuilder.queryParam("assignmentId", assignmentReference);
uriBuilder.queryParam("panel", "Main");
uriBuilder.queryParam("sakai_action", "doView_assignment");
pageData.setUrl(uriBuilder.build().toUriString());

data.getPages().get(toolId).add(pageData);

}
PortalSubPageData.PageProps pageProps = new PortalSubPageData.PageProps();
pageProps.setToolId(toolId);
pageProps.setSiteId(siteId);
pageProps.setName("Assignments");
pageProps.setIcon("si-sakai-assignment-grades");
data.getTopLevelPageProps().add(pageProps);
}

// TODO this needs translating
PortalSubPageData.I18n i18n = data.getI18n();
i18n.setExpand("Expand to show subpages");
i18n.setCollapse("Collapse to hide subpages");
i18n.setOpenTopLevelPage("Click to open top-level page");
i18n.setHidden("[Hidden]");
i18n.setHiddenWithReleaseDate("[Not released until {releaseDate}]");
i18n.setMainLinkName("List of Assignments");
i18n.setPrerequisite("[Has prerequisites]");
i18n.setPrerequisiteAndDisabled("[You must complete all prerequisites before viewing this item]");
// i18n.setExpand(rb.getString(""));
// i18n.setCollapse(rb.getString(""));
// i18n.setOpenTopLevelPage(rb.getString(""));
// i18n.setHidden(rb.getString(""));
// i18n.setHiddenWithReleaseDate(rb.getString(""));
// i18n.setMainLinkName(rb.getString(""));
// i18n.setPrerequisite(rb.getString(""));
// i18n.setPrerequisiteAndDisabled(rb.getString(""));

}

private void addSupplementaryItemAttachments(Document doc, Element item, List<String> itemAttachments, List archiveAttachments) {

if (itemAttachments.isEmpty()) {
Expand Down Expand Up @@ -3043,7 +3127,7 @@ public String getGradeDisplay(String grade, Assignment.GradeType typeOfGrade, In
switch (typeOfGrade) {
case SCORE_GRADE_TYPE:
if (!returnGrade.isEmpty() && !"0".equals(returnGrade)) {
int dec = new Double(Math.log10(scaleFactor)).intValue();
int dec = Double.valueOf(Math.log10(scaleFactor)).intValue();
String decSeparator = formattedText.getDecimalSeparator();
String decimalGradePoint = returnGrade;
try {
Expand Down Expand Up @@ -4699,7 +4783,7 @@ private LRS_Result getLRS_Result(Assignment a, AssignmentSubmission s, boolean c
String gradeDisplay = StringUtils.replace(getGradeDisplay(s.getGrade(), a.getTypeOfGrade(), a.getScaleFactor()), decSeparator, ".");
if (Assignment.GradeType.SCORE_GRADE_TYPE == a.getTypeOfGrade() && NumberUtils.isCreatable(gradeDisplay)) { // Points
String maxGradePointDisplay = StringUtils.replace(getMaxPointGradeDisplay(a.getScaleFactor(), a.getMaxGradePoint()), decSeparator, ".");
result = new LRS_Result(new Float(gradeDisplay), 0.0f, new Float(maxGradePointDisplay), null);
result = new LRS_Result(Float.parseFloat(gradeDisplay), 0.0f, Float.parseFloat(maxGradePointDisplay), null);
result.setCompletion(completed);
} else {
result = new LRS_Result(completed);
Expand Down
6 changes: 6 additions & 0 deletions assignment/impl/src/test/org/sakaiproject/assignment/impl/AssignmentTestConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@
import org.sakaiproject.hibernate.AssignableUUIDGenerator;
import org.sakaiproject.lti.api.LTIService;
import org.sakaiproject.messaging.api.UserMessagingService;
import org.sakaiproject.portal.api.PortalService;
import org.sakaiproject.rubrics.api.RubricsService;
import org.sakaiproject.search.api.SearchIndexBuilder;
import org.sakaiproject.search.api.SearchService;
Expand Down Expand Up @@ -272,6 +273,11 @@ public LinkMigrationHelper linkMigrationHelper() {
return mock(LinkMigrationHelper.class);
}

@Bean(name = "org.sakaiproject.portal.api.PortalService")
public PortalService portalService() {
return mock(PortalService.class);
}

@Bean(name = "org.sakaiproject.time.api.UserTimeService")
public UserTimeService userTimeService() {
return mock(UserTimeService.class);
Expand Down
1 change: 1 addition & 0 deletions assignment/impl/src/webapp/WEB-INF/components.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
<property name="gradingService" ref="org.sakaiproject.grading.api.GradingService"/>
<property name="learningResourceStoreService" ref="org.sakaiproject.event.api.LearningResourceStoreService"/>
<property name="linkMigrationHelper" ref="org.sakaiproject.util.api.LinkMigrationHelper"/>
<property name="portalService" ref="org.sakaiproject.portal.api.PortalService"/>
<property name="transactionTemplate">
<bean class="org.springframework.transaction.support.TransactionTemplate">
<property name="transactionManager" ref="org.sakaiproject.springframework.orm.hibernate.GlobalTransactionManager"/>
Expand Down
4 changes: 4 additions & 0 deletions lessonbuilder/api/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,10 @@
<groupId>org.hibernate</groupId>
<artifactId>hibernate-core</artifactId>
</dependency>
<dependency>
<groupId>org.sakaiproject.portal</groupId>
<artifactId>sakai-portal-api</artifactId>
</dependency>
</dependencies>
<build>
<resources>
Expand Down
4 changes: 2 additions & 2 deletions lessonbuilder/api/src/java/org/sakaiproject/lessonbuildertool/model/SimplePageToolDao.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
import java.util.List;
import java.util.Map;
import java.util.Collection;
import java.util.Optional;

import org.sakaiproject.lessonbuildertool.SimplePage;
import org.sakaiproject.lessonbuildertool.SimplePageComment;
Expand All @@ -45,6 +44,7 @@
import org.sakaiproject.lessonbuildertool.SimpleChecklistItem;
import org.sakaiproject.lessonbuildertool.ChecklistItemStatus;

import org.sakaiproject.portal.api.PortalSubPageData;
import org.sakaiproject.site.api.ToolConfiguration;

import org.springframework.orm.hibernate5.HibernateTemplate;
Expand Down Expand Up @@ -334,7 +334,7 @@ public class PageData {

public boolean doesPageFolderExist(final String siteId, final String folder);

public String getLessonSubPageJSON(String userId, String siteId, Collection<String> pageIds);
public void getLessonSubPageData(PortalSubPageData data, Collection<String> pageIds);

public List<SimplePage> getTopLevelPages(String siteId);

Expand Down
4 changes: 4 additions & 0 deletions lessonbuilder/components/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,10 @@
<groupId>org.springframework</groupId>
<artifactId>spring-orm</artifactId>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-web</artifactId>
</dependency>
<dependency>
<groupId>com.googlecode.json-simple</groupId>
<artifactId>json-simple</artifactId>
Expand Down
Loading
Loading