SAK-32608: Extend CandidateDetailProvider to provide institutional numeric ids (student numbers) for use in Gradebook (sakaiproject#4496)

* SAK-32608: Extend CandidateDetailProvider to provide institutional numeric ids (student numbers) for use in Gradebook

* SAK-32608: fixed issue with category column positioning when student number column is visible

* SAK-32608: added api method to bypass candidate student number visibility permission to facilitate business cases that require the number

Author: plukasew

edu-services/gradebook-service/api/src/java/org/sakaiproject/service/gradebook/shared/GradebookService.java

@@ -583,6 +583,12 @@ public boolean isAssignmentDefined(String gradebookUid, String assignmentTitle)
 	 */
 	public boolean currentUserHasViewOwnGradesPerm(String gradebookUid);
 
+	/**
+	 * @param gradebookUid
+	 * @return true if the current user has the gradebook.viewStudentNumbers permission 
+	 */
+	public boolean currentUserHasViewStudentNumbersPerm(String gradebookUid);
+	
 	/**
 	 * Get the grade records for the given list of students and the given assignment.
 	 * This can only be called by an instructor or TA that has access, not student.

edu-services/gradebook-service/api/src/java/org/sakaiproject/tool/gradebook/facades/Authz.java

@@ -35,6 +35,7 @@ public interface Authz {
 	public boolean isUserAbleToGradeAll(String gradebookUid, String userUid);
 	public boolean isUserAbleToEditAssessments(String gradebookUid);
 	public boolean isUserAbleToViewOwnGrades(String gradebookUid);
+	public boolean isUserAbleToViewStudentNumbers(String gradebookUid);
 	public boolean isUserHasGraderPermissions(String gradebookUid);
 	public boolean isUserHasGraderPermissions(Long gradebookId);
 	public boolean isUserHasGraderPermissions(Long gradebookId, String userUid);

edu-services/gradebook-service/impl/src/java/org/sakaiproject/component/gradebook/GradebookServiceHibernateImpl.java

@@ -1742,6 +1742,12 @@ public boolean currentUserHasViewOwnGradesPerm(String gradebookUid) {
 	  return authz.isUserAbleToViewOwnGrades(gradebookUid);
   }
 
+  @Override
+  public boolean currentUserHasViewStudentNumbersPerm(String gradebookUid)
+  {
+	  return authz.isUserAbleToViewStudentNumbers(gradebookUid);
+  }
+  
   @Override
   public List<GradeDefinition> getGradesForStudentsForItem(final String gradebookUid, final Long gradableObjectId, List<String> studentIds) {
 	  if (gradableObjectId == null) {

edu-services/gradebook-service/impl/src/java/org/sakaiproject/tool/gradebook/facades/sakai2impl/AuthzSakai2Impl.java

@@ -53,7 +53,8 @@ public class AuthzSakai2Impl extends AuthzSectionsImpl implements Authz {
     	PERMISSION_GRADE_ALL = "gradebook.gradeAll",
     	PERMISSION_GRADE_SECTION = "gradebook.gradeSection",
     	PERMISSION_EDIT_ASSIGNMENTS = "gradebook.editAssignments",
-    	PERMISSION_VIEW_OWN_GRADES = "gradebook.viewOwnGrades";
+    	PERMISSION_VIEW_OWN_GRADES = "gradebook.viewOwnGrades",
+        PERMISSION_VIEW_STUDENT_NUMBERS = "gradebook.viewStudentNumbers";
 
     /**
      * Perform authorization-specific framework initializations for the Gradebook.
@@ -75,6 +76,10 @@ public void init() {
         if(!registered.contains(PERMISSION_VIEW_OWN_GRADES)) {
             FunctionManager.registerFunction(PERMISSION_VIEW_OWN_GRADES);
         }
+
+        if(!registered.contains(PERMISSION_VIEW_STUDENT_NUMBERS)) {
+            FunctionManager.registerFunction(PERMISSION_VIEW_STUDENT_NUMBERS);
+        }
     }
 
 	public boolean isUserAbleToGrade(String gradebookUid) {
@@ -123,6 +128,11 @@ public boolean isUserAbleToEditAssessments(String gradebookUid) {
 	public boolean isUserAbleToViewOwnGrades(String gradebookUid) {
 		return hasPermission(gradebookUid, PERMISSION_VIEW_OWN_GRADES);
 	}
+	
+	public boolean isUserAbleToViewStudentNumbers(String gradebookUid)
+	{
+		return hasPermission(gradebookUid, PERMISSION_VIEW_STUDENT_NUMBERS);
+	}
 
 	private boolean hasPermission(String gradebookUid, String permission) {
 		return SecurityService.unlock(permission, SiteService.siteReference(gradebookUid));

edu-services/gradebook-service/impl/src/java/org/sakaiproject/tool/gradebook/facades/sections/AuthzSectionsImpl.java

@@ -116,6 +116,12 @@ public boolean isUserAbleToViewOwnGrades(String gradebookUid) {
 		return getSectionAwareness().isSiteMemberInRole(gradebookUid, userUid, Role.STUDENT);
 	}
 
+	public boolean isUserAbleToViewStudentNumbers(String gradebookUid)
+	{
+		String userUid = authn.getUserUid();
+		return getSectionAwareness().isSiteMemberInRole(gradebookUid, userUid, Role.INSTRUCTOR);
+	}
+	
 	public String getGradeViewFunctionForUserForStudentForItem(String gradebookUid, Long itemId, String studentUid) {
 		if (itemId == null || studentUid == null || gradebookUid == null) {
 			throw new IllegalArgumentException("Null parameter(s) in AuthzSectionsServiceImpl.isUserAbleToGradeItemForStudent");

gradebookng/tool/src/java/org/sakaiproject/gradebookng/GradebookNgApplication.properties

@@ -70,6 +70,7 @@ error.concurrentedit=Concurrent edits have been detected. Refresh the tool to se
 
 column.header.section = Section
 column.header.students = Students
+column.header.studentNumber = Student Number
 column.header.coursegrade = Course Grade
 
 filter.students = Filter students
@@ -246,6 +247,7 @@ importExport.export.advancedOption.description = Select from the options below t
 importExport.export.advancedOption.warning = Customized exports can only be imported back into the system if Student ID and Student Name are retained in the first and second columns and all other formatting conventions are followed.
 importExport.export.advancedOption.exportFormat = Export File Format
 importExport.export.advancedOption.includeStudentName = Student Name
+importExport.export.advancedOption.includeStudentNumber = Student Number
 importExport.export.advancedOption.includePoints = Total Points
 importExport.export.advancedOption.includeLastLogDate = Last Log Date
 importExport.export.advancedOption.includeCourseGrade = Course Grade
@@ -256,6 +258,7 @@ importExport.export.advancedOption.includeGradeItemScores = Gradebook Item Score
 importExport.export.advancedOption.includeGradeItemComments = Gradebook Item Comments
 importExport.export.csv.headers.studentId = Student ID
 importExport.export.csv.headers.studentName = Student Name
+importExport.export.csv.headers.studentNumber = Student Number
 importExport.export.csv.headers.points = Total Points
 importExport.export.csv.headers.courseGrade = Course Grade
 importExport.export.csv.headers.calculatedGrade = Calculated Grade

gradebookng/tool/src/java/org/sakaiproject/gradebookng/business/GradebookNgBusinessService.java

@@ -12,6 +12,7 @@
 import java.util.List;
 import java.util.Locale;
 import java.util.Map;
+import java.util.Optional;
 import java.util.Set;
 import java.util.TreeMap;
 import java.util.stream.Collectors;
@@ -70,6 +71,7 @@
 
 import lombok.Setter;
 import lombok.extern.slf4j.Slf4j;
+import org.sakaiproject.user.api.CandidateDetailProvider;
 
 /**
  * Business service for GradebookNG
@@ -114,6 +116,9 @@ public class GradebookNgBusinessService {
 
 	@Setter
 	private SecurityService securityService;
+	
+	@Setter
+	private CandidateDetailProvider candidateDetailProvider;
 
 	@Setter
 	private ServerConfigurationService serverConfigurationService;
@@ -684,6 +689,8 @@ public List<GbStudentGradeInfo> buildGradeMatrix(final List<Assignment> assignme
 		} catch (final GbAccessDeniedException e) {
 			throw new GbException("Error getting role for current user", e);
 		}
+		
+		Optional<Site> site = getCurrentSite();
 
 		// get uuids as list of Users.
 		// this gives us our base list and will be sorted as per our desired
@@ -701,6 +708,18 @@ public List<GbStudentGradeInfo> buildGradeMatrix(final List<Assignment> assignme
 			}
 			Collections.sort(students, comp);
 		}
+		else if (settings.getStudentNumberSortOrder() != null)
+		{
+			if (site.isPresent())
+			{
+				Comparator<User> comp = new StudentNumberComparator(candidateDetailProvider, site.get());
+				if (SortDirection.DESCENDING.equals(settings.getStudentNumberSortOrder()))
+				{
+					comp = Collections.reverseOrder(comp);
+				}
+				Collections.sort(students, comp);
+			}
+		}
 		stopwatch.timeWithContext("buildGradeMatrix", "sortUsers", stopwatch.getTime());
 
 		// get course grades
@@ -727,7 +746,7 @@ public List<GbStudentGradeInfo> buildGradeMatrix(final List<Assignment> assignme
 		for (final User student : students) {
 
 			// create and add the user info
-			final GbStudentGradeInfo sg = new GbStudentGradeInfo(student);
+			final GbStudentGradeInfo sg = new GbStudentGradeInfo(student, getStudentNumber(student, site.orElse(null)));
 
 			// add the course grade, including the display
 			final CourseGrade courseGrade = courseGrades.get(student.getId());
@@ -1112,6 +1131,29 @@ public String getCurrentSiteId() {
 			return null;
 		}
 	}
+	
+	/**
+	 * Helper to get site. This will ONLY work in a portal site context, it will return empty otherwise (ie via an entityprovider).
+	 *
+	 * @return
+	 */
+	public Optional<Site> getCurrentSite()
+	{
+		String siteId = getCurrentSiteId();
+		if (siteId != null)
+		{
+			try
+			{
+				return Optional.of(siteService.getSite(siteId));
+			}
+			catch (IdUnusedException e)
+			{
+				// do nothing
+			}
+		}
+
+		return Optional.empty();
+	}
 
 	/**
 	 * Helper to get user
@@ -1821,6 +1863,29 @@ public boolean isCourseGradeVisible(final String userUuid) {
 		log.warn("User: " + userUuid + " does not have a valid Gradebook related role in site: " + siteId);
 		return false;
 	}
+	
+	/**
+	 * Are student numbers visible to the current user in the current site?
+	 * 
+	 * @return true if student numbers are visible
+	 */
+	public boolean isStudentNumberVisible()
+	{
+		User user = getCurrentUser();
+		Optional<Site> site = getCurrentSite();
+		return user != null && site.isPresent() && candidateDetailProvider.isInstitutionalNumericIdEnabled(site.get())
+				&& gradebookService.currentUserHasViewStudentNumbersPerm(getGradebook().getUid());
+	}
+	
+	public String getStudentNumber(User u, Site site)
+	{
+		if (site == null)
+		{
+			return "";
+		}
+			
+		return candidateDetailProvider.getInstitutionalNumericId(u, site).orElse("");
+	}
 
 	/**
 	 * Build a list of group references to site membership (as uuids) for the groups that are viewable for the current user.

gradebookng/tool/src/java/org/sakaiproject/gradebookng/business/StudentNumberComparator.java

@@ -0,0 +1,26 @@
+package org.sakaiproject.gradebookng.business;
+
+import java.util.Comparator;
+import lombok.RequiredArgsConstructor;
+import org.sakaiproject.site.api.Site;
+import org.sakaiproject.user.api.CandidateDetailProvider;
+import org.sakaiproject.user.api.User;
+
+/**
+ * Comparator class for sorting a list of users by student number
+ * @author plukasew
+ */
+@RequiredArgsConstructor
+public class StudentNumberComparator implements Comparator<User>
+{
+	private final CandidateDetailProvider provider;
+	private final Site site;
+	
+	@Override
+	public int compare(final User u1, final User u2)
+	{
+		String stunum1 = provider.getInstitutionalNumericId(u1, site).orElse("");
+		String stunum2 = provider.getInstitutionalNumericId(u2, site).orElse("");
+		return stunum1.compareTo(stunum2);
+	}
+}

gradebookng/tool/src/java/org/sakaiproject/gradebookng/business/model/GbStudentGradeInfo.java

@@ -32,6 +32,9 @@ public class GbStudentGradeInfo implements Serializable {
 
 	@Getter
 	private String studentEid;
+	
+	@Getter
+	private String studentNumber;
 
 	@Getter
 	@Setter
@@ -46,12 +49,17 @@ public class GbStudentGradeInfo implements Serializable {
 	public GbStudentGradeInfo() {
 	}
 
-	public GbStudentGradeInfo(final User u) {
+	public GbStudentGradeInfo(final User u)
+	{
+		this(u, "");
+	}
+	public GbStudentGradeInfo(final User u, final String studentNumber) {
 		this.studentUuid = u.getId();
 		this.studentEid = u.getEid();
 		this.studentFirstName = u.getFirstName();
 		this.studentLastName = u.getLastName();
 		this.studentDisplayName = u.getDisplayName();
+		this.studentNumber = studentNumber;
 		this.grades = new HashMap<Long, GbGradeInfo>();
 		this.categoryAverages = new HashMap<Long, Double>();
 	}

gradebookng/tool/src/java/org/sakaiproject/gradebookng/tool/component/GbHeadersToolbar.html

@@ -1,6 +1,6 @@
 <wicket:panel xmlns:wicket="http://wicket.apache.org">
 	<tr wicket:id="categoriesRow" class="gb-categories-row" role="row">
-		<th colspan="3"><!-- empty --></th>
+		<th wicket:id="empty"><!-- empty --></th>
 		<th wicket:id="categories" scope="col" role="columnheader">
 			<span class="gb-category-label">
 				<span wicket:id="extraCreditCategoryFlag" class="gb-category-extra-credit"></span>

gradebookng/tool/src/java/org/sakaiproject/gradebookng/tool/component/GbHeadersToolbar.java

@@ -15,6 +15,7 @@
 import org.apache.wicket.markup.html.list.ListItem;
 import org.apache.wicket.markup.html.list.ListView;
 import org.apache.wicket.model.IModel;
+import org.apache.wicket.model.Model;
 import org.apache.wicket.model.StringResourceModel;
 import org.sakaiproject.gradebookng.business.GbCategoryType;
 import org.sakaiproject.gradebookng.business.util.FormatHelper;
@@ -44,6 +45,10 @@ public void onInitialize() {
 
 		if (categoriesEnabled && settings.isCategoriesEnabled()) {
 			final WebMarkupContainer categoriesRow = new WebMarkupContainer("categoriesRow");
+			
+			final Label emptyCat = new Label("empty", Model.of(""));
+			emptyCat.add(new AttributeModifier("colspan", (Integer) modelData.get("fixedColCount")));
+			categoriesRow.add(emptyCat);
 
 			final List<Assignment> assignments = (List<Assignment>) modelData.get("assignments");
 			List<CategoryDefinition> categories = (List<CategoryDefinition>) modelData.get("categories");

gradebookng/tool/src/java/org/sakaiproject/gradebookng/tool/model/GradebookUiSettings.java

@@ -68,6 +68,12 @@ public class GradebookUiSettings implements Serializable {
 	 */
 	@Getter
 	private SortDirection studentSortOrder;
+	
+	/**
+	 * The direction to sort the student number column
+	 */
+	@Getter
+	private SortDirection studentNumberSortOrder;
 
 	/**
 	 * For sorting based on coursegrade
@@ -187,12 +193,19 @@ public void setStudentSortOrder(SortDirection sortOrder) {
 		resetSortOrder();
 		this.studentSortOrder = sortOrder;
 	}
+	
+	public void setStudentNumberSortOrder(SortDirection sortOrder)
+	{
+		resetSortOrder();
+		studentNumberSortOrder = sortOrder;
+	}
 
 	private void resetSortOrder() {
 		this.courseGradeSortOrder = null;
 		this.categorySortOrder = null;
 		this.assignmentSortOrder = null;
 		this.studentSortOrder = null;
+		studentNumberSortOrder = null;
 	}
 
 	@Override