Skip to content

Don't decode the result of ControllerActionId.getContainerPath #2150

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-tchad merged 4 commits into from
Nov 22, 2024
Merged

Don't decode the result of ControllerActionId.getContainerPath #2150

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
754b842
Don't double-decode container path
labkey-tchad Nov 21, 2024
86ad9e6
Update javadoc for 'getFolder'
labkey-tchad Nov 21, 2024
e29ebb4
Fix parsing of WebDav URLs and make parser test runnable.
labkey-tchad Nov 21, 2024
80fec07
Rename ControllerActionId.getFolder to getContainerPath
labkey-tchad Nov 21, 2024
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
129 changes: 89 additions & 40 deletions src/org/labkey/test/util/Crawler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@
import org.assertj.core.api.Assertions;
import org.eclipse.jetty.util.URIUtil;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.junit.Test;
import org.labkey.remoteapi.collections.CaseInsensitiveHashMap;
import org.labkey.test.BaseWebDriverTest;
import org.labkey.test.ExtraSiteWrapper;
Expand Down Expand Up @@ -524,7 +526,7 @@ else if (urlText.startsWith("?"))
if (null != getActionId() && _adminControllers.contains(getActionId().getController()))
p += (_prioritizeAdminPages ? -1 : 1);
// demote root directory
if (null != getActionId() && StringUtils.isBlank(StringUtils.strip(getActionId().getFolder(),"/")))
if (null != getActionId() && StringUtils.isBlank(StringUtils.strip(getActionId().getContainerPath(),"/")))
p += (_prioritizeAdminPages ? -1 : 1);
priority = p + random.nextFloat();

Expand Down Expand Up @@ -585,13 +587,13 @@ public boolean underCreatedProject()
if (null == getActionId())
return false;

String folder = StringUtils.strip(getActionId().getFolder(), "/");
String folder = StringUtils.strip(getActionId().getContainerPath(), "/");
StringTokenizer st = new StringTokenizer(folder, "/");

if (!st.hasMoreElements())
return false;

String currentProject = EscapeUtil.decode(st.nextToken());
String currentProject = st.nextToken();
if (StringUtils.isEmpty(currentProject))
return false;

Expand Down Expand Up @@ -643,7 +645,7 @@ public boolean isVisitableURL()

// in addition to test projects, we'll crawl all admin functionality as well
// (otherwise this never gets covered).
if (_adminControllers.contains(getActionId().getController()) && !"/home".equals(getActionId().getFolder()))
if (_adminControllers.contains(getActionId().getController()) && !"home".equals(getActionId().getContainerPath()))
return true;

for (Function<UrlToCheck, Boolean> check : _specialCrawlExclusions)
Expand All @@ -669,13 +671,13 @@ public static class ControllerActionId
{
@NotNull private final String _controller;
@NotNull private String _action = "";
private final String _folder;
private final String _containerPath;

public ControllerActionId(@NotNull String controller, @NotNull String action)
{
_controller = controller;
_action = action;
_folder = "";
_containerPath = null;
}

public ControllerActionId(@NotNull String url)
Expand All @@ -685,13 +687,27 @@ public ControllerActionId(@NotNull String url)
if (rootRelativeURL.startsWith("_webdav/"))
{
_controller = "_webdav";
_folder = EscapeUtil.decode(rootRelativeURL.substring("_webdav/".length()));
String path = EscapeUtil.decode(rootRelativeURL.substring("_webdav/".length()));
if (path.startsWith("@"))
{
_containerPath = "";
_action = path;
}
else
{
String[] splitPath = path.split("/@", 2); // container names can't begin with '@'
_containerPath = splitPath[0];
if (splitPath.length > 1)
{
_action = "@" + splitPath[1]; // Include file path as "action". e.g. "@files/folder/sample.txt"
}
}
return;
}
if (rootRelativeURL.startsWith("_webfiles/"))
{
_controller = "_webfiles";
_folder = EscapeUtil.decode(rootRelativeURL.substring("_webfiles/".length()));
_containerPath = EscapeUtil.decode(rootRelativeURL.substring("_webfiles/".length()));
return;
}

Expand Down Expand Up @@ -724,7 +740,7 @@ public ControllerActionId(@NotNull String url)
_controller = rootRelativeURL.substring(0, postControllerSlashIdx);
rootRelativeURL = rootRelativeURL.substring(postControllerSlashIdx+1);
}
_folder = EscapeUtil.decode(StringUtils.strip(rootRelativeURL, "/"));
_containerPath = EscapeUtil.decode(StringUtils.strip(rootRelativeURL, "/"));
}

