Skip to content

Avoid unnecessary copies #302

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.

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
merged 3 commits into from
Feb 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
18 changes: 9 additions & 9 deletions src/main/java/org/owasp/html/CssSchema.java
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ public static CssSchema withProperties(
if (prop == null) { throw new IllegalArgumentException(propertyName); }
propertiesBuilder.put(propertyName, prop);
}
return new CssSchema(Map.copyOf(propertiesBuilder));
return new CssSchema(Collections.unmodifiableMap(propertiesBuilder));
}

/**
Expand All @@ -161,7 +161,7 @@ public static CssSchema withProperties(
*/
public static CssSchema withProperties(
Map<? extends String, ? extends Property> properties) {
Map<String, Property> propertyMap =
Map<String, Property> propertyMapBuilder =
new HashMap<>();
// check that all fnKeys are defined in properties.
for (Map.Entry<? extends String, ? extends Property> e : properties.entrySet()) {
Expand All @@ -173,9 +173,9 @@ public static CssSchema withProperties(
+ " depends on undefined function key " + fnKey);
}
}
propertyMap.put(e.getKey(), e.getValue());
propertyMapBuilder.put(e.getKey(), e.getValue());
}
return new CssSchema(Map.copyOf(propertyMap));
return new CssSchema(Collections.unmodifiableMap(propertyMapBuilder));
}

