metadata history viewing with user profile level #7450

wangf1122 · 2023-10-23T13:23:52Z

This PR will add such configuration to restrict user profile level to see the record history. The default is set to Editor level which was the old default level. But the feature itself gives more control to the system admin to allow certain level of user to see the history.

On the setting page:

Please note this feature will need 3.12.x backporting. The UI html is different in 3.12.x

core-geonetwork/web-ui/src/main/resources/catalog/views/default/templates/recordView.html

Lines 691 to 693 in 1105846

    
             <div data-ng-show="isRecordHistoryEnabled && user.isEditorOrMore() && mdView.current.record.draft != 'y'" 
        
                 data-gn-record-history="mdView.current.record"></div> 
        
           </div>

There will be another small pull request for 3.12 after this one merged.

ianwallen · 2023-10-29T11:26:38Z

Note: I would expect to also see permissions checks added to the api to ensure that only the people with the correct permissions are able to run the api.

wangf1122 · 2023-10-30T15:30:50Z

Note: I would expect to also see permissions checks added to the api to ensure that only the people with the correct permissions are able to run the api.

I cannot find the related API. It was using genera search feature and we cannot block search result. Can you point me which specific backend service we can potentially block?

ianwallen · 2023-10-30T17:09:18Z

@wangf1122
The following api is used to show history information

wangf1122 · 2023-10-30T17:44:09Z

@wangf1122 The following api is used to show history information

@ianwallen

Thanks. This seems the right API.

But FYI, the 4.0 API is different from 3.12. We will need to resolve the merging issue also need a separated PR to deal with 3.12.

Here is the 4.0 API

core-geonetwork/services/src/main/java/org/fao/geonet/api/records/MetadataWorkflowApi.java

