feat: Refactoring of CurrentUserService and introduction of UserDetails and more

dhis-2/dhis-api/src/main/java/org/hisp/dhis/category/CategoryOptionStore.java

@@ -29,13 +29,13 @@
 
 import java.util.List;
 import org.hisp.dhis.common.IdentifiableObjectStore;
-import org.hisp.dhis.user.User;
+import org.hisp.dhis.user.UserDetails;
 
 /**
  * @author Lars Helge Overland
  */
 public interface CategoryOptionStore extends IdentifiableObjectStore<CategoryOption> {
   List<CategoryOption> getCategoryOptions(Category category);
 
-  List<CategoryOption> getDataWriteCategoryOptions(Category category, User user);
+  List<CategoryOption> getDataWriteCategoryOptions(Category category, UserDetails userDetails);
 }

dhis-2/dhis-api/src/main/java/org/hisp/dhis/category/CategoryService.java

@@ -36,6 +36,7 @@
 import org.hisp.dhis.dataelement.DataElementOperand;
 import org.hisp.dhis.dataset.DataSet;
 import org.hisp.dhis.user.User;
+import org.hisp.dhis.user.UserDetails;
 
 /**
  * @author Abyot Asalefew
@@ -55,13 +56,17 @@ public interface CategoryService {
    */
   long addCategory(Category category);
 
+  long addCategory(Category category, UserDetails actingUser);
+
   /**
    * Updates a Category.
    *
    * @param category the Category to update.
    */
   void updateCategory(Category category);
 
+  void updateCategory(Category category, UserDetails actingUser);
+
   /**
    * Deletes a Category. The Category is also removed from any CategoryCombos if it is a member of.
    * It is not possible to delete a Category with options.
@@ -143,13 +148,17 @@ public interface CategoryService {
    */
   long addCategoryOption(CategoryOption dataElementCategoryOption);
 
+  long addCategoryOption(CategoryOption dataElementCategoryOption, UserDetails actingUser);
+
   /**
    * Updates a CategoryOption.
    *
    * @param dataElementCategoryOption the CategoryOption to update.
    */
   void updateCategoryOption(CategoryOption dataElementCategoryOption);
 
+  void updateCategoryOption(CategoryOption dataElementCategoryOption, UserDetails actingUser);
+
   /**
    * Deletes a CategoryOption.
    *
@@ -203,7 +212,7 @@ public interface CategoryService {
    * @param user to check data write access for
    * @return a list of all CategoryOptions, or an empty collection if there are no CategoryOptions.
    */
-  List<CategoryOption> getDataWriteCategoryOptions(Category category, User user);
+  List<CategoryOption> getDataWriteCategoryOptions(Category category, UserDetails user);
 
   /**
    * Returns a set of CategoryOptions that may be seen by the current user, if the current user has
@@ -236,13 +245,17 @@ SetValuedMap<String, String> getCategoryOptionOrganisationUnitsAssociations(
    */
   long addCategoryCombo(CategoryCombo dataElementCategoryCombo);
 
+  long addCategoryCombo(CategoryCombo dataElementCategoryCombo, UserDetails actingUser);
+
   /**
    * Updates a CategoryCombo.
    *
    * @param dataElementCategoryCombo the CategoryCombo to update.
    */
   void updateCategoryCombo(CategoryCombo dataElementCategoryCombo);
 
+  void updateCategoryCombo(CategoryCombo dataElementCategoryCombo, UserDetails actingUser);
+
   /**
    * Deletes a CategoryCombo.
    *
@@ -328,13 +341,19 @@ SetValuedMap<String, String> getCategoryOptionOrganisationUnitsAssociations(
    */
   long addCategoryOptionCombo(CategoryOptionCombo dataElementCategoryOptionCombo);
 