/**
Expand All @@ -188,7 +188,7 @@ public static CssSchema withProperties(
*/
public static CssSchema union(CssSchema... cssSchemas) {
if (cssSchemas.length == 1) { return cssSchemas[0]; }
Map<String, Property> properties = new LinkedHashMap<>();
Map<String, Property> propertyMapBuilder = new LinkedHashMap<>();
for (CssSchema cssSchema : cssSchemas) {
for (Map.Entry<String, Property> e : cssSchema.properties.entrySet()) {
String name = e.getKey();
Expand All @@ -199,14 +199,14 @@ public static CssSchema union(CssSchema... cssSchemas) {
if (Objects.isNull(newProp)) {
throw new NullPointerException("An entry was returned with null value from cssSchema.properties");
}
Property oldProp = properties.put(name, newProp);
Property oldProp = propertyMapBuilder.put(name, newProp);
if (oldProp != null && !oldProp.equals(newProp)) {
throw new IllegalArgumentException(
"Duplicate irreconcilable definitions for " + name);
}
}
}
return new CssSchema(Map.copyOf(properties));
return new CssSchema(Collections.unmodifiableMap(propertyMapBuilder));
}

/**
Expand Down Expand Up @@ -847,15 +847,15 @@ Property forKey(String propertyName) {
builder.put("z-index", bottom);
builder.put("repeating-linear-gradient()", linearGradient$Fun);
builder.put("repeating-radial-gradient()", radialGradient$Fun);
DEFINITIONS = Map.copyOf(builder);
DEFINITIONS = Collections.unmodifiableMap(builder);
Copy link
Contributor

Choose a reason for hiding this comment

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

Ok. I see builder allocated locally at 263

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Exactly, I renamed all variables to include bulder to make it more clear.

}

private static <T> Set<T> union(Set<T>... subsets) {
Set<T> all = new HashSet<>();
for (Set<T> subset : subsets) {
all.addAll(subset);
}
return Set.copyOf(all);
return Collections.unmodifiableSet(all);
}

static final Set<String> DEFAULT_WHITELIST = Set.of(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@

package org.owasp.html;

import java.util.Collections;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.Map;
Expand Down Expand Up @@ -81,7 +82,7 @@ ElementAndAttributePolicies and(ElementAndAttributePolicies p) {
return new ElementAndAttributePolicies(
elementName,
ElementPolicy.Util.join(elPolicy, p.elPolicy),
Map.copyOf(joinedAttrPolicies),
Collections.unmodifiableMap(joinedAttrPolicies),
this.htmlTagSkipType.and(p.htmlTagSkipType));
}

Expand Down
3 changes: 2 additions & 1 deletion src/main/java/org/owasp/html/ElementPolicy.java
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
package org.owasp.html;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Optional;
import java.util.Set;
Expand Down Expand Up @@ -133,7 +134,7 @@ final class JoinedElementPolicy implements ElementPolicy {
JoinedElementPolicy(Iterable<? extends ElementPolicy> policies) {
List<ElementPolicy> builder = new ArrayList<>();
policies.forEach(builder::add);
this.policies = List.copyOf(builder);
this.policies = Collections.unmodifiableList(builder);
}

public @Nullable String apply(String elementName, List<String> attrs) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@

package org.owasp.html;

import java.util.Collections;
import java.util.HashSet;
import java.util.Set;

Expand Down Expand Up @@ -66,7 +67,7 @@ public FilterUrlByProtocolAttributePolicy(
Iterable<? extends String> protocols) {
Set<String> builder = new HashSet<>();
protocols.forEach(builder::add);
this.protocols = Set.copyOf(builder);
this.protocols = Collections.unmodifiableSet(builder);
}

public @Nullable String apply(
Expand Down
3 changes: 2 additions & 1 deletion src/main/java/org/owasp/html/HtmlElementTables.java
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package org.owasp.html;

import java.util.Arrays;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashMap;
import java.util.List;
Expand Down Expand Up @@ -418,7 +419,7 @@ public int getElementNameIndex(String canonName) {
for (int i = 0, n = this.canonNames.size(); i < n; ++i) {
builder.put(this.canonNames.get(i), i);
}
canonNameToIndex = Map.copyOf(builder);
canonNameToIndex = Collections.unmodifiableMap(builder);
this.customElementIndex = canonNames.indexOf(CUSTOM_ELEMENT_NAME);
if (this.customElementIndex < 0) {
throw new IllegalStateException("Negative element index");
Expand Down
3 changes: 2 additions & 1 deletion src/main/java/org/owasp/html/HtmlEntities.java
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@

package org.owasp.html;

import java.util.Collections;
import java.util.HashMap;
import java.util.Map;

Expand Down Expand Up @@ -2290,7 +2291,7 @@ final class HtmlEntities {
}
}

final Map<String, String> entityNameToCodePointMap = Map.copyOf(builder);
final Map<String, String> entityNameToCodePointMap = Collections.unmodifiableMap(builder);

ENTITY_TRIE = new Trie<String>(entityNameToCodePointMap);
LONGEST_ENTITY_NAME = longestEntityName;
Expand Down
25 changes: 13 additions & 12 deletions src/main/java/org/owasp/html/HtmlPolicyBuilder.java
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
package org.owasp.html;

import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedHashMap;
Expand Down Expand Up @@ -170,7 +171,7 @@ public class HtmlPolicyBuilder {
for (String elementName : DEFAULT_SKIP_IF_EMPTY) {
builder.put(elementName, HtmlTagSkipType.SKIP_BY_DEFAULT);
}
DEFAULT_SKIP_TAG_MAP_IF_EMPTY_ATTR = Map.copyOf(builder);
DEFAULT_SKIP_TAG_MAP_IF_EMPTY_ATTR = Collections.unmodifiableMap(builder);
}

/**
Expand Down Expand Up @@ -347,7 +348,7 @@ public AttributeBuilder allowAttributes(String... attributeNames) {
for (String attributeName : attributeNames) {
builder.add(HtmlLexer.canonicalAttributeName(attributeName));
}
return new AttributeBuilder(List.copyOf(builder));
return new AttributeBuilder(Collections.unmodifiableList(builder));
}

/**
Expand Down Expand Up @@ -647,7 +648,7 @@ AttributePolicy makeGuard(AttributeGuardIntermediates intermediates) {
}

});
ATTRIBUTE_GUARDS = Map.copyOf(builder);
ATTRIBUTE_GUARDS = Collections.unmodifiableMap(builder);
}

/**
Expand Down Expand Up @@ -686,17 +687,17 @@ public <CTX> HtmlSanitizer.Policy build(
* each backed by a different output channel.
*/
public PolicyFactory toFactory() {
Set<String> textContainerSet = new HashSet<>();
Set<String> textContainerSetBuilder = new HashSet<>();
for (Map.Entry<String, Boolean> textContainer
: this.textContainers.entrySet()) {
if (Boolean.TRUE.equals(textContainer.getValue())) {
textContainerSet.add(textContainer.getKey());
textContainerSetBuilder.add(textContainer.getKey());
}
}
CompiledState compiled = compilePolicies();

return new PolicyFactory(
compiled.compiledPolicies, Set.copyOf(textContainerSet),
compiled.compiledPolicies, Collections.unmodifiableSet(textContainerSetBuilder),
Map.copyOf(compiled.globalAttrPolicies),
preprocessor, postprocessor);
}
Expand Down Expand Up @@ -812,7 +813,7 @@ private CompiledState compilePolicies() {
elAttrPolicies = Map.of();
}

Map<String, AttributePolicy> attrs
Map<String, AttributePolicy> attrsBuilder
= new HashMap<>();

for (Map.Entry<String, AttributePolicy> ape : elAttrPolicies.entrySet()) {
Expand All @@ -822,7 +823,7 @@ private CompiledState compilePolicies() {
if (globalAttrPolicies.containsKey(attributeName)) { continue; }
AttributePolicy policy = ape.getValue();
if (!AttributePolicy.REJECT_ALL_ATTRIBUTE_POLICY.equals(policy)) {
attrs.put(attributeName, policy);
attrsBuilder.put(attributeName, policy);
}
}
for (Map.Entry<String, AttributePolicy> ape
Expand All @@ -831,21 +832,21 @@ private CompiledState compilePolicies() {
AttributePolicy policy = AttributePolicy.Util.join(
elAttrPolicies.get(attributeName), ape.getValue());
if (!AttributePolicy.REJECT_ALL_ATTRIBUTE_POLICY.equals(policy)) {
attrs.put(attributeName, policy);
attrsBuilder.put(attributeName, policy);
}
}

policiesBuilder.put(
elementName,
new ElementAndAttributePolicies(
elementName,
elPolicy, Map.copyOf(attrs),
elPolicy, Collections.unmodifiableMap(attrsBuilder),
getHtmlTagSkipType(elementName)
)
);
}
compiledState = new CompiledState(
globalAttrPolicies, Map.copyOf(policiesBuilder));
globalAttrPolicies, Collections.unmodifiableMap(policiesBuilder));
return compiledState;
}