Lines 636 to 640 in b417ead

    
           @RequestMapping(produces = MediaType.APPLICATION_JSON_VALUE, method = RequestMethod.GET, path = "/status/search") 
        
           @ResponseStatus(value = HttpStatus.OK) 
        
           @PreAuthorize("hasAuthority('Editor')") 
        
           @ResponseBody 
        
           public List<MetadataStatusResponse> getWorkflowStatusByType(

vs the 3.12

core-geonetwork/services/src/main/java/org/fao/geonet/api/records/MetadataWorkflowApi.java

Lines 605 to 609 in 3cda243

    
           @RequestMapping(produces = MediaType.APPLICATION_JSON_VALUE, method = RequestMethod.GET, path = "/status/search") 
        
           @ResponseStatus(value = HttpStatus.OK) 
        
           @PreAuthorize("hasAuthority('Editor')") 
        
           @ResponseBody 
        
           public List<MetadataStatusResponse> getStatusByType(

The method is renamed from getStatusByType in 3.12 to getWorkflowStatusByType in 4.0

services/src/main/java/org/fao/geonet/api/records/MetadataWorkflowApi.java

ianwallen · 2023-11-01T11:35:36Z

As you need to enable history in the Metadata configuration section

You may want to move your options to that section as well.

… level setting

wangf1122 · 2023-11-01T14:21:59Z

As you need to enable history in the Metadata configuration section

You may want to move your options to that section as well.

I attempt this. No luck. This config was part of system/metadata. It treated /system path as special path. I also attempt to put such configuration to the system path but the select drop down UI didn't work properly.

web-ui/src/main/resources/catalog/js/CatController.js

services/src/main/java/org/fao/geonet/api/records/MetadataWorkflowApi.java

…egistered user is allowed to see history

…egistered user is allowed to see history.

…red user level for viewing data.

services/src/main/java/org/fao/geonet/api/records/MetadataWorkflowApi.java

josegar74 · 2023-11-16T11:57:34Z

services/src/main/java/org/fao/geonet/api/records/MetadataWorkflowApi.java

@@ -704,7 +712,12 @@ public List<MetadataStatusResponse> getWorkflowStatusByType(
            if (!CollectionUtils.isEmpty(recordIdentifier)) {
                for (Integer recordId : recordIdentifier) {
                    try {
-                        ApiUtils.canEditRecord(String.valueOf(recordId), request);
+                        if (allowedAccessLevelProfile == Profile.RegisteredUser) {


With this change, when selecting the RegisteredUser access level, users will be able to see the history of metadata that they can view, while selecting other values, only the metadata they can edit.

I think at least should be added some explanation in https://github.com/geonetwork/core-geonetwork/pull/7450/files#diff-e312a431007c32b1300d73d63418ba4ef8154f864ce4734d7461822738478ca9R886

Also at the end of this manual page a section describing the feature would be good: https://docs.geonetwork-opensource.org/4.2/administrator-guide/configuring-the-catalog/system-configuration/

I have update both help text, also add the the section in system-configuration.md

josegar74 · 2023-11-16T11:59:14Z

web/src/main/webapp/WEB-INF/classes/setup/sql/migrate/v440/migrate-default.sql

@@ -2,3 +2,4 @@ UPDATE Settings SET value='4.4.0' WHERE name='system/platform/version';
 UPDATE Settings SET value='0' WHERE name='system/platform/subVersion';

 INSERT INTO Settings (name, value, datatype, position, internal) SELECT distinct 'metadata/batchediting/accesslevel', 'Editor', 0, 12020, 'n' from settings WHERE NOT EXISTS (SELECT name FROM Settings WHERE name = 'metadata/batchediting/accesslevel');
+INSERT INTO Settings (name, value, datatype, position, internal) SELECT distinct 'metadata/history/accesslevel', 'Editor', 0, 12021, 'n' from settings WHERE NOT EXISTS (SELECT name FROM Settings WHERE name = 'metadata/history/accesslevel');


This change should be moved to https://github.com/geonetwork/core-geonetwork/blob/main/web/src/main/webapp/WEB-INF/classes/setup/sql/migrate/v441/migrate-default.sql

I moved the script to v441. I also added update statement to set the name of system/metadata/history/enabled to metadata/history/enabled as you suggested in another comment

josegar74 · 2023-11-16T12:01:35Z

web-ui/src/main/resources/catalog/js/CatController.js

+              return true;
+            }
+            return angular.isFunction(this[fnName]) ? this[fnName]() : false;
+          },


Please update the file with prettier formatting.

The format was indeed lining with all methods. It was copy pasted. Here is what my IDE looks like. The pretty formatting will need to be at the whole file level not limited to the code that I commit.

josegar74 · 2023-12-13T14:52:07Z

web/src/main/webapp/WEB-INF/classes/setup/sql/migrate/v350/migrate-default.sql

@@ -5,7 +5,7 @@ INSERT INTO Settings (name, value, datatype, position, internal) VALUES ('system
 INSERT INTO Settings (name, value, datatype, position, internal) VALUES ('system/publication/doi/doipassword', '', 0, 194, 'n');
 INSERT INTO Settings (name, value, datatype, position, internal) VALUES ('system/publication/doi/doikey', '', 0, 195, 'n');
 INSERT INTO Settings (name, value, datatype, position, internal) VALUES ('system/publication/doi/doilandingpagetemplate', 'http://localhost:8080/geonetwork/srv/resources/records/{{uuid}}', 0, 195, 'n');
-INSERT INTO Settings (name, value, datatype, position, internal) VALUES ('system/metadata/history/enabled', 'false', 2, 9171, 'n');
+INSERT INTO Settings (name, value, datatype, position, internal) VALUES ('metadata/history/enabled', 'false', 2, 9171, 'n');


This change is not required, would be done in the 4.4.2 migration.

I have removed the change. The update itself will be part of 442 script

josegar74 · 2023-12-13T14:55:36Z

web-ui/src/main/resources/catalog/js/CatController.js

+                profile !== ""
+                  ? "is" + profile[0].toUpperCase() + profile.substring(1) + "OrMore"
+                  : "";
+            if (profile === "RegisteredUser") {


Is this check required because there is no RegisteredUserOrMore function defined I guess?

There is no RegisteredUserOrMore function and this is why I am adding this condition. There is a case when the user is totally not logged in, like the was access by some random internet visitor

…el' into main.metadata.history.access.level # Conflicts: # web/src/main/webapp/WEB-INF/classes/setup/sql/migrate/v443/migrate-default.sql

josegar74 · 2024-03-27T10:04:32Z

@wangf1122 https://github.com/wangf1122/core-geonetwork/blob/a499d1eb57a0f4a0a6596ae91ccecbefe0e0ee9b/web-ui/src/main/resources/catalog/components/search/mdview/mdviewModule.js#L108 requires to be updated.

josegar74

@wangf1122 Tested, looks ok.

Please check the to update the setting name in https://github.com/wangf1122/core-geonetwork/blob/a499d1eb57a0f4a0a6596ae91ccecbefe0e0ee9b/web-ui/src/main/resources/catalog/components/search/mdview/mdviewModule.js#L108

Also resolve the conflicts and move the SQL migration to 4.4.4.

wangf1122 · 2024-03-27T12:45:37Z

@wangf1122 https://github.com/wangf1122/core-geonetwork/blob/a499d1eb57a0f4a0a6596ae91ccecbefe0e0ee9b/web-ui/src/main/resources/catalog/components/search/mdview/mdviewModule.js#L108 requires to be updated.

@josegar74

I have made the change, thanks for pointing it out

geonetworkbuild · 2024-04-05T14:16:49Z

The backport to 3.12.x failed:

The process '/usr/bin/git' failed with exit code 1

stderr

error: could not apply ba0888f642... metadata history viewing with user profile level
hint: After resolving the conflicts, mark them with
hint: "git add/rm <pathspec>", then run
hint: "git cherry-pick --continue".
hint: You can instead skip this commit with "git cherry-pick --skip".
hint: To abort and get back to the state before "git cherry-pick",
hint: run "git cherry-pick --abort".

stdout

Auto-merging web-ui/src/main/resources/catalog/js/CatController.js
Auto-merging web-ui/src/main/resources/catalog/locales/en-admin.json
CONFLICT (content): Merge conflict in web-ui/src/main/resources/catalog/locales/en-admin.json
Auto-merging web-ui/src/main/resources/catalog/templates/admin/settings/system.html
CONFLICT (content): Merge conflict in web-ui/src/main/resources/catalog/templates/admin/settings/system.html
CONFLICT (modify/delete): web-ui/src/main/resources/catalog/views/default/templates/recordView/footer.html deleted in HEAD and modified in ba0888f642 (metadata history viewing with user profile level).  Version ba0888f642 (metadata history viewing with user profile level) of web-ui/src/main/resources/catalog/views/default/templates/recordView/footer.html left in tree.
Auto-merging web/src/main/webapp/WEB-INF/classes/setup/sql/data/data-db-default.sql
Auto-merging web/src/main/webapp/WEB-INF/classes/setup/sql/migrate/v31211/migrate-default.sql

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-3.12.x 3.12.x
# Navigate to the new working tree
cd .worktrees/backport-3.12.x
# Create a new branch
git switch --create backport-7450-to-3.12.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick ba0888f64271446814ae26ba5f1880b385ccb431,b7f7b3ee21916d01240bf776d14651159d778e0f,fd48d9fef40bc3f8a265c3808fad09d526bb29bd,9b4b3f6501514f04eb6f329b4df67efac356c296,7c2d18419ec384d6cf41d8fe0b3b7bc65ee26000,9e9d09a33ed4a27eddd7421c7623bb81ad8de37f,4c224296468b0cac9a3e5148197af8fcc4e40977,7709646684d747208b7c940ff3c4c9721f5f0bc2,ac9d91ce1e66bdf9f1777c393d803a1026a97e29,c294463be98578e97b39a44abafd77f803217cd6,8d13b8eaa985bcb8ec58c75dde58be95c42bf290,0dcfcab998a0224e698da7773aa99fe32d555409,deaf064c56842a9ab99101b1eaafe2c61d8e720b,4f16b91e014fe8321e3eb6269687b8036b7a7d31,e2e76ffb5361d397c0b9a384e25e24c0274135d7,7974efa28df068f6aaf2a12afb8b3d6aeb54b585,80eddabf769ab2bc6c36fc0c789f540af517386d,f4ee0866392797b07133da680ea429182dd250ad,d908561e2f3b64f6b79122a96fc975ef621bd218,3d172b855cbd502ffc3e5530cd1304583cb42e2f,9aa3b6edd097ee919b0e42fa4b633564235fddcc,62dfa16821c1d0b30dbaec76d41bb2e547a65e36,f2a5ffa67faad40475c3173db0e67cfd35c3e51b,9ac4bcfcfa96aa96531e6d27589163ec7b5cc182,38e31a5b458d380b722750a8922420e7c0ffe70b,a499d1eb57a0f4a0a6596ae91ccecbefe0e0ee9b,87e2637eb0a6db8397dac72a5a2e6d01cfb73ffe,ead9a51b78f01ddcd0e9a979cfd161b0b8015706,eac2007602a740541218bcf5ea16ec9e72c7ad31,9fa5a4b540d0f2b598be8f2e969fc9e192ce9982
# Push it to GitHub
git push --set-upstream origin backport-7450-to-3.12.x
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-3.12.x

Then, create a pull request where the base branch is 3.12.x and the compare/head branch is backport-7450-to-3.12.x.

geonetworkbuild · 2024-04-05T14:16:52Z

The backport to 4.2.x failed:

The process '/usr/bin/git' failed with exit code 1

stderr

error: could not apply ba0888f642... metadata history viewing with user profile level
hint: After resolving the conflicts, mark them with
hint: "git add/rm <pathspec>", then run
hint: "git cherry-pick --continue".
hint: You can instead skip this commit with "git cherry-pick --skip".
hint: To abort and get back to the state before "git cherry-pick",
hint: run "git cherry-pick --abort".

stdout

Auto-merging web-ui/src/main/resources/catalog/js/CatController.js
Auto-merging web-ui/src/main/resources/catalog/locales/en-admin.json
Auto-merging web-ui/src/main/resources/catalog/templates/admin/settings/system.html
Auto-merging web/src/main/webapp/WEB-INF/classes/setup/sql/data/data-db-default.sql
CONFLICT (modify/delete): web/src/main/webapp/WEB-INF/classes/setup/sql/migrate/v440/migrate-default.sql deleted in HEAD and modified in ba0888f642 (metadata history viewing with user profile level).  Version ba0888f642 (metadata history viewing with user profile level) of web/src/main/webapp/WEB-INF/classes/setup/sql/migrate/v440/migrate-default.sql left in tree.

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-4.2.x 4.2.x
# Navigate to the new working tree
cd .worktrees/backport-4.2.x
# Create a new branch
git switch --create backport-7450-to-4.2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick ba0888f64271446814ae26ba5f1880b385ccb431,b7f7b3ee21916d01240bf776d14651159d778e0f,fd48d9fef40bc3f8a265c3808fad09d526bb29bd,9b4b3f6501514f04eb6f329b4df67efac356c296,7c2d18419ec384d6cf41d8fe0b3b7bc65ee26000,9e9d09a33ed4a27eddd7421c7623bb81ad8de37f,4c224296468b0cac9a3e5148197af8fcc4e40977,7709646684d747208b7c940ff3c4c9721f5f0bc2,ac9d91ce1e66bdf9f1777c393d803a1026a97e29,c294463be98578e97b39a44abafd77f803217cd6,8d13b8eaa985bcb8ec58c75dde58be95c42bf290,0dcfcab998a0224e698da7773aa99fe32d555409,deaf064c56842a9ab99101b1eaafe2c61d8e720b,4f16b91e014fe8321e3eb6269687b8036b7a7d31,e2e76ffb5361d397c0b9a384e25e24c0274135d7,7974efa28df068f6aaf2a12afb8b3d6aeb54b585,80eddabf769ab2bc6c36fc0c789f540af517386d,f4ee0866392797b07133da680ea429182dd250ad,d908561e2f3b64f6b79122a96fc975ef621bd218,3d172b855cbd502ffc3e5530cd1304583cb42e2f,9aa3b6edd097ee919b0e42fa4b633564235fddcc,62dfa16821c1d0b30dbaec76d41bb2e547a65e36,f2a5ffa67faad40475c3173db0e67cfd35c3e51b,9ac4bcfcfa96aa96531e6d27589163ec7b5cc182,38e31a5b458d380b722750a8922420e7c0ffe70b,a499d1eb57a0f4a0a6596ae91ccecbefe0e0ee9b,87e2637eb0a6db8397dac72a5a2e6d01cfb73ffe,ead9a51b78f01ddcd0e9a979cfd161b0b8015706,eac2007602a740541218bcf5ea16ec9e72c7ad31,9fa5a4b540d0f2b598be8f2e969fc9e192ce9982
# Push it to GitHub
git push --set-upstream origin backport-7450-to-4.2.x
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-4.2.x

Then, create a pull request where the base branch is 4.2.x and the compare/head branch is backport-7450-to-4.2.x.

Allow metadata history viewing with user profile level Co-authored-by: Jose García <[email protected]>

Allow metadata history viewing with user profile level Co-authored-by: wangf1122 <[email protected]> Co-authored-by: Jose García <[email protected]>

metadata history viewing with user profile level

ba0888f

wangf1122 marked this pull request as ready for review October 23, 2023 13:45

josegar74 added this to the 4.4.1 milestone Oct 23, 2023

ianwallen added backport 3.12.x backport 4.2.x labels Oct 29, 2023

ianwallen requested a review from josegar74 October 29, 2023 11:09

wangf1122 added 2 commits October 30, 2023 13:52

Access level restriction to /status/search API

b7f7b3e

error message update

fd48d9f

ianwallen reviewed Oct 31, 2023

View reviewed changes

services/src/main/java/org/fao/geonet/api/records/MetadataWorkflowApi.java Outdated Show resolved Hide resolved

comment description

9b4b3f6

allow registered user to view metadata history and part of the access…

7c2d184

… level setting

ianwallen reviewed Nov 2, 2023

View reviewed changes

web-ui/src/main/resources/catalog/js/CatController.js Show resolved Hide resolved

web-ui/src/main/resources/catalog/js/CatController.js Outdated Show resolved Hide resolved

web-ui/src/main/resources/catalog/js/CatController.js Outdated Show resolved Hide resolved

remove log

9e9d09a

ianwallen reviewed Nov 3, 2023

View reviewed changes

services/src/main/java/org/fao/geonet/api/records/MetadataWorkflowApi.java Outdated Show resolved Hide resolved

wangf1122 added 3 commits November 3, 2023 15:16

Not check edit privilege if the user profile is registered user and r…

4c22429

…egistered user is allowed to see history

Not check edit privilege if the user profile is registered user and r…

7709646

…egistered user is allowed to see history.

remove reviewer to access level setup. Add security check for registe…

ac9d91c

…red user level for viewing data.

ianwallen reviewed Nov 7, 2023

View reviewed changes

services/src/main/java/org/fao/geonet/api/records/MetadataWorkflowApi.java Show resolved Hide resolved

wangf1122 and others added 3 commits November 7, 2023 08:46

remove configuration profile level check

c294463

Merge branch 'geonetwork:main' into main.metadata.history.access.level

8d13b8e

Removed junk code

0dcfcab

ianwallen approved these changes Nov 15, 2023

View reviewed changes

josegar74 reviewed Nov 16, 2023

View reviewed changes

ianwallen requested a review from josegar74 December 13, 2023 14:01

josegar74 reviewed Dec 13, 2023

View reviewed changes

wangf1122 and others added 2 commits January 15, 2024 12:43

Merge branch 'main' into main.metadata.history.access.level

3d172b8

revert migration script.

9aa3b6e

wangf1122 force-pushed the main.metadata.history.access.level branch from 6e08271 to 9aa3b6e Compare January 15, 2024 18:08

ianwallen requested a review from josegar74 January 15, 2024 18:19

fxprunayre modified the milestones: 4.4.2, 4.4.3 Jan 23, 2024

wangf1122 and others added 5 commits January 23, 2024 10:30

Merge branch 'main' into main.metadata.history.access.level

62dfa16

443 migration script

f2a5ffa

Merge remote-tracking branch 'origin/main.metadata.history.access.lev…

9ac4bcf

…el' into main.metadata.history.access.level # Conflicts: # web/src/main/webapp/WEB-INF/classes/setup/sql/migrate/v443/migrate-default.sql

443 migration script

38e31a5

revert 442 script merge junks

a499d1e

fxprunayre modified the milestones: 4.4.3, 4.4.4 Mar 13, 2024

josegar74 approved these changes Mar 27, 2024

View reviewed changes

change metadata/history/enabled property path in mdviewModule javascript

87e2637

wangf1122 added 3 commits April 5, 2024 09:20

Merge branch 'main' into main.metadata.history.access.level

ead9a51

Update migrate-default.sql

eac2007

Update migrate-default.sql

9fa5a4b

ianwallen merged commit c67fea3 into geonetwork:main Apr 5, 2024
7 checks passed

geonetworkbuild added the failed backport label Apr 5, 2024

ianwallen pushed a commit to ianwallen/core-geonetwork that referenced this pull request Apr 5, 2024

metadata history viewing with user profile level (geonetwork#7450)

d4f93a8

Allow metadata history viewing with user profile level Co-authored-by: Jose García <[email protected]>

ianwallen mentioned this pull request Apr 5, 2024

[Backport 4.2.x] metadata history viewing with user profile level (#7450) #7934

Merged

ianwallen added a commit that referenced this pull request Apr 5, 2024

metadata history viewing with user profile level (#7450) (#7934)

0c9bc11

Allow metadata history viewing with user profile level Co-authored-by: wangf1122 <[email protected]> Co-authored-by: Jose García <[email protected]>

ianwallen removed the backport 3.12.x label Apr 7, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

metadata history viewing with user profile level #7450

metadata history viewing with user profile level #7450

wangf1122 commented Oct 23, 2023 •

edited

Loading

ianwallen commented Oct 29, 2023

wangf1122 commented Oct 30, 2023

ianwallen commented Oct 30, 2023

wangf1122 commented Oct 30, 2023

ianwallen commented Nov 1, 2023

wangf1122 commented Nov 1, 2023

josegar74 Nov 16, 2023

wangf1122 Nov 16, 2023

josegar74 Nov 16, 2023

wangf1122 Nov 16, 2023

josegar74 Nov 16, 2023

wangf1122 Nov 16, 2023

josegar74 Dec 13, 2023

wangf1122 Jan 15, 2024 •

edited

Loading

josegar74 Dec 13, 2023

wangf1122 Dec 13, 2023

josegar74 commented Mar 27, 2024

josegar74 left a comment

wangf1122 commented Mar 27, 2024

geonetworkbuild commented Apr 5, 2024

geonetworkbuild commented Apr 5, 2024

	<div data-ng-show="isRecordHistoryEnabled && user.isEditorOrMore() && mdView.current.record.draft != 'y'"
	data-gn-record-history="mdView.current.record"></div>
	</div>

metadata history viewing with user profile level #7450

metadata history viewing with user profile level #7450

Conversation

wangf1122 commented Oct 23, 2023 • edited Loading

ianwallen commented Oct 29, 2023

wangf1122 commented Oct 30, 2023

ianwallen commented Oct 30, 2023

wangf1122 commented Oct 30, 2023

ianwallen commented Nov 1, 2023

wangf1122 commented Nov 1, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wangf1122 Jan 15, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

josegar74 commented Mar 27, 2024

josegar74 left a comment

Choose a reason for hiding this comment

wangf1122 commented Mar 27, 2024

geonetworkbuild commented Apr 5, 2024

geonetworkbuild commented Apr 5, 2024

wangf1122 commented Oct 23, 2023 •

edited

Loading

wangf1122 Jan 15, 2024 •

edited

Loading