-
Notifications
You must be signed in to change notification settings - Fork 0
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.
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
LMSA-8397 - initial UX work to add themes and banners #44
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
197 changes: 197 additions & 0 deletions
197
src/main/java/edu/iu/uits/lms/coursesetupwizard/controller/ThemeController.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,197 @@ | ||
| package edu.iu.uits.lms.coursesetupwizard.controller; | ||
|
|
||
| import edu.iu.uits.lms.coursesetupwizard.model.ImportModel; | ||
| import edu.iu.uits.lms.lti.LTIConstants; | ||
| import edu.iu.uits.lms.lti.service.OidcTokenUtils; | ||
| import lombok.AllArgsConstructor; | ||
| import lombok.Data; | ||
| import lombok.extern.slf4j.Slf4j; | ||
| import org.springframework.security.access.annotation.Secured; | ||
| import org.springframework.stereotype.Controller; | ||
| import org.springframework.ui.Model; | ||
| import org.springframework.web.bind.annotation.GetMapping; | ||
| import org.springframework.web.bind.annotation.ModelAttribute; | ||
| import org.springframework.web.bind.annotation.PathVariable; | ||
| import org.springframework.web.bind.annotation.PostMapping; | ||
| import org.springframework.web.bind.annotation.RequestMapping; | ||
| import org.springframework.web.bind.annotation.RequestParam; | ||
| import org.springframework.web.servlet.ModelAndView; | ||
| import uk.ac.ox.ctl.lti13.security.oauth2.client.lti.authentication.OidcAuthenticationToken; | ||
|
|
||
| import javax.servlet.http.HttpSession; | ||
| import java.io.Serializable; | ||
| import java.text.MessageFormat; | ||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
|
|
||
| import static edu.iu.uits.lms.coursesetupwizard.Constants.ACTION_BACK; | ||
| import static edu.iu.uits.lms.coursesetupwizard.Constants.ACTION_HOME; | ||
| import static edu.iu.uits.lms.coursesetupwizard.Constants.ACTION_NEXT; | ||
| import static edu.iu.uits.lms.coursesetupwizard.Constants.ACTION_SUBMIT; | ||
| import static edu.iu.uits.lms.coursesetupwizard.Constants.KEY_IMPORT_MODEL; | ||
|
|
||
| @Controller | ||
| @RequestMapping("/app/theme") | ||
| @Slf4j | ||
| public class ThemeController extends WizardController { | ||
| private static final String[] PAGES = {"/app/{0}/index", "/app/theme/{0}/intro", "/app/theme/{0}/selectTheme", | ||
| "/app/theme/{0}/selectBanner", "/app/theme/{0}/navigation", "/app/theme/{0}/guidance", | ||
| "/app/theme/{0}/review", "/app/theme/{0}/submit"}; | ||
|
|
||
| @Data | ||
| @AllArgsConstructor | ||
| public static class ThemeStep implements Serializable { | ||
| private String name; | ||
| private String link; | ||
| } | ||
|
|
||
| /** | ||
| * Gets called before EVERY controller method | ||
| * @param courseId Expected to be extracted as a path variable | ||
| * @param model model | ||
| */ | ||
| @ModelAttribute | ||
| public void addCommonAttributesToModel(@PathVariable("courseId") String courseId, Model model) { | ||
| model.addAttribute("courseId", courseId); | ||
| model.addAttribute("themeSteps", getThemeSteps(courseId)); | ||
| } | ||
|
|
||
| /** | ||
| * Get the display values and links for the import wizard step indicator | ||
| * @param courseId Course ID to insert into the links | ||
| * @return | ||
| */ | ||
| private List<ThemeStep> getThemeSteps(String courseId) { | ||
| List<ThemeStep> steps = new ArrayList<>(); | ||
| steps.add(new ThemeStep("Intro", MessageFormat.format(PAGES[1], courseId))); | ||
| steps.add(new ThemeStep("Select theme", MessageFormat.format(PAGES[2], courseId))); | ||
| steps.add(new ThemeStep("Select banner", MessageFormat.format(PAGES[3], courseId))); | ||
| steps.add(new ThemeStep("Include navigation", MessageFormat.format(PAGES[4], courseId))); | ||
| steps.add(new ThemeStep("Include guidance", MessageFormat.format(PAGES[5], courseId))); | ||
| steps.add(new ThemeStep("Review", MessageFormat.format(PAGES[6], courseId))); | ||
| steps.add(new ThemeStep("Submit", MessageFormat.format(PAGES[7], courseId))); | ||
| return steps; | ||
| } | ||
|
|
||
| @GetMapping("/{courseId}/intro") | ||
| @Secured({LTIConstants.INSTRUCTOR_AUTHORITY}) | ||
| public ModelAndView intro(@PathVariable("courseId") String courseId, Model model, HttpSession httpSession) { | ||
| log.debug("in /intro"); | ||
| OidcAuthenticationToken token = getValidatedToken(courseId); | ||
| OidcTokenUtils oidcTokenUtils = new OidcTokenUtils(token); | ||
|
|
||
| return new ModelAndView("theme/intro"); | ||
| } | ||
|
|
||
| @GetMapping("/{courseId}/navigation") | ||
| @Secured({LTIConstants.INSTRUCTOR_AUTHORITY}) | ||
| public ModelAndView navigation(@PathVariable("courseId") String courseId, Model model, HttpSession httpSession) { | ||
| log.debug("in /navigation"); | ||
| OidcAuthenticationToken token = getValidatedToken(courseId); | ||
| OidcTokenUtils oidcTokenUtils = new OidcTokenUtils(token); | ||
|
|
||
| return new ModelAndView("theme/navigation"); | ||
| } | ||
|
|
||
| @GetMapping("/{courseId}/selectTheme") | ||
| @Secured({LTIConstants.INSTRUCTOR_AUTHORITY}) | ||
| public ModelAndView selectTheme(@PathVariable("courseId") String courseId, Model model, HttpSession httpSession) { | ||
| log.debug("in /selectTheme"); | ||
| OidcAuthenticationToken token = getValidatedToken(courseId); | ||
| OidcTokenUtils oidcTokenUtils = new OidcTokenUtils(token); | ||
|
|
||
| return new ModelAndView("theme/selectTheme"); | ||
| } | ||
|
|
||
| @GetMapping("/{courseId}/selectBanner") | ||
| @Secured({LTIConstants.INSTRUCTOR_AUTHORITY}) | ||
| public ModelAndView selectBanner(@PathVariable("courseId") String courseId, Model model, HttpSession httpSession) { | ||
| log.debug("in /selectBanner"); | ||
| OidcAuthenticationToken token = getValidatedToken(courseId); | ||
| OidcTokenUtils oidcTokenUtils = new OidcTokenUtils(token); | ||
|
|
||
| return new ModelAndView("theme/selectBanner"); | ||
| } | ||
|
|
||
| @GetMapping("/{courseId}/guidance") | ||
| @Secured({LTIConstants.INSTRUCTOR_AUTHORITY}) | ||
| public ModelAndView guidance(@PathVariable("courseId") String courseId, Model model, HttpSession httpSession) { | ||
| log.debug("in /guidance"); | ||
| OidcAuthenticationToken token = getValidatedToken(courseId); | ||
| OidcTokenUtils oidcTokenUtils = new OidcTokenUtils(token); | ||
|
|
||
| return new ModelAndView("theme/guidance"); | ||
| } | ||
|
|
||
| @GetMapping("/{courseId}/review") | ||
| @Secured({LTIConstants.INSTRUCTOR_AUTHORITY}) | ||
| public ModelAndView review(@PathVariable("courseId") String courseId, Model model, HttpSession httpSession) { | ||
| log.debug("in /review"); | ||
| OidcAuthenticationToken token = getValidatedToken(courseId); | ||
| OidcTokenUtils oidcTokenUtils = new OidcTokenUtils(token); | ||
|
|
||
| return new ModelAndView("theme/review"); | ||
| } | ||
|
|
||
| @GetMapping("/{courseId}/submit") | ||
| @Secured({LTIConstants.INSTRUCTOR_AUTHORITY}) | ||
| public ModelAndView submit(@PathVariable("courseId") String courseId, Model model, HttpSession httpSession) { | ||
| log.debug("in /submit"); | ||
| OidcAuthenticationToken token = getValidatedToken(courseId); | ||
| OidcTokenUtils oidcTokenUtils = new OidcTokenUtils(token); | ||
|
|
||
| return new ModelAndView("theme/submit"); | ||
| } | ||
|
|
||
| @PostMapping("/{courseId}/navigate") | ||
| @Secured({LTIConstants.INSTRUCTOR_AUTHORITY}) | ||
| public ModelAndView navigate(@PathVariable("courseId") String courseId, Model model, @ModelAttribute ImportModel importModel, | ||
| @RequestParam(name = "action") String action, @RequestParam(name = "currentPage") int currentPage, | ||
| HttpSession httpSession) { | ||
| OidcAuthenticationToken token = getValidatedToken(courseId); | ||
| OidcTokenUtils oidcTokenUtils = new OidcTokenUtils(token); | ||
|
|
||
| // ImportModel sessionImportModel = courseSessionService.getAttributeFromSession(httpSession, courseId, KEY_IMPORT_MODEL, ImportModel.class); | ||
|
|
||
| int pageIndex = 0; | ||
|
|
||
| switch (action) { | ||
| case ACTION_HOME: | ||
| //Reset stuff | ||
| courseSessionService.removeAttributeFromSession(httpSession, courseId, KEY_IMPORT_MODEL); | ||
| break; | ||
| case ACTION_BACK: | ||
| pageIndex = currentPage - 1; | ||
| break; | ||
| case ACTION_NEXT: | ||
| pageIndex = currentPage + 1; | ||
|
|
||
| //Template selection page | ||
| // if (importModel.getSelectedTemplateId() != null) { | ||
| // sessionImportModel.setSelectedTemplateId(importModel.getSelectedTemplateId()); | ||
| // sessionImportModel.setSelectedTemplateName(importModel.getSelectedTemplateName()); | ||
| // } | ||
|
|
||
| //Re-save the session model | ||
| // courseSessionService.addAttributeToSession(httpSession, courseId, KEY_IMPORT_MODEL, sessionImportModel); | ||
| break; | ||
| case ACTION_SUBMIT: | ||
| // String templateHostingUrl = toolConfig.getTemplateHostingUrl(); | ||
| // // Use the current application as the template host if no other has been configured. | ||
| // if (templateHostingUrl == null) { | ||
| // templateHostingUrl = ServletUriComponentsBuilder.fromCurrentContextPath().build().toUriString(); | ||
| // } | ||
| // try { | ||
| // wizardService.doApplyTemplate(sessionImportModel, oidcTokenUtils.getUserLoginId(), templateHostingUrl); | ||
| // model.addAttribute("redirectUrl", getCanvasContentMigrationsToolUrl(courseId)); | ||
| // // redirect to the Canvas tool | ||
| // return new ModelAndView(redirectToCanvas()); | ||
| // } catch (WizardServiceException e) { | ||
| // model.addAttribute("submitError", e.getMessage()); | ||
| // return review(courseId, model, httpSession); | ||
| // } | ||
| } | ||
| String url = MessageFormat.format(PAGES[pageIndex], courseId); | ||
| return new ModelAndView("redirect:" + url); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Check failure
Code scanning / CodeQL
URL forward from a remote source High