Normalize frontpage directory parameters before rendering the bundled theme #169
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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,209 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. The ASF licenses this file to You | ||
| * under the Apache License, Version 2.0 (the "License"); you may not | ||
| * use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or | ||
| * implied. See the License for the specific language governing | ||
| * permissions and limitations under the License. For additional | ||
| * information regarding copyright in this work, please see the NOTICE | ||
| * file in the top level directory of this distribution. | ||
| */ | ||
| package org.apache.roller.weblogger.ui.rendering.velocity; | ||
|
|
||
| import java.io.StringWriter; | ||
| import java.nio.charset.StandardCharsets; | ||
| import java.nio.file.Files; | ||
| import java.nio.file.Paths; | ||
| import java.util.ArrayList; | ||
| import java.util.LinkedHashMap; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.Properties; | ||
|
|
||
| import org.apache.velocity.VelocityContext; | ||
| import org.apache.velocity.app.VelocityEngine; | ||
| import org.junit.jupiter.api.BeforeAll; | ||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| import static org.junit.jupiter.api.Assertions.assertFalse; | ||
| import static org.junit.jupiter.api.Assertions.assertTrue; | ||
|
|
||
| /** | ||
| * Renders the bundled frontpage blog-directory template against the real | ||
| * Velocity engine and asserts how it treats the caller-supplied | ||
| * <code>letter</code> parameter. | ||
| * | ||
| * <p>The template is reached anonymously, so the parameter is untrusted. The | ||
| * contract is that only a value which normalizes to one of the directory's own | ||
| * A-Z keys is used, and that anything else falls back to the complete directory | ||
| * without the rejected value appearing in the response in any form — raw, | ||
| * HTML-encoded, or URL-encoded. | ||
| */ | ||
| public class FrontpageDirectoryRenderingTest { | ||
|
|
||
| private static final String THEME_DIR = "src/main/webapp/themes/frontpage"; | ||
| private static final String TEMPLATE = "_blogdirectory.vm"; | ||
|
|
||
| private static VelocityEngine engine; | ||
|
|
||
| @BeforeAll | ||
| public static void setUpEngine() { | ||
| Properties props = new Properties(); | ||
| props.setProperty("resource.loaders", "file"); | ||
| props.setProperty("resource.loader.file.class", | ||
| "org.apache.velocity.runtime.resource.loader.FileResourceLoader"); | ||
| props.setProperty("resource.loader.file.path", THEME_DIR); | ||
|
Contributor
There was a problem hiding this comment.
|
||
| engine = new VelocityEngine(); | ||
| engine.init(props); | ||
| } | ||
|
|
||
| /** Minimal stand-ins for the model objects the template reads. */ | ||
| public static class StubModel { | ||
| private final String letter; | ||
| StubModel(String letter) { this.letter = letter; } | ||
| public String getRequestParameter(String name) { | ||
| return "letter".equals(name) ? letter : null; | ||
| } | ||
| } | ||
|
|
||
| public static class StubPager { | ||
| public List<Object> getItems() { return new ArrayList<>(); } | ||
| public String prevLink() { return null; } | ||
| public String nextLink() { return null; } | ||
| public String prevName() { return null; } | ||
| public String nextName() { return null; } | ||
| } | ||
|
|
||
| public static class StubSite { | ||
| public Map<String, Long> getWeblogHandleLetterMap() { | ||
| Map<String, Long> map = new LinkedHashMap<>(); | ||
| for (char c = 'A'; c <= 'Z'; c++) { | ||
| map.put(String.valueOf(c), 1L); | ||
| } | ||
| return map; | ||
| } | ||
| public StubPager getWeblogsByLetterPager(String letter, int offset, int length) { | ||
| return new StubPager(); | ||
| } | ||
| } | ||
|
|
||
| public static class StubUtils { | ||
|
Contributor
There was a problem hiding this comment. Nit: |
||
| public String escapeHTML(String str) { | ||
| return str == null ? null : str.replace("&", "&").replace("<", "<") | ||
| .replace(">", ">").replace("\"", """); | ||
| } | ||
| public String left(String str, int len) { | ||
| if (str == null) { return null; } | ||
| return str.length() <= len ? str : str.substring(0, len); | ||
| } | ||
| } | ||
|
|
||
| public static class StubUrl { | ||
| public String getAbsoluteSite() { return "http://example.test"; } | ||
| } | ||
|
|
||
| private String render(String letterParam) throws Exception { | ||
| VelocityContext ctx = new VelocityContext(); | ||
| ctx.put("model", new StubModel(letterParam)); | ||
| ctx.put("site", new StubSite()); | ||
| ctx.put("utils", new StubUtils()); | ||
| ctx.put("url", new StubUrl()); | ||
| ctx.put("pageLength", 30); | ||
| StringWriter out = new StringWriter(); | ||
| engine.mergeTemplate(TEMPLATE, "UTF-8", ctx, out); | ||
| return out.toString(); | ||
| } | ||
|
|
||
| @Test | ||
| public void missingLetterRendersCompleteDirectory() throws Exception { | ||
| String html = render(null); | ||
| assertTrue(html.contains("All weblogs"), | ||
| "a missing letter must render the complete directory:\n" + html); | ||
| assertFalse(html.contains("Weblogs starting with"), | ||
| "a missing letter must not render a filtered heading"); | ||
| } | ||
|
|
||
| @Test | ||
| public void validUppercaseLetterIsAccepted() throws Exception { | ||
| String html = render("A"); | ||
| assertTrue(html.contains("Weblogs starting with A"), | ||
| "a valid key must be accepted:\n" + html); | ||
| } | ||
|
|
||
| @Test | ||
| public void lowercaseLetterNormalizesToTheSameGroup() throws Exception { | ||
| assertTrue(render("a").contains("Weblogs starting with A"), | ||
| "lowercase input must normalize to the uppercase key"); | ||
| } | ||
|
|
||
| /** | ||
| * Every value that is not a single A-Z key must be discarded outright and | ||
| * must not be echoed, raw or encoded. | ||
| */ | ||
| @Test | ||
| public void invalidValuesFallBackAndAreNotEchoed() throws Exception { | ||
| String[] rejected = { | ||
| "AB", // multi-character | ||
| "1", // numeric | ||
| "!", // punctuation | ||
| "é", // non-ASCII | ||
| "<script>alert(1)</script>", // script payload | ||
| "\" onmouseover=\"alert(1)", // attribute-breaking payload | ||
| "A<b>", // valid prefix, invalid remainder | ||
| }; | ||
| for (String value : rejected) { | ||
| String html = render(value); | ||
| assertTrue(html.contains("All weblogs"), | ||
| "rejected value [" + value + "] must fall back to the complete " | ||
| + "directory:\n" + html); | ||
| // Assert against the heading directly. A bare contains(value) would | ||
| // match incidentally: single characters such as "1" occur naturally | ||
| // in the rendered letter counts. | ||
| assertFalse(html.contains("Weblogs starting with"), | ||
| "rejected value [" + value + "] produced a filtered heading:\n" + html); | ||
| assertFalse(html.contains("<script") || html.contains("<script"), | ||
| "rejected value [" + value + "] reached the page, raw or encoded:\n" + html); | ||
| assertFalse(html.contains("onmouseover"), | ||
| "rejected value [" + value + "] leaked an event handler:\n" + html); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * The sibling directory template resolves a weblog handle from the query | ||
| * string. It cannot be rendered standalone here because it pulls in other | ||
| * templates through #includeTemplate, so this is a structural check: the | ||
| * link must be built from the resolved weblog rather than the raw | ||
| * parameter, and escaped at output. | ||
| */ | ||
| @Test | ||
| public void directoryTemplateValidatesTheWeblogParameter() throws Exception { | ||
|
Contributor
There was a problem hiding this comment. This asserts source substrings of |
||
| String vm = new String(Files.readAllBytes(Paths.get(THEME_DIR, "directory.vm")), | ||
| StandardCharsets.UTF_8); | ||
| assertFalse(vm.contains("$utils.left($handle,1)"), | ||
| "the back-link must not be built from the raw weblog parameter:\n" + vm); | ||
| assertTrue(vm.contains("$site.getWeblog($requestedHandle)"), | ||
| "the requested handle must be resolved before use:\n" + vm); | ||
| assertTrue(vm.contains("$utils.escapeHTML($utils.left($profileWeblog.handle,1))"), | ||
| "the back-link must escape the resolved handle:\n" + vm); | ||
| } | ||
|
|
||
| /** | ||
| * Guards the test itself: if the template stopped rendering, or the theme | ||
| * moved, every assertion above would pass or fail for the wrong reason. | ||
| */ | ||
| @Test | ||
| public void templateActuallyRenders() throws Exception { | ||
| String html = render("A"); | ||
| assertTrue(html.contains("blogdirectory"), | ||
| "expected the directory table to render:\n" + html); | ||
| assertTrue(html.contains("letterMap"), | ||
| "expected the A-Z letter map to render:\n" + html); | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: the
length() == 1check and$candidateLettercollapse to#if($requestedLetter && $weblogLetterMap.containsKey($requestedLetter.toUpperCase())), since every key is one character. Keep thenullguard,TreeMap.containsKey(null)throws.