HistoryEntry.jsx: diffSummary, edit user comment only displayed if av…

…ailable.
micromata · Feb 16, 2025 · f026175 · f026175
1 parent 94ec53f
commit f026175
Show file tree

Hide file tree

Showing 7 changed files with 87 additions and 36 deletions.
diff --git a/.../main/kotlin/org/projectforge/framework/persistence/entities/HistoryUserCommentSupport.kt b/.../main/kotlin/org/projectforge/framework/persistence/entities/HistoryUserCommentSupport.kt
@@ -29,5 +29,4 @@ package org.projectforge.framework.persistence.entities
  * Please refer UserPagesRest as an example.
  * @see org.projectforge.framework.persistence.history.HistoryEntryDO.userComment
  */
-interface HistoryUserCommentSupport {
-}
+interface HistoryUserCommentSupport
diff --git a/...ess/src/main/kotlin/org/projectforge/framework/persistence/history/DisplayHistoryEntry.kt b/...ess/src/main/kotlin/org/projectforge/framework/persistence/history/DisplayHistoryEntry.kt
@@ -23,10 +23,14 @@
 
 package org.projectforge.framework.persistence.history
 
+import com.fasterxml.jackson.annotation.JsonProperty
 import org.projectforge.framework.i18n.TimeAgo
