org.htmlunit.javascript.host.dom.AbstractList Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of xlt Show documentation
Show all versions of xlt Show documentation
XLT (Xceptance LoadTest) is an extensive load and performance test tool developed and maintained by Xceptance.
/*
* Copyright (c) 2002-2024 Gargoyle Software Inc.
*
* Licensed 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
* https://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.
*/
package org.htmlunit.javascript.host.dom;
import java.io.Serializable;
import java.lang.ref.WeakReference;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.List;
import java.util.function.Function;
import java.util.function.Predicate;
import java.util.function.Supplier;
import org.htmlunit.corejs.javascript.ExternalArrayData;
import org.htmlunit.corejs.javascript.Scriptable;
import org.htmlunit.html.DomChangeEvent;
import org.htmlunit.html.DomChangeListener;
import org.htmlunit.html.DomElement;
import org.htmlunit.html.DomNode;
import org.htmlunit.html.HtmlAttributeChangeEvent;
import org.htmlunit.html.HtmlAttributeChangeListener;
import org.htmlunit.html.HtmlElement;
import org.htmlunit.html.HtmlPage;
import org.htmlunit.javascript.HtmlUnitScriptable;
import org.htmlunit.javascript.configuration.JsxClass;
/**
* The parent class of {@link NodeList} and {@link org.htmlunit.javascript.host.html.HTMLCollection}.
*
* @author Daniel Gredler
* @author Marc Guillemot
* @author Chris Erskine
* @author Ahmed Ashour
* @author Frank Danek
* @author Ronald Brill
*/
@JsxClass(isJSObject = false)
public class AbstractList extends HtmlUnitScriptable implements ExternalArrayData {
/**
* Cache effect of some changes.
*/
public enum EffectOnCache {
/** No effect, cache is still valid. */
NONE,
/** Cache is not valid anymore and should be reset. */
RESET
}
private boolean avoidObjectDetection_;
private boolean attributeChangeSensitive_;
/**
* Cache collection elements when possible, so as to avoid expensive XPath expression evaluations.
*/
private List cachedElements_;
private boolean listenerRegistered_;
private Function effectOnCacheFunction_ =
(Function & Serializable) event -> EffectOnCache.RESET;
private Predicate isMatchingPredicate_ = (Predicate & Serializable) domNode -> false;
private Supplier> elementsSupplier_ =
(Supplier> & Serializable)
() -> {
final List response = new ArrayList<>();
final DomNode domNode = getDomNodeOrNull();
if (domNode == null) {
return response;
}
for (final DomNode desc : domNode.getDescendants()) {
if (desc instanceof DomElement && isMatchingPredicate_.test(desc)) {
response.add(desc);
}
}
return response;
};
/**
* Creates an instance.
*/
public AbstractList() {
}
/**
* Creates an instance.
*
* @param domNode the {@link DomNode}
* @param attributeChangeSensitive indicates if the content of the collection may change when an attribute
* of a descendant node of parentScope changes (attribute added, modified or removed)
* @param initialElements the initial content for the cache
*/
protected AbstractList(final DomNode domNode, final boolean attributeChangeSensitive,
final List initialElements) {
if (domNode != null) {
setDomNode(domNode, false);
final HtmlUnitScriptable parentScope = domNode.getScriptableObject();
if (parentScope != null) {
setParentScope(parentScope);
setPrototype(getPrototype(getClass()));
}
}
attributeChangeSensitive_ = attributeChangeSensitive;
cachedElements_ = initialElements;
if (initialElements != null) {
registerListener();
}
setExternalArrayData(this);
}
/**
* Only needed to make collections like document.all available but "invisible" when simulating Firefox.
* {@inheritDoc}
*/
@Override
public boolean avoidObjectDetection() {
return avoidObjectDetection_;
}
/**
* @param newValue the new value
*/
public void setAvoidObjectDetection(final boolean newValue) {
avoidObjectDetection_ = newValue;
}
/**
* @param effectOnCacheFunction the new function
*/
public void setEffectOnCacheFunction(
final Function effectOnCacheFunction) {
if (effectOnCacheFunction == null) {
throw new NullPointerException("EffectOnCacheFunction can't be null");
}
effectOnCacheFunction_ = effectOnCacheFunction;
}
/**
* @return elementSupplier
*/
protected Supplier> getElementSupplier() {
return elementsSupplier_;
}
/**
* Returns the elements whose associated host objects are available through this collection.
* @param elementsSupplier the new supplier
*/
public void setElementsSupplier(final Supplier> elementsSupplier) {
if (elementsSupplier == null) {
throw new NullPointerException("ElementsSupplier can't be null");
}
elementsSupplier_ = elementsSupplier;
}
/**
* @return isMatchingPredicate
*/
protected Predicate getIsMatchingPredicate() {
return isMatchingPredicate_;
}
/**
* Indicates if the node should belong to the collection.
* @param isMatchingPredicate the new predicate
*/
public void setIsMatchingPredicate(final Predicate isMatchingPredicate) {
if (isMatchingPredicate == null) {
throw new NullPointerException("IsMatchingPredicate can't be null");
}
isMatchingPredicate_ = isMatchingPredicate;
}
/**
* Private helper that retrieves the item or items corresponding to the specified
* index or key.
* @param o the index or key corresponding to the element or elements to return
* @return the element or elements corresponding to the specified index or key
*/
protected Object getIt(final Object o) {
if (o instanceof Number) {
final Number n = (Number) o;
final int i = n.intValue();
return get(i, this);
}
final String key = String.valueOf(o);
return get(key, this);
}
@Override
public void setDomNode(final DomNode domNode, final boolean assignScriptObject) {
final DomNode oldDomNode = getDomNodeOrNull();
super.setDomNode(domNode, assignScriptObject);
if (oldDomNode != domNode) {
listenerRegistered_ = false;
}
}
/**
* Gets the HTML elements from cache or retrieve them at first call.
* @return the list of {@link HtmlElement} contained in this collection
*/
public List getElements() {
// a bit strange but we like to avoid sync
List cachedElements = cachedElements_;
if (cachedElements == null) {
if (getParentScope() == null) {
cachedElements = new ArrayList<>();
}
else {
cachedElements = elementsSupplier_.get();
}
cachedElements_ = cachedElements;
}
registerListener();
// maybe the cache was cleared in between
// then this returns the old state and never null
return cachedElements;
}
private void registerListener() {
if (!listenerRegistered_) {
final DomNode domNode = getDomNodeOrNull();
if (domNode != null) {
final DomHtmlAttributeChangeListenerImpl listener = new DomHtmlAttributeChangeListenerImpl(this);
domNode.addDomChangeListener(listener);
if (attributeChangeSensitive_) {
if (domNode instanceof HtmlElement) {
((HtmlElement) domNode).addHtmlAttributeChangeListener(listener);
}
else if (domNode instanceof HtmlPage) {
((HtmlPage) domNode).addHtmlAttributeChangeListener(listener);
}
}
listenerRegistered_ = true;
}
}
}
/**
* Returns the element or elements that match the specified key. If it is the name
* of a property, the property value is returned. If it is the id of an element in
* the array, that element is returned. Finally, if it is the name of an element or
* elements in the array, then all those elements are returned. Otherwise,
* {@link #NOT_FOUND} is returned.
* {@inheritDoc}
*/
@Override
protected Object getWithPreemption(final String name) {
// Test to see if we are trying to get the length of this collection?
// If so return NOT_FOUND here to let the property be retrieved using the prototype
if (/*xpath_ == null || */"length".equals(name)) {
return NOT_FOUND;
}
final List elements = getElements();
// See if there is an element in the element array with the specified id.
final List matchingElements = new ArrayList<>();
for (final DomNode next : elements) {
if (next instanceof DomElement) {
final String id = ((DomElement) next).getId();
if (name.equals(id)) {
matchingElements.add(next);
}
}
}
if (matchingElements.size() == 1) {
return getScriptableForElement(matchingElements.get(0));
}
else if (!matchingElements.isEmpty()) {
final AbstractList collection = create(getDomNodeOrDie(), matchingElements);
collection.setAvoidObjectDetection(true);
return collection;
}
// no element found by id, let's search by name
return getWithPreemptionByName(name, elements);
}
/**
* Constructs a new instance with an initial cache value.
* @param parentScope the parent scope, on which we listen for changes
* @param initialElements the initial content for the cache
* @return the newly created instance
*/
protected AbstractList create(final DomNode parentScope, final List initialElements) {
throw new IllegalAccessError("Creation of AbstractListInstances is not allowed.");
}
/**
* Helper for {@link #getWithPreemption(String)} when finding by id doesn't get results.
* @param name the property name
* @param elements the children elements.
* @return {@link Scriptable#NOT_FOUND} if not found
*/
protected Object getWithPreemptionByName(final String name, final List elements) {
final List matchingElements = new ArrayList<>();
for (final DomNode next : elements) {
if (next instanceof DomElement) {
final String nodeName = ((DomElement) next).getAttributeDirect(DomElement.NAME_ATTRIBUTE);
if (name.equals(nodeName)) {
matchingElements.add(next);
}
}
}
if (matchingElements.isEmpty()) {
return NOT_FOUND;
}
else if (matchingElements.size() == 1) {
return getScriptableForElement(matchingElements.get(0));
}
// many elements => build a sub collection
final DomNode domNode = getDomNodeOrNull();
final AbstractList collection = create(domNode, matchingElements);
collection.setAvoidObjectDetection(true);
return collection;
}
/**
* Returns the length.
* @return the length
*/
public int getLength() {
return getElements().size();
}
/**
* {@inheritDoc}
*/
@Override
public String toString() {
return getClass().getSimpleName() + " for " + getDomNodeOrNull();
}
/**
* Called for the js "==".
* {@inheritDoc}
*/
@Override
protected Object equivalentValues(final Object other) {
if (other == this) {
return Boolean.TRUE;
}
else if (other instanceof AbstractList) {
final AbstractList otherArray = (AbstractList) other;
final DomNode domNode = getDomNodeOrNull();
final DomNode domNodeOther = otherArray.getDomNodeOrNull();
if (getClass() == other.getClass()
&& domNode == domNodeOther
&& getElements().equals(otherArray.getElements())) {
return Boolean.TRUE;
}
return NOT_FOUND;
}
return super.equivalentValues(other);
}
private static final class DomHtmlAttributeChangeListenerImpl
implements DomChangeListener, HtmlAttributeChangeListener {
private final transient WeakReference nodeList_;
DomHtmlAttributeChangeListenerImpl(final AbstractList nodeList) {
super();
nodeList_ = new WeakReference<>(nodeList);
}
/**
* {@inheritDoc}
*/
@Override
public void nodeAdded(final DomChangeEvent event) {
clearCache();
}
/**
* {@inheritDoc}
*/
@Override
public void nodeDeleted(final DomChangeEvent event) {
clearCache();
}
/**
* {@inheritDoc}
*/
@Override
public void attributeAdded(final HtmlAttributeChangeEvent event) {
handleChangeOnCache(event);
}
/**
* {@inheritDoc}
*/
@Override
public void attributeRemoved(final HtmlAttributeChangeEvent event) {
handleChangeOnCache(event);
}
/**
* {@inheritDoc}
*/
@Override
public void attributeReplaced(final HtmlAttributeChangeEvent event) {
final AbstractList nodes = nodeList_.get();
if (null == nodes) {
return;
}
if (nodes.attributeChangeSensitive_) {
handleChangeOnCache(event);
}
}
private void handleChangeOnCache(final HtmlAttributeChangeEvent event) {
final AbstractList nodes = nodeList_.get();
if (null == nodes) {
return;
}
final EffectOnCache effectOnCache = nodes.effectOnCacheFunction_.apply(event);
if (EffectOnCache.NONE == effectOnCache) {
return;
}
if (EffectOnCache.RESET == effectOnCache) {
clearCache();
}
}
private void clearCache() {
final AbstractList nodes = nodeList_.get();
if (null != nodes) {
nodes.cachedElements_ = null;
}
}
}
/**
* Gets the scriptable for the provided element that may already be the right scriptable.
* @param object the object for which to get the scriptable
* @return the scriptable
*/
protected Scriptable getScriptableForElement(final Object object) {
if (object instanceof Scriptable) {
return (Scriptable) object;
}
return getScriptableFor(object);
}
/**
* {@inheritDoc}
*/
@Override
public void defineProperty(final String propertyName, final Object delegateTo,
final Method getter, final Method setter, final int attributes) {
// length is defined on the prototype, don't define it again
if ("length".equals(propertyName) && getPrototype() != null) {
return;
}
super.defineProperty(propertyName, delegateTo, getter, setter, attributes);
}
@Override
public Object getArrayElement(final int index) {
final List elements = getElements();
if (index >= 0 && index < elements.size()) {
return getScriptableForElement(elements.get(index));
}
return NOT_FOUND;
}
@Override
public void setArrayElement(final int index, final Object value) {
// ignored
}
@Override
public int getArrayLength() {
return getElements().size();
}
}