org.htmlunit.History 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;
import static org.htmlunit.BrowserVersionFeatures.URL_MINIMAL_QUERY_ENCODING;
import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.Serializable;
import java.lang.ref.SoftReference;
import java.net.URL;
import java.util.ArrayList;
import java.util.List;
import org.htmlunit.javascript.host.Window;
import org.htmlunit.javascript.host.event.Event;
import org.htmlunit.javascript.host.event.PopStateEvent;
import org.htmlunit.util.HeaderUtils;
import org.htmlunit.util.UrlUtils;
/**
* Representation of the navigation history of a single window.
*
* @author Daniel Gredler
* @author Ahmed Ashour
* @author Adam Afeltowicz
* @author Ronald Brill
* @author Madis Pärn
*/
public class History implements Serializable {
/** The window to which this navigation history belongs. */
private final WebWindow window_;
/**
* Whether or not to ignore calls to {@link #addPage(Page)}; this is a bit hackish (we should probably be using
* explicit boolean parameters in the various methods that load new pages), but it does the job for now -- without
* any new API cruft.
*/
private transient ThreadLocal ignoreNewPages_;
/**
* The {@link History.HistoryEntry}s in this navigation history.
*/
private final List entries_ = new ArrayList<>();
/** The current index within the list of pages which make up this navigation history. */
private int index_ = -1;
/**
* The single entry in the history.
*/
private static final class HistoryEntry implements Serializable {
private transient SoftReference page_;
private final WebRequest webRequest_;
private Object state_;
HistoryEntry(final Page page) {
// verify cache-control header values before storing
if (HeaderUtils.containsNoStore(page.getWebResponse())) {
page_ = null;
}
else {
page_ = new SoftReference<>(page);
}
final WebRequest request = page.getWebResponse().getWebRequest();
webRequest_ = new WebRequest(request.getUrl(), request.getHttpMethod());
webRequest_.setRequestParameters(request.getRequestParameters());
}
Page getPage() {
if (page_ == null) {
return null;
}
return page_.get();
}
void clearPage() {
page_ = null;
}
WebRequest getWebRequest() {
return webRequest_;
}
URL getUrl() {
return webRequest_.getUrl();
}
void setUrl(final URL url, final Page page) {
if (url != null) {
WebWindow webWindow = null;
boolean minimalQueryEncoding = false;
if (page != null) {
webWindow = page.getEnclosingWindow();
if (webWindow != null) {
minimalQueryEncoding = webWindow.getWebClient()
.getBrowserVersion().hasFeature(URL_MINIMAL_QUERY_ENCODING);
}
}
final URL encoded = UrlUtils.encodeUrl(url, minimalQueryEncoding,
webRequest_.getCharset());
webRequest_.setUrl(encoded);
if (page != null) {
page.getWebResponse().getWebRequest().setUrl(encoded);
if (webWindow != null) {
final Window win = webWindow.getScriptableObject();
if (win != null) {
win.getLocation().setHash(null, encoded.getRef(), false);
}
}
}
}
}
/**
* @return the state object
*/
Object getState() {
return state_;
}
/**
* Sets the state object.
* @param state the state object to use
*/
void setState(final Object state) {
state_ = state;
}
}
/**
* Creates a new navigation history for the specified window.
* @param window the window which owns the new navigation history
*/
public History(final WebWindow window) {
window_ = window;
initTransientFields();
}
/**
* Initializes the transient fields.
*/
private void initTransientFields() {
ignoreNewPages_ = new ThreadLocal<>();
}
/**
* Returns the length of the navigation history.
* @return the length of the navigation history
*/
public int getLength() {
return entries_.size();
}
/**
* Returns the current (zero-based) index within the navigation history.
* @return the current (zero-based) index within the navigation history
*/
public int getIndex() {
return index_;
}
/**
* Returns the URL at the specified index in the navigation history, or {@code null} if the index is not valid.
* @param index the index of the URL to be returned
* @return the URL at the specified index in the navigation history, or {@code null} if the index is not valid
*/
public URL getUrl(final int index) {
if (index >= 0 && index < entries_.size()) {
return UrlUtils.toUrlSafe(entries_.get(index).getUrl().toExternalForm());
}
return null;
}
/**
* Goes back one step in the navigation history, if possible.
* @return this navigation history, after going back one step
* @throws IOException in case of error
*/
public History back() throws IOException {
if (index_ > 0) {
index_--;
goToUrlAtCurrentIndex();
}
return this;
}
/**
* Goes forward one step in the navigation history, if possible.
* @return this navigation history, after going forward one step
* @throws IOException in case of error
*/
public History forward() throws IOException {
if (index_ < entries_.size() - 1) {
index_++;
goToUrlAtCurrentIndex();
}
return this;
}
/**
* Goes forward or backwards in the navigation history, according to whether the specified relative index
* is positive or negative. If the specified index is 0, this method reloads the current page.
* @param relativeIndex the index to move to, relative to the current index
* @return this navigation history, after going forwards or backwards the specified number of steps
* @throws IOException in case of error
*/
public History go(final int relativeIndex) throws IOException {
final int i = index_ + relativeIndex;
if (i < entries_.size() && i >= 0) {
index_ = i;
goToUrlAtCurrentIndex();
}
return this;
}
/**
* {@inheritDoc}
*/
@Override
public String toString() {
return entries_.toString();
}
/**
* Removes the current URL from the history.
*/
public void removeCurrent() {
if (index_ >= 0 && index_ < entries_.size()) {
entries_.remove(index_);
if (index_ > 0) {
index_--;
}
}
}
/**
* Adds a new page to the navigation history.
* @param page the page to add to the navigation history
* @return the created history entry
*/
protected HistoryEntry addPage(final Page page) {
final Boolean ignoreNewPages = ignoreNewPages_.get();
if (ignoreNewPages != null && ignoreNewPages.booleanValue()) {
return null;
}
final int sizeLimit = window_.getWebClient().getOptions().getHistorySizeLimit();
if (sizeLimit <= 0) {
entries_.clear();
index_ = -1;
return null;
}
index_++;
while (entries_.size() > index_) {
entries_.remove(index_);
}
while (entries_.size() >= sizeLimit) {
entries_.remove(0);
index_--;
}
final HistoryEntry entry = new HistoryEntry(page);
entries_.add(entry);
final int cacheLimit = Math.max(window_.getWebClient().getOptions().getHistoryPageCacheLimit(), 0);
if (entries_.size() > cacheLimit) {
entries_.get(entries_.size() - cacheLimit - 1).clearPage();
}
return entry;
}
/**
* Loads the URL at the current index into the window to which this navigation history belongs.
* @throws IOException if an IO error occurs
*/
private void goToUrlAtCurrentIndex() throws IOException {
final Boolean old = ignoreNewPages_.get();
ignoreNewPages_.set(Boolean.TRUE);
try {
final HistoryEntry entry = entries_.get(index_);
final Page page = entry.getPage();
if (page == null) {
window_.getWebClient().getPage(window_, entry.getWebRequest(), false);
}
else {
window_.setEnclosedPage(page);
page.getWebResponse().getWebRequest().setUrl(entry.getUrl());
}
final Window jsWindow = window_.getScriptableObject();
if (jsWindow != null && jsWindow.hasEventHandlers("onpopstate")) {
final Event event = new PopStateEvent(jsWindow, Event.TYPE_POPSTATE, entry.getState());
jsWindow.executeEventLocally(event);
}
}
finally {
ignoreNewPages_.set(old);
}
}
/**
* Allows to change history state and url if provided.
*
* @param state the new state to use
* @param url the new url to use
*/
public void replaceState(final Object state, final URL url) {
if (index_ >= 0 && index_ < entries_.size()) {
final HistoryEntry entry = entries_.get(index_);
Page page = entry.getPage();
if (page == null) {
page = window_.getEnclosedPage();
}
entry.setUrl(url, page);
entry.setState(state);
}
}
/**
* Allows to change history state and url if provided.
*
* @param state the new state to use
* @param url the new url to use
*/
public void pushState(final Object state, final URL url) {
final Page page = window_.getEnclosedPage();
final HistoryEntry entry = addPage(page);
if (entry != null) {
entry.setUrl(url, page);
entry.setState(state);
}
}
/**
* Returns current state object.
*
* @return the current state object
*/
public Object getCurrentState() {
if (index_ >= 0 && index_ < entries_.size()) {
return entries_.get(index_).getState();
}
return null;
}
/**
* Re-initializes transient fields when an object of this type is deserialized.
* @param in the object input stream
* @throws IOException if an error occurs
* @throws ClassNotFoundException if an error occurs
*/
private void readObject(final ObjectInputStream in) throws IOException, ClassNotFoundException {
in.defaultReadObject();
initTransientFields();
}
}