Expand Down Expand Up @@ -982,7 +983,7 @@ public HtmlPolicyBuilder onElements(String... elementNames) {
builder.add(HtmlLexer.canonicalElementName(elementName));
}
return HtmlPolicyBuilder.this.allowAttributesOnElements(
policy, attributeNames, List.copyOf(builder));
policy, attributeNames, Collections.unmodifiableList(builder));
}
}

Expand Down
13 changes: 7 additions & 6 deletions src/main/java/org/owasp/html/PolicyFactory.java
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@

package org.owasp.html;

import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
Expand Down Expand Up @@ -173,10 +174,10 @@ public PolicyFactory and(PolicyFactory f) {
} else if (f.textContainers.containsAll(this.textContainers)) {
allTextContainers = f.textContainers;
} else {
Set<String> containers = new HashSet<>();
this.textContainers.forEach(containers::add);
f.textContainers.forEach(containers::add);
allTextContainers = Set.copyOf(containers);
Set<String> containerBuilder = new HashSet<>();
this.textContainers.forEach(containerBuilder::add);
f.textContainers.forEach(containerBuilder::add);
allTextContainers = Collections.unmodifiableSet(containerBuilder);
}
Map<String, AttributePolicy> allGlobalAttrPolicies;
if (f.globalAttrPolicies.isEmpty()) {
Expand All @@ -200,7 +201,7 @@ public PolicyFactory and(PolicyFactory f) {
ab.put(attrName, e.getValue());
}
}
allGlobalAttrPolicies = Map.copyOf(ab);
allGlobalAttrPolicies = Collections.unmodifiableMap(ab);
}
HtmlStreamEventProcessor compositionOfPreprocessors
= HtmlStreamEventProcessor.Processors.compose(
Expand All @@ -209,7 +210,7 @@ public PolicyFactory and(PolicyFactory f) {
= HtmlStreamEventProcessor.Processors.compose(
this.postprocessor, f.postprocessor);
return new PolicyFactory(
Map.copyOf(builder), allTextContainers, allGlobalAttrPolicies,
Collections.unmodifiableMap(builder), allTextContainers, allGlobalAttrPolicies,
compositionOfPreprocessors, compositionOfPostprocessors);
}
}
3 changes: 2 additions & 1 deletion src/test/java/org/owasp/html/SanitizersTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
import java.util.ArrayList;
import java.util.Arrays;
import java.util.BitSet;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import java.util.NoSuchElementException;
Expand Down Expand Up @@ -579,7 +580,7 @@ private static class Permutations<T> implements Iterable<List<T>> {
this.k = k;
List<T> builder = new ArrayList<>();
Arrays.stream(elements).forEach(builder::add);
this.elements = List.copyOf(builder);
this.elements = Collections.unmodifiableList(builder);
}

public Iterator<List<T>> iterator() {
Expand Down