feat: Refactoring of CurrentUserService and introduction of UserDetails and more

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

@@ -192,7 +192,7 @@
       @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);

dhis-2/dhis-api/src/main/java/org/hisp/dhis/user/CurrentUserGroupService.java

@@ -0,0 +1,70 @@
+/*
+ * Copyright (c) 2004-2022, University of Oslo
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation
+ * and/or other materials provided with the distribution.
+ * Neither the name of the HISP project nor the names of its contributors may
+ * be used to endorse or promote products derived from this software without
+ * specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+package org.hisp.dhis.user;
+
+import static com.google.common.base.Preconditions.checkNotNull;
+
+import org.hisp.dhis.cache.Cache;
+import org.hisp.dhis.cache.CacheProvider;
+import org.springframework.stereotype.Service;
+import org.springframework.transaction.annotation.Transactional;
+
+@Service("org.hisp.dhis.user.CurrentUserGroupService")
+public class CurrentUserGroupService {
+
+  private final Cache<CurrentUserGroupInfo> currentUserGroupInfoCache;
+
+  private final UserService userService;
+  public CurrentUserGroupService(UserService userService, CacheProvider cacheProvider) {
+    checkNotNull(cacheProvider);
+    checkNotNull(cacheProvider);
+
+    this.userService = userService;
+    this.currentUserGroupInfoCache = cacheProvider.createCurrentUserGroupInfoCache();
+  }
+
+  @Transactional(readOnly = true)
+  public CurrentUserGroupInfo getCurrentUserGroupsInfo() {
+    CurrentUserDetails user = CurrentUserUtil.getCurrentUserDetails();
+    return user == null ? null : getCurrentUserGroupsInfo(user.getUid());
+  }
+
+  @Transactional(readOnly = true)
+  public CurrentUserGroupInfo getCurrentUserGroupsInfo(String userUID) {
+    return currentUserGroupInfoCache.get(userUID, userService::getCurrentUserGroupInfo);
+  }
+
+  @Transactional(readOnly = true)
+  public void invalidateUserGroupCache(String userUID) {
+    try {
+      currentUserGroupInfoCache.invalidate(userUID);
+    } catch (NullPointerException exception) {
+      // Ignore if key doesn't exist
+    }
+  }
+}

dhis-2/dhis-api/src/main/java/org/hisp/dhis/user/CurrentUserService.java

@@ -32,7 +32,9 @@
 import java.util.HashSet;
 import java.util.List;
 import java.util.Set;
-import org.hisp.dhis.cache.Cache;
+import javax.persistence.EntityManager;
+import javax.persistence.TypedQuery;
+import org.hibernate.annotations.QueryHints;
 import org.hisp.dhis.cache.CacheProvider;
 import org.hisp.dhis.organisationunit.OrganisationUnit;
 import org.springframework.context.annotation.Lazy;
@@ -50,19 +52,37 @@
  */
 @Service("org.hisp.dhis.user.CurrentUserService")
 public class CurrentUserService {
-  private final UserStore userStore;
 
-  private final Cache<CurrentUserGroupInfo> currentUserGroupInfoCache;
+  //  private final Cache<CurrentUserGroupInfo> currentUserGroupInfoCache;
 
+  //  private final UserStore userService;
   private final SessionRegistry sessionRegistry;
+  private final EntityManager entityManager;
 
-  public CurrentUserService(
-      @Lazy UserStore userStore, CacheProvider cacheProvider, SessionRegistry sessionRegistry) {
-    checkNotNull(userStore);
+  public CurrentUserService(SessionRegistry sessionRegistry, EntityManager entityManager) {
 
-    this.userStore = userStore;
-    this.currentUserGroupInfoCache = cacheProvider.createCurrentUserGroupInfoCache();
+    //    this.currentUserGroupInfoCache = cacheProvider.createCurrentUserGroupInfoCache();
     this.sessionRegistry = sessionRegistry;
+    this.entityManager = entityManager;
+  }
+
+  private User getUserByUsername(String username, boolean ignoreCase) {
+    if (username == null) {
+      return null;
+    }
+
+    String hql =
+        ignoreCase
+            ? "from User u where lower(u.username) = lower(:username)"
+            : "from User u where u.username = :username";
+
+    TypedQuery<User> typedQuery = entityManager.createQuery(hql, User.class);
+    typedQuery.setParameter("username", username);
+    typedQuery.setHint(QueryHints.CACHEABLE, true);
+
+    return typedQuery.getSingleResult();
+    //    return QueryUtils.getSingleResult(typedQuery);
+
   }
 
   /**
@@ -77,7 +97,7 @@ public String getCurrentUsername() {
   public User getCurrentUser() {
     String username = CurrentUserUtil.getCurrentUsername();
 
-    return userStore.getUserByUsername(username, false);
+    return getUserByUsername(username, false);
   }
 
   @Transactional(readOnly = true)
@@ -101,27 +121,6 @@ public boolean currentUserIsAuthorized(String auth) {
     return user != null && user.isAuthorized(auth);
   }
 
-  @Transactional(readOnly = true)
-  public CurrentUserGroupInfo getCurrentUserGroupsInfo() {
-    CurrentUserDetails user = CurrentUserUtil.getCurrentUserDetails();
-
-    return user == null ? null : getCurrentUserGroupsInfo(user.getUid());
-  }
-
-  @Transactional(readOnly = true)
-  public CurrentUserGroupInfo getCurrentUserGroupsInfo(String userUID) {
-    return currentUserGroupInfoCache.get(userUID, key -> userStore.getCurrentUserGroupInfo(key));
-  }
-
-  @Transactional(readOnly = true)
-  public void invalidateUserGroupCache(String userUID) {
-    try {
-      currentUserGroupInfoCache.invalidate(userUID);
-    } catch (NullPointerException exception) {
-      // Ignore if key doesn't exist
-    }
-  }
-
   public CurrentUserDetailsImpl getCurrentUserPrincipal(String uid) {
     return sessionRegistry.getAllPrincipals().stream()
         .map(CurrentUserDetailsImpl.class::cast)

dhis-2/dhis-api/src/main/java/org/hisp/dhis/user/UserService.java

@@ -585,4 +585,10 @@ boolean canCurrentUserCanModify(
    * @param activeUsername the username of the user to set as active
    */
   void setActiveLinkedAccounts(@Nonnull User actingUser, @Nonnull String activeUsername);
+
+  CurrentUserGroupInfo getCurrentUserGroupsInfo();
+
+  CurrentUserGroupInfo getCurrentUserGroupInfo(String userUID);
+
+  void invalidateUserGroupCache(String userUID);
 }

dhis-2/dhis-services/dhis-service-core/src/main/java/org/hisp/dhis/analytics/hibernate/HibernateAnalyticsTableHookStore.java

@@ -39,6 +39,7 @@
 import org.hisp.dhis.security.acl.AclService;
 import org.hisp.dhis.user.CurrentUserService;
 import org.springframework.context.ApplicationEventPublisher;
+import org.springframework.context.annotation.Lazy;
 import org.springframework.jdbc.core.JdbcTemplate;
 import org.springframework.stereotype.Repository;
 
@@ -54,14 +55,12 @@ public HibernateAnalyticsTableHookStore(
       EntityManager entityManager,
       JdbcTemplate jdbcTemplate,
       ApplicationEventPublisher publisher,
-      CurrentUserService currentUserService,
       AclService aclService) {
     super(
         entityManager,
         jdbcTemplate,
         publisher,
         AnalyticsTableHook.class,
-        currentUserService,
         aclService,
         false);
   }

dhis-2/dhis-services/dhis-service-core/src/main/java/org/hisp/dhis/association/AbstractOrganisationUnitAssociationsQueryBuilder.java

@@ -46,10 +46,11 @@
 import org.hisp.dhis.user.CurrentUserGroupInfo;
 import org.hisp.dhis.user.CurrentUserService;
 import org.hisp.dhis.user.User;
+import org.hisp.dhis.user.UserService;
 
 @RequiredArgsConstructor
 public abstract class AbstractOrganisationUnitAssociationsQueryBuilder {
-  private final CurrentUserService currentUserService;
+  private final UserService userService;
 
   private static final String SHARING_OUTER_QUERY_BEGIN =
       "select " + "    inner_query_alias.uid, " + "    inner_query_alias.agg_ou_uid " + "from (";
@@ -142,7 +143,7 @@ private String innerQueryProvider(
   }
 
   private String getSharingConditions(String access) {
-    CurrentUserGroupInfo currentUserGroupInfo = currentUserService.getCurrentUserGroupsInfo();
+    CurrentUserGroupInfo currentUserGroupInfo = userService.getCurrentUserGroupsInfo();
     return String.join(
         " or ",
         getOwnerCondition(currentUserGroupInfo),

dhis-2/dhis-services/dhis-service-core/src/main/java/org/hisp/dhis/association/CategoryOptionOrganisationUnitAssociationsQueryBuilder.java

@@ -30,6 +30,7 @@
 import lombok.AccessLevel;
 import lombok.Getter;
 import org.hisp.dhis.user.CurrentUserService;
+import org.hisp.dhis.user.UserService;
 import org.springframework.stereotype.Service;
 
 @Service
@@ -48,7 +49,7 @@ public class CategoryOptionOrganisationUnitAssociationsQueryBuilder
   private final String baseTableName = "categoryoption";
 
   public CategoryOptionOrganisationUnitAssociationsQueryBuilder(
-      CurrentUserService currentUserService) {
-    super(currentUserService);
+      UserService userService) {
+    super(userService);
   }
 }

dhis-2/dhis-services/dhis-service-core/src/main/java/org/hisp/dhis/association/DataSetOrganisationUnitAssociationsQueryBuilder.java

@@ -30,6 +30,7 @@
 import lombok.AccessLevel;
 import lombok.Getter;
 import org.hisp.dhis.user.CurrentUserService;
+import org.hisp.dhis.user.UserService;
 import org.springframework.stereotype.Service;
 
 @Service
@@ -47,7 +48,7 @@ public class DataSetOrganisationUnitAssociationsQueryBuilder
   @Getter(AccessLevel.PROTECTED)
   private final String baseTableName = "dataset";
 
-  public DataSetOrganisationUnitAssociationsQueryBuilder(CurrentUserService currentUserService) {
+  public DataSetOrganisationUnitAssociationsQueryBuilder(UserService currentUserService) {
     super(currentUserService);
   }
 }

dhis-2/dhis-services/dhis-service-core/src/main/java/org/hisp/dhis/association/ProgramOrganisationUnitAssociationsQueryBuilder.java

@@ -30,6 +30,7 @@
 import lombok.AccessLevel;
 import lombok.Getter;
 import org.hisp.dhis.user.CurrentUserService;
+import org.hisp.dhis.user.UserService;
 import org.springframework.stereotype.Service;
 
 @Service
@@ -47,7 +48,7 @@ public class ProgramOrganisationUnitAssociationsQueryBuilder
   @Getter(AccessLevel.PROTECTED)
   private final String baseTableName = "program";
 
-  public ProgramOrganisationUnitAssociationsQueryBuilder(CurrentUserService currentUserService) {
+  public ProgramOrganisationUnitAssociationsQueryBuilder(UserService currentUserService) {
     super(currentUserService);
   }
 }

dhis-2/dhis-services/dhis-service-core/src/main/java/org/hisp/dhis/association/jdbc/JdbcOrgUnitAssociationStoreConfiguration.java

@@ -33,6 +33,7 @@
 import org.hisp.dhis.association.ProgramOrganisationUnitAssociationsQueryBuilder;
 import org.hisp.dhis.cache.CacheProvider;
 import org.hisp.dhis.user.CurrentUserService;
+import org.hisp.dhis.user.UserService;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.jdbc.core.JdbcTemplate;
@@ -44,31 +45,31 @@ public class JdbcOrgUnitAssociationStoreConfiguration {
 
   @Bean("jdbcProgramOrgUnitAssociationsStore")
   public JdbcOrgUnitAssociationsStore jdbcProgramOrgUnitAssociationStore(
-      CurrentUserService currentUserService, JdbcTemplate jdbcTemplate) {
+      CurrentUserService currentUserService, JdbcTemplate jdbcTemplate, UserService userService) {
     return new JdbcOrgUnitAssociationsStore(
         currentUserService,
         jdbcTemplate,
-        new ProgramOrganisationUnitAssociationsQueryBuilder(currentUserService),
+        new ProgramOrganisationUnitAssociationsQueryBuilder(userService),
         cacheProvider.createProgramOrgUnitAssociationCache());
   }
 
   @Bean("jdbcCategoryOptionOrgUnitAssociationsStore")
   public JdbcOrgUnitAssociationsStore jdbcCategoryOptionOrgUnitAssociationStore(
-      CurrentUserService currentUserService, JdbcTemplate jdbcTemplate) {
+      CurrentUserService currentUserService, JdbcTemplate jdbcTemplate, UserService userService) {
     return new JdbcOrgUnitAssociationsStore(
         currentUserService,
         jdbcTemplate,
-        new CategoryOptionOrganisationUnitAssociationsQueryBuilder(currentUserService),
+        new CategoryOptionOrganisationUnitAssociationsQueryBuilder(userService),
         cacheProvider.createCatOptOrgUnitAssociationCache());
   }
 
   @Bean("jdbcDataSetOrgUnitAssociationsStore")
   public JdbcOrgUnitAssociationsStore jdbcDataSetOrgUnitAssociationStore(
-      CurrentUserService currentUserService, JdbcTemplate jdbcTemplate) {
+      CurrentUserService currentUserService, JdbcTemplate jdbcTemplate, UserService userService) {
     return new JdbcOrgUnitAssociationsStore(
         currentUserService,
         jdbcTemplate,
-        new DataSetOrganisationUnitAssociationsQueryBuilder(currentUserService),
+        new DataSetOrganisationUnitAssociationsQueryBuilder(userService),
         cacheProvider.createDataSetOrgUnitAssociationCache());
   }
 }

dhis-2/dhis-services/dhis-service-core/src/main/java/org/hisp/dhis/attribute/hibernate/HibernateAttributeStore.java

@@ -49,14 +49,12 @@ public HibernateAttributeStore(
       EntityManager entityManager,
       JdbcTemplate jdbcTemplate,
       ApplicationEventPublisher publisher,
-      CurrentUserService currentUserService,
       AclService aclService) {
     super(
         entityManager,
         jdbcTemplate,
         publisher,
         Attribute.class,
-        currentUserService,
         aclService,
         true);
   }

dhis-2/dhis-services/dhis-service-core/src/main/java/org/hisp/dhis/category/hibernate/HibernateCategoryComboStore.java

@@ -50,14 +50,12 @@ public HibernateCategoryComboStore(
       EntityManager entityManager,
       JdbcTemplate jdbcTemplate,
       ApplicationEventPublisher publisher,
-      CurrentUserService currentUserService,
       AclService aclService) {
     super(
         entityManager,
         jdbcTemplate,
         publisher,
         CategoryCombo.class,
-        currentUserService,
         aclService,
         true);
   }

dhis-2/dhis-services/dhis-service-core/src/main/java/org/hisp/dhis/category/hibernate/HibernateCategoryOptionComboStore.java

@@ -59,15 +59,13 @@ public HibernateCategoryOptionComboStore(
       EntityManager entityManager,
       JdbcTemplate jdbcTemplate,
       ApplicationEventPublisher publisher,
-      CurrentUserService currentUserService,
       AclService aclService,
       DbmsManager dbmsManager) {
     super(
         entityManager,
         jdbcTemplate,
         publisher,
         CategoryOptionCombo.class,
-        currentUserService,
         aclService,
         true);
     this.dbmsManager = dbmsManager;

dhis-2/dhis-services/dhis-service-core/src/main/java/org/hisp/dhis/category/hibernate/HibernateCategoryOptionGroupSetStore.java

@@ -51,14 +51,12 @@ public HibernateCategoryOptionGroupSetStore(
       EntityManager entityManager,
       JdbcTemplate jdbcTemplate,
       ApplicationEventPublisher publisher,
-      CurrentUserService currentUserService,
       AclService aclService) {
     super(
         entityManager,
         jdbcTemplate,
         publisher,
         CategoryOptionGroupSet.class,
-        currentUserService,
         aclService,
         true);
   }