@NotNull public String getAction()
Expand All @@ -739,11 +755,12 @@ public ControllerActionId(@NotNull String url)

/**
* Folder is parsed out for convenience only. Is ignored for equality and hash calculations.
* @return container path from parsed URL
* @return decoded containerPath from parsed URL, with no leading or trailing '/'. `null` if instance was not generated from a URL.
*/
public String getFolder()
@Nullable
public String getContainerPath()
{
return _folder;
return _containerPath;
}

@Override
Expand Down Expand Up @@ -773,34 +790,7 @@ public boolean equals(Object o)
public void crawlAllLinks()
{
// quick unit-test
{
ControllerActionId oldAction = new ControllerActionId("/controller/project/folder/action.view");
assertEquals("controller", oldAction.getController());
assertEquals("project/folder", oldAction.getFolder());
assertEquals("action", oldAction.getAction());
ControllerActionId containerRelativeAction = new ControllerActionId("/project/folder/controller-action.view");
assertEquals("controller", containerRelativeAction.getController());
assertEquals("project/folder", containerRelativeAction.getFolder());
assertEquals("action", containerRelativeAction.getAction());
assertEquals(oldAction, containerRelativeAction);
ControllerActionId subControllerOldAction = new ControllerActionId("/controller-sub/folder/action.view");
assertEquals("controller-sub", subControllerOldAction.getController());
assertEquals("folder", subControllerOldAction.getFolder());
assertEquals("action", subControllerOldAction.getAction());
ControllerActionId subControllerNewAction = new ControllerActionId("/folder/controller-sub-action.view");
assertEquals("controller-sub", subControllerNewAction.getController());
assertEquals("folder", subControllerNewAction.getFolder());
assertEquals("action", subControllerNewAction.getAction());
assertEquals(subControllerOldAction, subControllerNewAction);

ControllerActionId actionWithHash = new ControllerActionId("/project/folder/controller-app.view#/app/hash/path");
assertEquals("controller", actionWithHash.getController());
assertEquals("project/folder", actionWithHash.getFolder());
assertEquals("app", actionWithHash.getAction());

ControllerActionId webdavAction = new ControllerActionId("/_webdav/fred");
assertEquals("_webdav", webdavAction.getController());
}
new ControllerActionIdTest().testControllerActionIdParsing();

TestLogger.log("Starting crawl...");

Expand Down Expand Up @@ -1447,4 +1437,63 @@ String queryStringFromEntries(List<Map.Entry<String,String>> list)
);
return sb.toString();
}

public static class ControllerActionIdTest
{
@Test
public void testControllerActionIdParsing()
{
ControllerActionId oldAction = verifyParsedUrl("/controller/test%20project/sub%20folder/action.view",
"controller",
"test project/sub folder",
"action");
ControllerActionId containerRelativeAction = verifyParsedUrl("/test%20project/sub%20folder/controller-action.view",
"controller",
"test project/sub folder",
"action");
assertEquals(oldAction, containerRelativeAction);

ControllerActionId subControllerOldAction = verifyParsedUrl("/controller-sub/test%20project/sub%20folder/action.view",
"controller-sub",
"test project/sub folder",
"action");
ControllerActionId subControllerNewAction = verifyParsedUrl("/test%20project/sub%20folder/controller-sub-action.view",
"controller-sub",
"test project/sub folder",
"action");
assertEquals(subControllerOldAction, subControllerNewAction);

verifyParsedUrl("/test%20project/sub%20folder/controller-app.view#/app/hash/path",
"controller",
"test project/sub folder",
"app");

// webdav, no file
verifyParsedUrl("/_webdav/fred",
"_webdav",
"fred",
"");

// webdav at root project
verifyParsedUrl("/_webdav/%40files/folder/sample.txt",
"_webdav",
"",
"@files/folder/sample.txt");

// webfiles
verifyParsedUrl("/_webfiles/project/sub%20folder/folder/sample.txt",
"_webfiles",
"project/sub folder/folder/sample.txt",
"");
}

private ControllerActionId verifyParsedUrl(String url, String expectedController, String expectedContainerPath, String expectedAction)
{
ControllerActionId actionId = new ControllerActionId(url);
assertEquals(expectedController, actionId.getController());
assertEquals(expectedContainerPath, actionId.getContainerPath());
assertEquals(expectedAction, actionId.getAction());
return actionId;
}
}
}