Merge pull request #1808 from steve-community/1807-add-query-filter-to-users-and-ocpp-tags-to-express-association-variants

goekay · web-flow · commit 49fde1fa25e3 · 2025-09-11T10:31:24.000+02:00
Add query filter to users (and ocpp tags) to express association variants
diff --git a/src/main/java/de/rwth/idsg/steve/repository/dto/OcppTag.java b/src/main/java/de/rwth/idsg/steve/repository/dto/OcppTag.java
@@ -42,6 +42,9 @@ public static final class OcppTagOverview {
         @Schema(description = "The OCPP tag")
         private final String idTag;
 
+        @Schema(description = "PK of the user this OCPP tag belongs to (if any)")
+        private final Integer userPk;
+
         @Schema(description = "PK of the parent OCPP tag of this OCPP tag")
         private final Integer parentOcppTagPk;
 
diff --git a/src/main/java/de/rwth/idsg/steve/repository/impl/OcppTagRepositoryImpl.java b/src/main/java/de/rwth/idsg/steve/repository/impl/OcppTagRepositoryImpl.java
@@ -24,13 +24,14 @@
 import de.rwth.idsg.steve.web.dto.OcppTagForm;
 import de.rwth.idsg.steve.web.dto.OcppTagQueryForm;
 import jooq.steve.db.tables.OcppTagActivity;
+import jooq.steve.db.tables.UserOcppTag;
 import jooq.steve.db.tables.records.OcppTagActivityRecord;
 import jooq.steve.db.tables.records.OcppTagRecord;
 import lombok.extern.slf4j.Slf4j;
 import org.joda.time.DateTime;
 import org.jooq.DSLContext;
 import org.jooq.JoinType;
-import org.jooq.Record10;
+import org.jooq.Record11;
 import org.jooq.RecordMapper;
 import org.jooq.Result;
 import org.jooq.SelectQuery;
@@ -43,7 +44,6 @@
 import java.util.List;
 import java.util.stream.Collectors;
 
-import static de.rwth.idsg.steve.repository.impl.RepositoryUtils.ocppTagByUserIdQuery;
 import static de.rwth.idsg.steve.utils.CustomDSL.includes;
 import static de.rwth.idsg.steve.utils.DateTimeUtils.humanize;
 import static jooq.steve.db.tables.OcppTag.OCPP_TAG;
@@ -72,6 +72,7 @@ public List<OcppTagOverview> getOverview(OcppTagQueryForm form) {
         selectQuery.addFrom(OCPP_TAG_ACTIVITY);
 
         OcppTagActivity parentTable = OCPP_TAG_ACTIVITY.as("parent");
+        UserOcppTag userOcppTagTable = USER_OCPP_TAG.as("user_ocpp_tag");
 
         selectQuery.addSelect(
                 OCPP_TAG_ACTIVITY.OCPP_TAG_PK,
@@ -83,10 +84,12 @@ public List<OcppTagOverview> getOverview(OcppTagQueryForm form) {
                 OCPP_TAG_ACTIVITY.BLOCKED,
                 OCPP_TAG_ACTIVITY.MAX_ACTIVE_TRANSACTION_COUNT,
                 OCPP_TAG_ACTIVITY.ACTIVE_TRANSACTION_COUNT,
-                OCPP_TAG_ACTIVITY.NOTE
+                OCPP_TAG_ACTIVITY.NOTE,
+                userOcppTagTable.USER_PK
         );
 
         selectQuery.addJoin(parentTable, JoinType.LEFT_OUTER_JOIN, parentTable.ID_TAG.eq(OCPP_TAG_ACTIVITY.PARENT_ID_TAG));
+        selectQuery.addJoin(userOcppTagTable, JoinType.LEFT_OUTER_JOIN, userOcppTagTable.OCPP_TAG_PK.eq(OCPP_TAG_ACTIVITY.OCPP_TAG_PK));
 
         if (form.isOcppTagPkSet()) {
             selectQuery.addConditions(OCPP_TAG_ACTIVITY.OCPP_TAG_PK.eq(form.getOcppTagPk()));
@@ -101,14 +104,24 @@ public List<OcppTagOverview> getOverview(OcppTagQueryForm form) {
         }
 
         if (form.isUserIdSet()) {
-            var query = ocppTagByUserIdQuery(ctx, form.getUserId());
-            selectQuery.addConditions(OCPP_TAG_ACTIVITY.ID_TAG.in(query));
+            selectQuery.addConditions(userOcppTagTable.USER_PK.eq(form.getUserId()));
         }
 
         if (form.isNoteSet()) {
             selectQuery.addConditions(includes(OCPP_TAG_ACTIVITY.NOTE, form.getNote()));
         }
 
+        switch (form.getUserFilter()) {
+            case OnlyTagsWithUser:
+                selectQuery.addConditions(userOcppTagTable.USER_PK.isNotNull());
+                break;
+            case OnlyTagsWithoutUser:
+                selectQuery.addConditions(userOcppTagTable.USER_PK.isNull());
+                break;
+            default:
+                break;
+        }
+
         switch (form.getExpired()) {
             case ALL:
                 break;
@@ -274,9 +287,9 @@ private void processBooleanType(SelectQuery selectQuery,
     }
 
     private static class UserMapper
-            implements RecordMapper<Record10<Integer, Integer, String, String, DateTime, Boolean, Boolean, Integer, Long, String>, OcppTagOverview> {
+            implements RecordMapper<Record11<Integer, Integer, String, String, DateTime, Boolean, Boolean, Integer, Long, String, Integer>, OcppTagOverview> {
         @Override
-        public OcppTagOverview map(Record10<Integer, Integer, String, String, DateTime, Boolean, Boolean, Integer, Long, String> r) {
+        public OcppTagOverview map(Record11<Integer, Integer, String, String, DateTime, Boolean, Boolean, Integer, Long, String, Integer> r) {
             return OcppTagOverview.builder()
                           .ocppTagPk(r.value1())
                           .parentOcppTagPk(r.value2())
@@ -289,6 +302,7 @@ public OcppTagOverview map(Record10<Integer, Integer, String, String, DateTime,
                           .maxActiveTransactionCount(r.value8())
                           .activeTransactionCount(r.value9())
                           .note(r.value10())
+                          .userPk(r.value11())
                           .build();
         }
     }
diff --git a/src/main/java/de/rwth/idsg/steve/repository/impl/UserRepositoryImpl.java b/src/main/java/de/rwth/idsg/steve/repository/impl/UserRepositoryImpl.java
@@ -64,16 +64,39 @@ public class UserRepositoryImpl implements UserRepository {
     @Override
     public List<User.Overview> getOverview(UserQueryForm form) {
         var ocppTagsPerUser = getOcppTagsInternal(form.getUserPk(), form.getOcppIdTag());
+        var userResults = getOverviewInternal(form);
+
+        List<User.Overview> userOverviews = new ArrayList<>();
+        for (var r : userResults) {
+            var tags = ocppTagsPerUser.getOrDefault(r.value1(), List.of());
+
+            var user = User.Overview.builder()
+                .userPk(r.value1())
+                .name(r.value2() + " " + r.value3())
+                .phone(r.value4())
+                .email(r.value5())
+                .ocppTagEntries(tags)
+                .build();
+
+            // TODO: Improve later. This is not efficient, because we filter after fetching all results. However, this
+            //       should be acceptable since the number of users (and tags) are usually not very high, and this
+            //       overview query will probably not be in the hot path.
+            switch (form.getOcppTagFilter()) {
+                case OnlyUsersWithTags -> {
+                    if (!tags.isEmpty()) {
+                        userOverviews.add(user);
+                    }
+                }
+                case OnlyUsersWithoutTags -> {
+                    if (tags.isEmpty()) {
+                        userOverviews.add(user);
+                    }
+                }
+                default -> userOverviews.add(user);
+            }
+        }
 
-        return getOverviewInternal(form)
-                .map(r -> User.Overview.builder()
-                                       .userPk(r.value1())
-                                       .name(r.value2() + " " + r.value3())
-                                       .phone(r.value4())
-                                       .email(r.value5())
-                                       .ocppTagEntries(ocppTagsPerUser.getOrDefault(r.value1(), List.of()))
-                                       .build()
-                );
+        return userOverviews;
     }
 
     @Override
diff --git a/src/main/java/de/rwth/idsg/steve/web/dto/OcppTagQueryForm.java b/src/main/java/de/rwth/idsg/steve/web/dto/OcppTagQueryForm.java
@@ -60,6 +60,9 @@ public class OcppTagQueryForm {
     @Schema(description = "Query by the note associated with the OCPP tag. The value of this field does not have to exactly match the note. A substring is also accepted.")
     private String note;
 
+    @Schema(description = "Filter by whether the OCPP tag is associated with a user or not. Defaults to All")
+    private UserFilter userFilter = UserFilter.All;
+
     @Schema(hidden = true)
     public boolean isOcppTagPkSet() {
         return ocppTagPk != null;
@@ -123,6 +126,12 @@ public static BooleanType fromValue(String v) {
         }
     }
 
+    public enum UserFilter {
+        All,
+        OnlyTagsWithUser,
+        OnlyTagsWithoutUser
+    }
+
     @ToString(callSuper = true)
     public static class OcppTagQueryFormForApi extends OcppTagQueryForm {
 
diff --git a/src/main/java/de/rwth/idsg/steve/web/dto/UserQueryForm.java b/src/main/java/de/rwth/idsg/steve/web/dto/UserQueryForm.java
@@ -39,6 +39,8 @@ public class UserQueryForm {
     private String name;
     private String email;
 
+    private OcppTagFilter ocppTagFilter = OcppTagFilter.All;
+
     public boolean isSetUserPk() {
         return userPk != null;
     }
@@ -54,4 +56,11 @@ public boolean isSetName() {
     public boolean isSetEmail() {
         return email != null;
     }
+
+    public enum OcppTagFilter {
+        All,
+        OnlyUsersWithTags,
+        OnlyUsersWithoutTags
+    }
+
 }
diff --git a/src/main/resources/webapp/WEB-INF/views/data-man/ocppTags.jsp b/src/main/resources/webapp/WEB-INF/views/data-man/ocppTags.jsp
@@ -95,6 +95,14 @@
                     <td>User ID:</td>
                     <td><form:input path="userId"/></td>
                 </tr>
+                <tr>
+                    <td>User Relationship:</td>
+                    <td>
+                        <form:select path="userFilter">
+                            <form:options items="${userFilter}"/>
+                        </form:select>
+                    </td>
+                </tr>
                 <tr>
                     <td>Expired?:</td>
                     <td><form:select path="expired">
@@ -133,6 +141,7 @@
             <thead>
             <tr>
                 <th data-sort="string">ID Tag</th>
+                <th data-sort="int">User ID</th>
                 <th data-sort="string">Parent ID Tag</th>
                 <th data-sort="date">Expiry Date/Time</th>
                 <th data-sort="string">In Transaction?</th>
@@ -148,6 +157,7 @@
             <c:forEach items="${ocppTagList}" var="item">
                 <tr>
                     <td><a href="${ctxPath}/manager/ocppTags/details/${item.ocppTagPk}">${item.idTag}</a></td>
+                    <td><a href="${ctxPath}/manager/users/details/${item.userPk}">${item.userPk}</a></td>
                     <td>
                         <c:if test="${not empty item.parentIdTag}">
                             <a href="${ctxPath}/manager/ocppTags/details/${item.parentOcppTagPk}">${item.parentIdTag}</a>
diff --git a/src/main/resources/webapp/WEB-INF/views/data-man/users.jsp b/src/main/resources/webapp/WEB-INF/views/data-man/users.jsp
@@ -36,6 +36,14 @@
                 <td>Ocpp ID Tag:</td>
                 <td><form:input path="ocppIdTag"/></td>
             </tr>
+            <tr>
+                <td>Ocpp ID Tag Relationship:</td>
+                <td>
+                    <form:select path="ocppTagFilter">
+                        <form:options items="${ocppTagFilter}"/>
+                    </form:select>
+                </td>
+            </tr>
             <tr>
                 <td>Name:</td>
                 <td><form:input path="name"/></td>

Original file line number	Diff line number	Diff line change
`@@ -39,6 +39,8 @@ public class UserQueryForm {`
`39`	`39`	`private String name;`
`40`	`40`	`private String email;`
`41`	`41`
	`42`	`+ private OcppTagFilter ocppTagFilter = OcppTagFilter.All;`
	`43`	`+`
`42`	`44`	`public boolean isSetUserPk() {`
`43`	`45`	`return userPk != null;`
`44`	`46`	`}`
`@@ -54,4 +56,11 @@ public boolean isSetName() {`
`54`	`56`	`public boolean isSetEmail() {`
`55`	`57`	`return email != null;`
`56`	`58`	`}`
	`59`	`+`
	`60`	`+ public enum OcppTagFilter {`
	`61`	`+ All,`
	`62`	`+ OnlyUsersWithTags,`
	`63`	`+ OnlyUsersWithoutTags`
	`64`	`+ }`
	`65`	`+`
`57`	`66`	`}`