Skip to content

Convert FeeScheduleController to use FileLike #820

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
labkey-bpatel merged 3 commits into from
Apr 15, 2025
Merged

Convert FeeScheduleController to use FileLike #820

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b337d2d
FileLike conversion in FeeScheduleController
labkey-bpatel Apr 11, 2025
6bbbd18
Relativize file path
labkey-bpatel Apr 11, 2025
c8ab46a
setLogFile() with FileLike. Use FileLike in getView(), validateComman…
labkey-bpatel Apr 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 40 additions & 4 deletions snprc_ehr/src/org/labkey/snprc_ehr/controllers/FeeScheduleController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,18 +29,24 @@
import org.labkey.api.security.RequiresPermission;
import org.labkey.api.security.permissions.AdminPermission;
import org.labkey.api.util.PageFlowUtil;
import org.labkey.api.util.Path;
import org.labkey.api.util.URIUtil;
import org.labkey.api.util.URLHelper;
import org.labkey.api.view.ActionURL;
import org.labkey.api.view.JspView;
import org.labkey.api.view.NavTree;
import org.labkey.api.view.NotFoundException;
import org.labkey.snprc_ehr.pipeline.FeeScheduleExcelParser;
import org.labkey.snprc_ehr.pipeline.FeeScheduleImportForm;
import org.labkey.snprc_ehr.pipeline.FeeSchedulePipelineJob;
import org.labkey.vfs.FileLike;
import org.labkey.vfs.FileSystemLike;
import org.springframework.validation.BindException;
import org.springframework.validation.Errors;
import org.springframework.web.servlet.ModelAndView;

import java.io.File;
import java.net.URI;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.List;
Expand Down Expand Up @@ -108,7 +114,8 @@ public ModelAndView getView(FeeScheduleImportForm form, boolean reshow, BindExce
FeeScheduleExcelParser fsep;
if (form.getFilePath() != null)
{
file = new File(form.getFilePath());
//file path here is constructed from the pipeline, and contains pipeline root + file.
file = getVerifiedFile(form.getFilePath());
}
if (file != null && file.exists())
{
Expand Down Expand Up @@ -146,24 +153,53 @@ public ModelAndView getView(FeeScheduleImportForm form, boolean reshow, BindExce
return new JspView<>("/org/labkey/snprc_ehr/pipeline/FeeScheduleImport.jsp", form, errors);
}

private File getVerifiedFile(String filePath)
Copy link
Contributor

@Sigmonia Sigmonia Apr 14, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@labkey-matthewb Would it be generally useful to have this a helper method on the Piperoot/PipelineService? Adding either the root or the container as a parameter makes this validation pretty generic for parsing incoming file paths.

Copy link
Contributor Author

@labkey-bpatel labkey-bpatel Apr 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@labkey-ians I was wondering the same

Copy link
Contributor Author

@labkey-bpatel labkey-bpatel Apr 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@labkey-ians Since @labkey-matthewb is out this week, we can table this discussion and come back to it. In the meantime, I'll merge the PR.

{
File fileToVerify = new File(filePath);

PipeRoot pipeRoot = PipelineService.get().findPipelineRoot(getContainer());
if (pipeRoot == null)
{
throw new NotFoundException("Could not find a pipeline root for '" + getContainer().getPath() + "'");
}

FileLike allowedRoot = pipeRoot.getRootFileLike();
URI relativeURI = URIUtil.relativize(allowedRoot.toURI(), fileToVerify.toURI()); // if root = /a/b/c/ and file = /a/b/c/d/e/f.xlsx, relativeURI = d/e/f.xlsx

if (relativeURI == null)
{
throw new IllegalArgumentException("File '" + fileToVerify.toURI().getPath() + "' is outside the allowed root '" + allowedRoot.toURI().getPath() + "'");
}

if (allowedRoot.isDescendant(fileToVerify.toURI())) // if root = /a/b/c/ and file = /a/b/c/d/e/f.xlsx - among other things, this essentially checks if '/a/b/c/d/e/f.xlsx' starts with '/a/b/c/'
{
return FileSystemLike.toFile(allowedRoot.resolveFile(new Path(relativeURI.getPath())));
}
else
{
throw new IllegalArgumentException("File '" + relativeURI.getPath() + "' is not a descendent of '" + allowedRoot.toURI().getPath() + "'");
}
}

@Override
public void validateCommand(FeeScheduleImportForm form, Errors errors)
{
_fsFile = new File(form.getFilePath());
_fsFile = getVerifiedFile(form.getFilePath());
// Be sure that the referenced file exists
if (_fsFile == null || !_fsFile.exists())
if (!_fsFile.exists())
{
errors.reject(ERROR_MSG, "Could not find file at path: " + form.getFilePath());
}
}

@Override
public boolean handlePost(FeeScheduleImportForm form, BindException errors)
{
//queues up the pipeline job
try
{
PipeRoot pipelineRoot = PipelineService.get().findPipelineRoot(getContainer());
PipelineService.get().queueJob(new FeeSchedulePipelineJob(getContainer(), getUser(), getViewContext().getActionURL(), pipelineRoot, _fsFile, form));
PipelineService.get().queueJob(new FeeSchedulePipelineJob(getContainer(), getUser(), getViewContext().getActionURL(), pipelineRoot, getVerifiedFile(_fsFile.getAbsolutePath()), form));

_url = PageFlowUtil.urlProvider(PipelineStatusUrls.class).urlBegin(getContainer().getProject());
_url.addParameter("StatusFiles.containerFilterName", ContainerFilter.Type.CurrentAndSubfolders.name());
Expand Down
6 changes: 5 additions & 1 deletion snprc_ehr/src/org/labkey/snprc_ehr/pipeline/FeeSchedulePipelineJob.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,12 @@
import org.labkey.api.pipeline.PipelineJobException;
import org.labkey.api.security.User;
import org.labkey.api.util.FileUtil;
import org.labkey.api.util.Path;
import org.labkey.api.util.URLHelper;
import org.labkey.api.view.ActionURL;
import org.labkey.api.view.ViewBackgroundInfo;
import org.labkey.vfs.FileLike;
import org.labkey.vfs.FileSystemLike;

import java.io.File;

Expand All @@ -47,7 +50,8 @@ public FeeSchedulePipelineJob(Container c, User user, ActionURL url, PipeRoot pi
{
super(null, new ViewBackgroundInfo(c, user, url), pipeRoot);
_importFile = importFile;
setLogFile(new File(pipeRoot.getRootPath(), FileUtil.makeFileNameWithTimestamp("FeeSchedulePipeline", "log")));
FileLike logFile = pipeRoot.getLogDirectoryFileLike(true).resolveChild(FileUtil.makeFileNameWithTimestamp("FeeSchedulePipeline", "log"));
setLogFile(logFile.toNioPathForWrite());
_form = form;
_container = c;
_user = user;
Expand Down