-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Bxc 4313 single use links api (#1654)
* BXC-4313 starting API and getting tests to pass * BXC-4313 starting on download endpoint * BXC-4313 progress on download endpoint * BXC-4313 update download endpoint to use streamData method * BXC-4313 download endpoint test works * BXC-4313 cleanup * BXC-4313 fix datastream controller tests * BXC-4313 more cleanup * BXC-4360 address comments in PR * BXC-4360 fix exception message * BXC-4360 sync front and and back end * BXC-4360 fix js test * BXC-4360 update front end after suggestions --------- Co-authored-by: Sharon Luong <[email protected]>
- Loading branch information
1 parent
b048ac5
commit a342d34
Showing
12 changed files
with
441 additions
and
59 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
97 changes: 97 additions & 0 deletions
97
...services-app/src/main/java/edu/unc/lib/boxc/web/services/rest/SingleUseKeyController.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| package edu.unc.lib.boxc.web.services.rest; | ||
|
|
||
| import edu.unc.lib.boxc.auth.api.Permission; | ||
| import edu.unc.lib.boxc.auth.api.models.AccessGroupSet; | ||
| import edu.unc.lib.boxc.auth.api.services.AccessControlService; | ||
| import edu.unc.lib.boxc.model.api.exceptions.InvalidOperationForObjectType; | ||
| import edu.unc.lib.boxc.model.api.exceptions.NotFoundException; | ||
| import edu.unc.lib.boxc.model.api.exceptions.RepositoryException; | ||
| import edu.unc.lib.boxc.model.api.ids.PID; | ||
| import edu.unc.lib.boxc.model.api.objects.ContentObject; | ||
| import edu.unc.lib.boxc.model.api.objects.FileObject; | ||
| import edu.unc.lib.boxc.model.api.objects.RepositoryObjectLoader; | ||
| import edu.unc.lib.boxc.model.fcrepo.ids.PIDs; | ||
| import edu.unc.lib.boxc.web.common.services.FedoraContentService; | ||
| import edu.unc.lib.boxc.web.common.utils.AnalyticsTrackerUtil; | ||
| import edu.unc.lib.boxc.web.services.processing.SingleUseKeyService; | ||
| import org.apache.commons.lang3.StringUtils; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
| import org.springframework.beans.factory.annotation.Autowired; | ||
| import org.springframework.http.HttpStatus; | ||
| import org.springframework.http.ResponseEntity; | ||
| import org.springframework.stereotype.Controller; | ||
| import org.springframework.web.bind.annotation.PathVariable; | ||
| import org.springframework.web.bind.annotation.RequestMapping; | ||
| import org.springframework.web.bind.annotation.RequestMethod; | ||
|
|
||
| import javax.servlet.http.HttpServletRequest; | ||
| import javax.servlet.http.HttpServletResponse; | ||
| import java.io.IOException; | ||
| import java.io.InputStream; | ||
|
|
||
| import static edu.unc.lib.boxc.auth.fcrepo.services.GroupsThreadStore.getAgentPrincipals; | ||
| import static edu.unc.lib.boxc.model.api.DatastreamType.ORIGINAL_FILE; | ||
|
|
||
| /** | ||
| * Controller for generating and utilizing single use links for a specific UUID | ||
| * | ||
| * @author snluong | ||
| */ | ||
| @Controller | ||
| public class SingleUseKeyController { | ||
| private static final Logger log = LoggerFactory.getLogger(SingleUseKeyController.class); | ||
| @Autowired | ||
| private AccessControlService aclService; | ||
| @Autowired | ||
| private SingleUseKeyService singleUseKeyService; | ||
| @Autowired | ||
| private RepositoryObjectLoader repositoryObjectLoader; | ||
| @Autowired | ||
| private FedoraContentService fedoraContentService; | ||
| @Autowired | ||
| private AnalyticsTrackerUtil analyticsTracker; | ||
|
|
||
| @RequestMapping(value = "/single_use_link/create/{id}", method = RequestMethod.POST) | ||
| public ResponseEntity<Object> generate(@PathVariable("id") String id) { | ||
| var pid = PIDs.get(id); | ||
| // requester must have the right permission | ||
| var agent= getAgentPrincipals(); | ||
| aclService.assertHasAccess("Insufficient permissions to generate single use link for " + id, | ||
| pid, agent.getPrincipals(), Permission.viewHidden); | ||
|
|
||
| // check if object is a FileObject | ||
| ContentObject obj = (ContentObject) repositoryObjectLoader.getRepositoryObject(pid); | ||
| if (!(obj instanceof FileObject)) { | ||
| throw new InvalidOperationForObjectType("Single use link cannot be generated for " + | ||
| obj.getClass().getName() + " objects."); | ||
| } | ||
|
|
||
| var keyInfo = singleUseKeyService.generate(id); | ||
| log.info("Single use link created for UUID {} by user {}", id, agent.getUsername()); | ||
| return new ResponseEntity<>(keyInfo, HttpStatus.OK); | ||
| } | ||
|
|
||
| @RequestMapping(value = "/single_use_link/{key}", method = RequestMethod.GET) | ||
| public void download(@PathVariable("key") String accessKey, HttpServletRequest request, | ||
| HttpServletResponse response) { | ||
| try { | ||
| if (singleUseKeyService.keyIsValid(accessKey)) { | ||
| var id = singleUseKeyService.getId(accessKey); | ||
| var pid = PIDs.get(id); | ||
| var datastream = ORIGINAL_FILE.getId(); | ||
| var principals = getAgentPrincipals().getPrincipals(); | ||
|
|
||
| singleUseKeyService.invalidate(accessKey); | ||
| fedoraContentService.streamData(pid, datastream, true, response); | ||
| log.info("Single use link used. Access Key: {}, UUID: {}", accessKey, id); | ||
| analyticsTracker.trackEvent(request, "download", pid, principals); | ||
| } else { | ||
| throw new NotFoundException("Single use key is not valid: " + accessKey); | ||
| } | ||
| } catch (IOException e) { | ||
| log.error("Download single use link did not work:", e); | ||
| throw new RepositoryException("Failed to download file using single use access key: " + accessKey); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.