Merge pull request #131 from rwth-acis/develop

Release v0.9.3

Author: fxjordan

.gitignore

@@ -16,6 +16,7 @@ log/
 etc/ivy/ivy.jar
 /service
 /etc/startup
+/etc/launcher-configuration.ini
 *.iml
 /.idea
 restMapping.xml
@@ -30,6 +31,7 @@ restMapping.xml
 .metadata
 .idea/workspace.xml
 /bin/start_network.sh
+/bin/start_network-debug.sh
 /bin/start_network.bat
 
 

CHANGELOG.md

@@ -10,6 +10,18 @@ the [GitHub Release Page](https://github.com/rwth-acis/RequirementsBazaar/releas
 
 ## [Unreleased]
 
+## [0.9.3] - 2021-12-21
+
+### Added
+
+- Build generates a script to start the las2peer node in debug mode for easier debugging [a0ae55f](https://github.com/rwth-acis/RequirementsBazaar/commit/a0ae55f6e08c57a93ed2cf4533a47151e2a24ef4)
+
+### Changed
+
+- Fixed bug in project member API which allowed adding the same users multiple times to the same project.
+  Also, fixed PUT request to update the role of members if they already exists
+  [#130](https://github.com/rwth-acis/RequirementsBazaar/pull/130)
+
 ## [0.9.2] - 2021-11-16
 
 ### Changed

gradle.properties

@@ -1,7 +1,7 @@
 org.gradle.parallel=true
 java.version=14
 core.version=1.1.2
-service.version=0.9.2
+service.version=0.9.3
 service.name=de.rwth.dbis.acis.bazaar.service
 service.class=BazaarService
 jooq.version=3.14.4

reqbaz/build.gradle

@@ -127,6 +127,13 @@ task startscripts {
 # it starts a las2peer node providing the service '${project.property('service.name')}.${project.property('service.class')}' of this project
 # pls execute it from the root folder of your deployment, e. g. ./bin/start_network.sh
 java -cp "lib/*" i5.las2peer.tools.L2pNodeLauncher --port 9011 --service-directory service uploadStartupDirectory startService\\(\\'${project.property('service.name')}.${project.property('service.class')}@${project.property('service.version')}\\'\\) startWebConnector interactive
+"""
+    new File("$rootDir/bin", "start_network-debug.sh").text = """#!/bin/bash
+# this script is autogenerated by 'gradle startscripts'
+# it starts a las2peer node providing the service '${project.property('service.name')}.${project.property('service.class')}' of this project
+# the JVM will be available for debugger connections (e.g., from your favorite IDE)
+# pls execute it from the root folder of your deployment, e. g. ./bin/start_network-debug.sh
+java -cp "lib/*" -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5433 i5.las2peer.tools.L2pNodeLauncher --port 9011 --service-directory service uploadStartupDirectory startService\\(\\'${project.property('service.name')}.${project.property('service.class')}@${project.property('service.version')}\\'\\) startWebConnector interactive
 """
     new File("$rootDir/bin", "start_network.bat").text = """:: this script is autogenerated by 'gradle startscripts'
 :: it starts a las2peer node providing the service '${project.property('service.name')}.${project.property('service.class')}' of this project

reqbaz/src/main/java/de/rwth/dbis/acis/bazaar/service/dal/DALFacade.java

@@ -211,6 +211,19 @@ public interface DALFacade {
 
     Statistic getStatisticsForProject(int userId, int projectId, Calendar since) throws BazaarException;
 
+    /**
+     * Returns the count most recent active projects followed by the user
+     *
+     * @param userId id of the follower
+     * @param count  how many should be returned
+     * @return Followed projects ordered by last activity
+     */
+    List<Project> getFollowedProjects(int userId, int count) throws BazaarException;
+
+    //endregion
+
+    //region ProjectMember
+
     /**
      * Get the members of a project and their according role
      *
@@ -220,22 +233,33 @@ public interface DALFacade {
     PaginationResult<ProjectMember> getProjectMembers(int projectId, Pageable pageable) throws BazaarException;
 
     /**
-     * Allows to remove a role from a user
+     * Returns whether a certain user is member of a project (with any role).
      *
+     * @param projectId
      * @param userId
-     * @param context
+     * @return
+     */
+    boolean isUserProjectMember(int projectId, int userId) throws BazaarException;
+
+    /**
+     * Updates a users role in a project and ensures a user has only one role assigned in
+     * a certain project.
+     *
+     * @param projectId
+     * @param userId
+     * @param roleName
      * @throws BazaarException
      */
-    void removeUserFromProject(int userId, Integer context) throws BazaarException;
+    void updateProjectMemberRole(int projectId, int userId, String roleName) throws BazaarException;
 
     /**
-     * Returns the count most recent active projects followed by the user
+     * Removes the given user from the project.
      *
-     * @param userId id of the follower
-     * @param count  how many should be returned
-     * @return Followed projects ordered by last activity
+     * @param userId
+     * @param projectId
+     * @throws BazaarException
      */
-    List<Project> getFollowedProjects(int userId, int count) throws BazaarException;
+    void removeUserFromProject(int userId, int projectId) throws BazaarException;
 
     //endregion
 
@@ -651,9 +675,33 @@ public interface DALFacade {
 
     void createPrivilegeIfNotExists(PrivilegeEnum privilege) throws BazaarException;
 
+    Role getRoleByName(String role) throws BazaarException;
+
+    boolean hasUserRole(int userId, String roleName, Integer context) throws BazaarException;
+
+    /**
+     * Returns whether a user has any role in a certain context.
+     *
+     * @param userId
+     * @param context (required)
+     * @return
+     */
+    boolean hasUserAnyRoleInContext(int userId, int context);
+
     void addUserToRole(int userId, String roleName, Integer context) throws BazaarException;
 
-    Role getRoleByName(String role) throws BazaarException;
+    void removeUserFromRole(int userId, String roleName, Integer context) throws BazaarException;
+
+    /**
+     * Remove the user from all roles assigned in a certain context.
+     *
+     * @param userId
+     * @param context (required for this methdod!)
+     */
+    void removeUserFromRolesByContext(int userId, int context) throws BazaarException;
+
+    void replaceUserRole(int userId, String oldRoleName, String newRoleName, Integer context) throws BazaarException;
+
     //endregion
 
 

reqbaz/src/main/java/de/rwth/dbis/acis/bazaar/service/dal/DALFacadeImpl.java

@@ -44,6 +44,7 @@
 import java.util.Calendar;
 import java.util.HashMap;
 import java.util.List;
+import java.util.Optional;
 
 /**
  * @since 6/14/2014
@@ -762,22 +763,80 @@ public void createPrivilegeIfNotExists(PrivilegeEnum privilege) throws BazaarExc
 
     }
 
+    @Override
+    public boolean hasUserRole(int userId, String roleName, Integer context) throws BazaarException {
+        roleRepository = (roleRepository != null) ? roleRepository : new RoleRepositoryImpl(dslContext);
+        return roleRepository.hasUserRole(userId, roleName, context);
+    }
+
+    @Override
+    public boolean hasUserAnyRoleInContext(int userId, int context) {
+        roleRepository = (roleRepository != null) ? roleRepository : new RoleRepositoryImpl(dslContext);
+        return roleRepository.hasUserAnyRoleInContext(userId, context);
+    }
+
     @Override
     public void addUserToRole(int userId, String roleName, Integer context) throws BazaarException {
         roleRepository = (roleRepository != null) ? roleRepository : new RoleRepositoryImpl(dslContext);
         roleRepository.addUserToRole(userId, roleName, context);
     }
 
+    @Override
+    public void removeUserFromRole(int userId, String roleName, Integer context) throws BazaarException {
+        roleRepository = (roleRepository != null) ? roleRepository : new RoleRepositoryImpl(dslContext);
+        roleRepository.removeUserFromRole(userId, roleName, context);
+    }
+
+    @Override
+    public void removeUserFromRolesByContext(int userId, int context) throws BazaarException {
+        roleRepository = (roleRepository != null) ? roleRepository : new RoleRepositoryImpl(dslContext);
+        roleRepository.removeUserFromRolesByContext(userId, context);
+    }
+
+    @Override
+    public void replaceUserRole(int userId, String oldRoleName, String newRoleName, Integer context) throws BazaarException {
+        roleRepository = (roleRepository != null) ? roleRepository : new RoleRepositoryImpl(dslContext);
+        roleRepository.replaceUserRole(userId, oldRoleName, newRoleName, context);
+    }
+
     @Override
     public Role getRoleByName(String role) throws BazaarException {
         roleRepository = (roleRepository != null) ? roleRepository : new RoleRepositoryImpl(dslContext);
         return roleRepository.findByRoleName(role);
     }
 
     @Override
-    public void removeUserFromProject(int userId, Integer context) throws BazaarException {
+    public void updateProjectMemberRole(int projectId, int userId, String roleName) throws BazaarException {
+        roleRepository = (roleRepository != null) ? roleRepository : new RoleRepositoryImpl(dslContext);
+
+        /*
+         * NOTE: Do NOT use getProjectRole here! This would return 'virtually' assigned project roles e.g., for
+         * a user with the SystemAdmin role. In this case the replaceUserRole would not work as expected
+         * because there is no actually stored role to replace!
+         *
+         * TODO Refactor this again so these concepts are not mixed up!
+         */
+        Optional<Integer> prevRole = roleRepository.findRoleIdsByContext(userId, projectId).stream().findFirst();
+
+        Role newRole = roleRepository.findByRoleName(roleName);
+
+        if (prevRole.isPresent()) {
+            roleRepository.replaceUserRole(userId, prevRole.get(), newRole.getId(), projectId);
+        } else {
+            roleRepository.addUserToRole(userId, newRole.getId(), projectId);
+        }
+    }
+
+    @Override
+    public void removeUserFromProject(int userId, int projectId) throws BazaarException {
+        roleRepository = (roleRepository != null) ? roleRepository : new RoleRepositoryImpl(dslContext);
+        roleRepository.removeUserFromRolesByContext(userId, projectId);
+    }
+
+    @Override
+    public boolean isUserProjectMember(int projectId, int userId) {
         roleRepository = (roleRepository != null) ? roleRepository : new RoleRepositoryImpl(dslContext);
-        roleRepository.removeUserFromRole(userId, context);
+        return roleRepository.hasUserAnyRoleInContext(userId, projectId);
     }
 
     @Override

reqbaz/src/main/java/de/rwth/dbis/acis/bazaar/service/dal/repositories/RoleRepository.java

@@ -35,12 +35,66 @@
 public interface RoleRepository extends Repository<Role> {
     List<Role> listParentsForRole(int roleId) throws BazaarException;
 
+    /**
+     * Returns the roles of a user in the given context including 'globally' assigned roles (i.e., roles
+     * stored with context 'null').<br>
+     * <br>
+     * NOTE: This is th higher level function which should be user for authorization / access control.
+     *
+     * @param userId
+     * @param context
+     * @return
+     * @throws BazaarException
+     */
     List<Role> listRolesOfUser(int userId, Integer context) throws BazaarException;
 
+    /**
+     * Returns <i>exactly</i> the roles that are assigned to a user in th given context.<br>
+     * In contrast to 'listRolesOfUser' this is only a straightforward database query which does
+     * not apply any knowledge about higher level roles (i.e. SystemAdmin which may override
+     * locally assigned roles like 'ProjectMember')
+     *
+     * @param userId
+     * @param context
+     * @return
+     */
+    List<Integer> findRoleIdsByContext(int userId, Integer context);
+
+    boolean hasUserRole(int userId, String roleName, Integer context) throws BazaarException;
+    boolean hasUserRole(int userId, int roleId, Integer context) throws BazaarException;
+
+    /**
+     * Returns whether a user has any role in a certain context.
+     *
+     * @param userId
+     * @param context (required)
+     * @return
+     */
+    boolean hasUserAnyRoleInContext(int userId, int context);
+
     void addUserToRole(int userId, String roleName, Integer context) throws BazaarException;
+    void addUserToRole(int userId, int roleId, Integer context) throws BazaarException;
+
+    void removeUserFromRole(int userId, String roleName, Integer context) throws BazaarException;
+    void removeUserFromRole(int userId, int roleId, Integer context) throws BazaarException;
+
+    /**
+     * Remove the user from all roles assigned in a certain context.
+     *
+     * @param userId
+     * @param context (required for this methdod!)
+     */
+    void removeUserFromRolesByContext(int userId, int context) throws BazaarException;
+
+    void replaceUserRole(int userId, String oldRoleName, String newRoleName, Integer context) throws BazaarException;
+    void replaceUserRole(int userId, int oldRoleId, int newRoleId, Integer context) throws BazaarException;
 
     Role findByRoleName(String roleName) throws BazaarException;
 
+    //
+    // project member specific methods -> TODO move to some higher level service!
+    //
+
     PaginationResult<ProjectMember> listProjectMembers(int projectId, Pageable pageable) throws BazaarException;
 
     /**
@@ -52,6 +106,4 @@ public interface RoleRepository extends Repository<Role> {
      * @throws BazaarException
      */
     ProjectRole getProjectRole(int userId, int projectId) throws BazaarException;
-
-    void removeUserFromRole(int userId, Integer context) throws BazaarException;
 }