+  long addCategoryOptionCombo(
+      CategoryOptionCombo dataElementCategoryOptionCombo, UserDetails actingUser);
+
   /**
    * Updates a CategoryOptionCombo.
    *
    * @param dataElementCategoryOptionCombo the CategoryOptionCombo to update.
    */
   void updateCategoryOptionCombo(CategoryOptionCombo dataElementCategoryOptionCombo);
 
+  void updateCategoryOptionCombo(
+      CategoryOptionCombo dataElementCategoryOptionCombo, UserDetails actingUser);
+
   /**
    * Deletes a CategoryOptionCombo.
    *
@@ -388,7 +407,7 @@ CategoryOptionCombo getCategoryOptionCombo(
    * Generates and persists a default Category, CategoryOption, CategoryCombo and
    * CategoryOptionCombo.
    */
-  void generateDefaultDimension();
+  void generateDefaultDimension(UserDetails actingUser);
 
   /**
    * Retrieves the default CategoryOptionCombo.

dhis-2/dhis-api/src/main/java/org/hisp/dhis/common/BaseAnalyticalObject.java

@@ -101,9 +101,9 @@
 import org.hisp.dhis.trackedentity.TrackedEntityDataElementDimension;
 import org.hisp.dhis.trackedentity.TrackedEntityProgramIndicatorDimension;
 import org.hisp.dhis.translation.Translatable;
-import org.hisp.dhis.user.CurrentUserDetails;
 import org.hisp.dhis.user.CurrentUserUtil;
 import org.hisp.dhis.user.User;
+import org.hisp.dhis.user.UserDetails;
 import org.hisp.dhis.visualization.DefaultValue;
 import org.hisp.dhis.visualization.LegendDefinitions;
 
@@ -1655,7 +1655,7 @@ public void setSubscribers(@CheckForNull Set<String> subscribers) {
   @JsonProperty
   @JacksonXmlProperty(namespace = DxfNamespaces.DXF_2_0)
   public boolean isSubscribed() {
-    CurrentUserDetails user = CurrentUserUtil.getCurrentUserDetails();
+    UserDetails user = CurrentUserUtil.getCurrentUserDetails();
     return (user != null && subscribers != null) && subscribers.contains(user.getUid());
   }
 

dhis-2/dhis-api/src/main/java/org/hisp/dhis/common/BaseIdentifiableObject.java

@@ -68,9 +68,9 @@
 import org.hisp.dhis.security.acl.Access;
 import org.hisp.dhis.translation.Translatable;
 import org.hisp.dhis.translation.Translation;
-import org.hisp.dhis.user.CurrentUserDetails;
 import org.hisp.dhis.user.CurrentUserUtil;
 import org.hisp.dhis.user.User;
+import org.hisp.dhis.user.UserDetails;
 import org.hisp.dhis.user.UserSettingKey;
 import org.hisp.dhis.user.sharing.Sharing;
 import org.hisp.dhis.user.sharing.UserAccess;
@@ -417,7 +417,7 @@ public void setFavorites(Set<String> favorites) {
   @JsonProperty
   @JacksonXmlProperty(namespace = DxfNamespaces.DXF_2_0)
   public boolean isFavorite() {
-    CurrentUserDetails user = CurrentUserUtil.getCurrentUserDetails();
+    UserDetails user = CurrentUserUtil.getCurrentUserDetails();
     return user != null && favorites != null && favorites.contains(user.getUid());
   }
 
@@ -438,7 +438,7 @@ public void setSharing(Sharing sharing) {
   }
 
   @Override
-  public boolean setAsFavorite(User user) {
+  public boolean setAsFavorite(UserDetails user) {
     if (this.favorites == null) {
       this.favorites = new HashSet<>();
     }
@@ -447,7 +447,7 @@ public boolean setAsFavorite(User user) {
   }
 
   @Override
-  public boolean removeAsFavorite(User user) {
+  public boolean removeAsFavorite(UserDetails user) {
     if (this.favorites == null) {
       this.favorites = new HashSet<>();
     }
@@ -499,7 +499,7 @@ public final boolean typedEquals(IdentifiableObject other) {
 
   /** Set auto-generated fields on save or update */
   public void setAutoFields() {
-    if (uid == null || uid.length() == 0) {
+    if (uid == null || uid.isEmpty()) {
       setUid(CodeGenerator.generateUid());
     }
 

dhis-2/dhis-api/src/main/java/org/hisp/dhis/common/DimensionService.java

@@ -31,7 +31,7 @@
 import java.util.Map;
 import java.util.Set;
 import org.hisp.dhis.feedback.NotFoundException;
-import org.hisp.dhis.user.User;
+import org.hisp.dhis.user.UserDetails;
 
 /**
  * @author Lars Helge Overland
@@ -45,9 +45,8 @@ public interface DimensionService {
    */
   List<DimensionalItemObject> getCanReadDimensionItems(String uid);
 
-  <T extends IdentifiableObject> List<T> getCanReadObjects(List<T> objects);
-
-  <T extends IdentifiableObject> List<T> getCanReadObjects(User user, List<T> objects);
+  <T extends IdentifiableObject> List<T> filterReadableObjects(
+      UserDetails userDetails, List<T> objects);
 
   DimensionType getDimensionType(String uid);
 

dhis-2/dhis-api/src/main/java/org/hisp/dhis/common/IdentifiableObject.java

@@ -35,6 +35,7 @@
 import org.hisp.dhis.security.acl.Access;
 import org.hisp.dhis.translation.Translation;
 import org.hisp.dhis.user.User;
+import org.hisp.dhis.user.UserDetails;
 import org.hisp.dhis.user.sharing.Sharing;
 
 /**
@@ -64,9 +65,9 @@ public interface IdentifiableObject
 
   boolean isFavorite();
 
-  boolean setAsFavorite(User user);
+  boolean setAsFavorite(UserDetails user);
 
-  boolean removeAsFavorite(User user);
+  boolean removeAsFavorite(UserDetails user);
 
   // -----------------------------------------------------------------------------
   // Sharing

dhis-2/dhis-api/src/main/java/org/hisp/dhis/common/IdentifiableObjectManager.java

@@ -40,6 +40,7 @@
 import org.hisp.dhis.feedback.ErrorCode;
 import org.hisp.dhis.translation.Translation;
 import org.hisp.dhis.user.User;
+import org.hisp.dhis.user.UserDetails;
 
 /**
  * @author Lars Helge Overland
@@ -55,16 +56,12 @@ public interface IdentifiableObjectManager {
 
   void update(@Nonnull IdentifiableObject object);
 
-  void update(@Nonnull IdentifiableObject object, @CheckForNull User user);
+  void update(@Nonnull IdentifiableObject object, UserDetails currentUserDetails);
 
   void update(@Nonnull List<IdentifiableObject> objects);
 
-  void update(@Nonnull List<IdentifiableObject> objects, @CheckForNull User user);
-
   void delete(@Nonnull IdentifiableObject object);
 
-  void delete(@Nonnull IdentifiableObject object, @CheckForNull User user);
-
   /**
    * Lookup objects of unknown type.
    *
@@ -192,7 +189,7 @@ <T extends IdentifiableObject> T getByUniqueAttributeValue(
       @Nonnull Class<T> type,
       @Nonnull Attribute attribute,
       @Nonnull String value,
-      @CheckForNull User userInfo);
+      @CheckForNull String username);
 
   @CheckForNull
   <T extends IdentifiableObject> T search(@Nonnull Class<T> type, @Nonnull String query);
@@ -389,4 +386,8 @@ List<String> getUidsCreatedBefore(
 
   @Nonnull
   <T extends IdentifiableObject> List<T> getAllNoAcl(@Nonnull Class<T> type);
+
+  void persist(Object userAdmin);
+
+  User find(Class<User> userClass, long id);
 }