+import org.projectforge.framework.i18n.translate
 import java.util.*
 
 class DisplayHistoryEntry {
+    class DiffCount(val type: EntityOpType, val count: Int, val operation: String)
+
     /**
      * The id of the history entry (pk of database).
      */
@@ -43,6 +47,42 @@ class DisplayHistoryEntry {
     val operation: String
         get() = HistoryFormatService.translate(operationType)
     var userComment: String? = null
+    @Suppress("unused") // Used by React frontend.
+    @get:JsonProperty
+    val diffSummary: List<DiffCount>
+        get() {
+            var inserted = 0
+            var updated = 0
+            var deleted = 0
+            attributes.forEach { attr ->
+                when (attr.operationType) {
+                    PropertyOpType.Insert -> inserted++
+                    PropertyOpType.Update -> updated++
+                    PropertyOpType.Delete -> deleted++
+                    else -> {}
+                }
+            }
+            if (inserted == 0 && updated == 0 && deleted == 0) {
+                when (operationType) {
+                    EntityOpType.Insert -> inserted++
+                    EntityOpType.Update -> updated++
+                    EntityOpType.Delete -> deleted++
+                    else -> {}
+                }
+            }
+            val actions = mutableListOf<DiffCount>()
+            if (inserted > 0) {
+                actions.add(DiffCount(EntityOpType.Insert, inserted, translate("operation.inserted")))
+            }
+            if (updated > 0) {
+                actions.add(DiffCount(EntityOpType.Update, updated, translate("operation.updated")))
+            }
+            if (deleted > 0) {
+                actions.add(DiffCount(EntityOpType.Delete, deleted, translate("operation.deleted")))
+            }
+            return actions
+        }
+
     var attributes = mutableListOf<DisplayHistoryEntryAttr>()
 
     companion object {

diff --git a/projectforge-rest/src/main/kotlin/org/projectforge/rest/core/AbstractPagesRest.kt b/projectforge-rest/src/main/kotlin/org/projectforge/rest/core/AbstractPagesRest.kt
@@ -764,6 +764,7 @@ constructor(
             newBaseDTO(request)
         })
             ?: return ResponseEntity(HttpStatus.NOT_FOUND)
+        userAccess.editHistoryComments = baseDao.supportsHistoryUserComments
         onBeforeGetItemAndLayout(request, item, userAccess)
         val formLayoutData = getItemAndLayout(request, item, userAccess)
         returnToCaller?.let {

diff --git a/projectforge-rest/src/main/kotlin/org/projectforge/ui/UILayout.kt b/projectforge-rest/src/main/kotlin/org/projectforge/ui/UILayout.kt
@@ -39,6 +39,11 @@ class UILayout(
      * The user has access to the object's history, if given.
      */
     var history: Boolean? = null,
+    /**
+     * Is the edit user-comment button visible?
+     * @see [org.projectforge.framework.persistence.api.BaseDao.supportsHistoryUserComments]
+     */
+    var editHistoryComments: Boolean? = null,
     /**
      * The user has access to insert new objects.
      */
@@ -56,6 +61,7 @@ class UILayout(
       this.update = userAccess?.update
       this.delete = userAccess?.delete
       this.cancel = userAccess?.cancel ?: true
+      this.editHistoryComments = userAccess?.editHistoryComments
     }
 
     fun onlySelectAccess(): Boolean {

diff --git a/projectforge-webapp/src/containers/page/form/FormPage.jsx b/projectforge-webapp/src/containers/page/form/FormPage.jsx
@@ -44,6 +44,7 @@ function FormPage(
     } = category;
     const location = useLocation();
     const [searchParams] = useSearchParams();
+    const { userAccess } = ui || {};
 
     React.useEffect(
         () => {
@@ -164,6 +165,7 @@ function FormPage(
                                     id={id}
                                     translations={ui.translations}
                                     visible={tab === 'history'}
+                                    userAccess={userAccess}
                                 />
                             </Container>
                         </TabPane>

diff --git a/projectforge-webapp/src/containers/page/form/history/HistoryEntry.jsx b/projectforge-webapp/src/containers/page/form/history/HistoryEntry.jsx
@@ -34,12 +34,13 @@ function HistoryEntry(
             timeAgo,
             modifiedAt,
             modifiedByUser,
+            diffSummary,
         },
+        userAccess,
         translations,
     },
 ) {
     const [active, setActive] = React.useState(false);
-    const diffSummary = {};
 
     const callAction = useActions(callActionHandler);
 
@@ -50,24 +51,13 @@ function HistoryEntry(
         },
     }), [callAction, masterId]);
 
-    attributes.forEach(({ operation, operationType }) => {
-        let diff = diffSummary[operationType];
-
-        if (!diff) {
-            diff = {
-                operation,
-                amount: 1,
-            };
-        } else {
-            diff.amount += 1;
-        }
-
-        diffSummary[operationType] = diff;
-    });
-
     const idifiedDate = String.idify(modifiedAt);
     const dateId = `history-date-${idifiedDate}`;
 
+    const { editHistoryComments } = userAccess;
+
+    console.log(userAccess);
+
     return (
         <div
             className={classNames(style.entry, { [style.active]: active })}
@@ -83,13 +73,13 @@ function HistoryEntry(
                 </Col>
                 <Col>
                     <span className={style.changesAmount}>
-                        {Object.keys(diffSummary)
-                            .map((diffType) => (
+                        {diffSummary
+                            .map((diff) => (
                                 <span
-                                    className={style[diffType]}
+                                    className={style[diff.type]}
                                     key={`history-diff-summary-${masterId}`}
                                 >
-                                    {`${diffSummary[diffType].amount} ${diffSummary[diffType].operation}`}
+                                    {`${diff.count} ${diff.operation}`}
                                 </span>
                             ))}
                     </span>
@@ -120,14 +110,16 @@ function HistoryEntry(
                     {userComment && (
                         <pre className={style.comment}>{userComment}</pre>
                     )}
-                    <Button
-                        type="button"
-                        color="link"
-                        className={style.editComment}
-                        onClick={editComment}
-                    >
-                        {getTranslation('history.userComment.edit', translations)}
-                    </Button>
+                    {editHistoryComments && (
+                        <Button
+                            type="button"
+                            color="link"
+                            className={style.editComment}
+                            onClick={editComment}
+                        >
+                            {getTranslation('history.userComment.edit', translations)}
+                        </Button>
+                    )}
                     <h5>
                         <strong>
                             {getTranslation('changes', translations)}
@@ -136,15 +128,15 @@ function HistoryEntry(
                     </h5>
                     {attributes.map((
                         {
-                            operationType,
+                            operationType: attrOperationType,
                             displayPropertyName,
                             oldValue,
                             newValue,
                         },
                     ) => {
                         let diff;
 
-                        switch (operationType) {
+                        switch (attrOperationType) {
                             case 'Insert':
                                 diff = `${newValue}`;
                                 break;
@@ -168,8 +160,8 @@ function HistoryEntry(
                                 key={`history-diff-${masterId}`}
                                 className={style.detail}
                             >
-                                <span className={style[operationType]}>
-                                    {getTypeSymbol(operationType)}
+                                <span className={style[attrOperationType]}>
+                                    {getTypeSymbol(attrOperationType)}
                                     {' '}
                                     {displayPropertyName}
                                     {': '}
@@ -197,12 +189,18 @@ HistoryEntry.propTypes = {
         id: PropTypes.number,
         modifiedAt: PropTypes.string,
         modifiedByUser: PropTypes.string,
+        diffSummary: PropTypes.arrayOf(PropTypes.shape({
+            type: PropTypes.string,
+            count: PropTypes.number,
+            operation: PropTypes.string,
+        })),
         userComment: PropTypes.string,
         modifiedByUserId: PropTypes.number,
-        operation: PropTypes.string,
-        operationType: PropTypes.string,
         timeAgo: PropTypes.string,
     }).isRequired,
+    userAccess: PropTypes.shape({
+        editHistoryComments: PropTypes.bool,
+    }),
     translations: PropTypes.shape({
         changes: PropTypes.string,
         history: PropTypes.arrayOf(PropTypes.shape({

diff --git a/projectforge-webapp/src/containers/page/form/history/index.jsx b/projectforge-webapp/src/containers/page/form/history/index.jsx
@@ -10,6 +10,7 @@ function FormHistory({
     id,
     visible = false,
     translations,
+    userAccess,
 }) {
     const [loading, setLoading] = useState(true);
     const [history, setHistory] = useState([]);
@@ -62,6 +63,7 @@ function FormHistory({
                     key={`history-entry-at-${entry.modifiedAt}`}
                     entry={entry}
                     translations={translations}
+                    userAccess={userAccess}
                 />
             ))}
         </LoadingContainer>
@@ -75,6 +77,9 @@ FormHistory.propTypes = {
     translations: PropTypes.shape({
         changes: PropTypes.string,
     }),
+    userAccess: PropTypes.shape({
+        editHistoryComments: PropTypes.bool,
+    }),
 };
 
 export default FormHistory;