com.gargoylesoftware.htmlunit.html.HtmlSerializer 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-2021 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 com.gargoylesoftware.htmlunit.html;
import java.util.Iterator;
import java.util.List;
import org.apache.commons.lang3.StringUtils;
import com.gargoylesoftware.htmlunit.Page;
import com.gargoylesoftware.htmlunit.SgmlPage;
import com.gargoylesoftware.htmlunit.html.HtmlSerializer.HtmlSerializerTextBuilder.Mode;
import com.gargoylesoftware.htmlunit.html.serializer.HtmlSerializerNormalizedText;
import com.gargoylesoftware.htmlunit.javascript.host.Element;
/**
* Utility to handle conversion from HTML code to string.
*
* @author Marc Guillemot
* @author Ahmed Ashour
* @author Ronald Brill
* @author Rob Kodey
*
* @deprecated as of version 2.48.0; use {@link HtmlSerializerNormalizedText} instead
*/
@Deprecated
public class HtmlSerializer {
private boolean ignoreMaskedElements_ = true;
/**
* Converts an HTML node to text.
* @param node a node
* @return the text representation according to the setting of this serializer
*/
public String asText(final DomNode node) {
final HtmlSerializerTextBuilder builder = new HtmlSerializerTextBuilder();
appendNode(builder, node);
return builder.getText();
}
/**
* Iterate over all Children and call appendNode() for every.
*
* @param builder the StringBuilder to add to
* @param node the node to process
*/
protected void appendChildren(final HtmlSerializerTextBuilder builder, final DomNode node) {
for (final DomNode child : node.getChildren()) {
appendNode(builder, child);
}
}
/**
* The core distribution method call the different appendXXX
* methods depending on the type of the given node.
*
* @param builder the StringBuilder to add to
* @param node the node to process
*/
protected void appendNode(final HtmlSerializerTextBuilder builder, final DomNode node) {
if (node instanceof DomText) {
appendText(builder, (DomText) node);
}
else if (node instanceof DomComment) {
appendComment(builder, (DomComment) node);
}
else if (node instanceof HtmlApplet
&& node.getPage().getWebClient().getOptions().isAppletEnabled()) {
appendApplet(builder, (HtmlApplet) node);
}
else if (node instanceof HtmlBreak) {
appendBreak(builder, (HtmlBreak) node);
}
else if (node instanceof HtmlHiddenInput) {
appendHiddenInput(builder, (HtmlHiddenInput) node);
}
else if (node instanceof HtmlScript) {
appendScript(builder, (HtmlScript) node);
}
else if (node instanceof HtmlStyle) {
appendStyle(builder, (HtmlStyle) node);
}
else if (node instanceof HtmlNoFrames) {
appendNoFrames(builder, (HtmlNoFrames) node);
}
else if (node instanceof HtmlTextArea) {
appendTextArea(builder, (HtmlTextArea) node);
}
else if (node instanceof HtmlTitle) {
appendTitle(builder, (HtmlTitle) node);
}
else if (node instanceof HtmlTableRow) {
appendTableRow(builder, (HtmlTableRow) node);
}
else if (node instanceof HtmlSelect) {
appendSelect(builder, (HtmlSelect) node);
}
else if (node instanceof HtmlSubmitInput) {
appendSubmitInput(builder, (HtmlSubmitInput) node);
}
else if (node instanceof HtmlResetInput) {
appendResetInput(builder, (HtmlResetInput) node);
}
else if (node instanceof HtmlCheckBoxInput) {
doAppendCheckBoxInput(builder, (HtmlCheckBoxInput) node);
}
else if (node instanceof HtmlRadioButtonInput) {
doAppendRadioButtonInput(builder, (HtmlRadioButtonInput) node);
}
else if (node instanceof HtmlInput) {
appendInput(builder, (HtmlInput) node);
}
else if (node instanceof HtmlTable) {
appendTable(builder, (HtmlTable) node);
}
else if (node instanceof HtmlOrderedList) {
appendOrderedList(builder, (HtmlOrderedList) node);
}
else if (node instanceof HtmlUnorderedList) {
appendUnorderedList(builder, (HtmlUnorderedList) node);
}
else if (node instanceof HtmlPreformattedText) {
appendPreformattedText(builder, (HtmlPreformattedText) node);
}
else if (node instanceof HtmlInlineFrame) {
appendInlineFrame(builder, (HtmlInlineFrame) node);
}
else if (node instanceof HtmlNoScript && node.getPage().getWebClient().isJavaScriptEnabled()) {
appendNoScript(builder, (HtmlNoScript) node);
}
else {
appendDomNode(builder, node);
}
}
/**
* Process {@link HtmlHiddenInput}.
*
* @param builder the StringBuilder to add to
* @param domNode the target to process
*/
protected void appendDomNode(final HtmlSerializerTextBuilder builder, final DomNode domNode) {
boolean block = false;
if (!(domNode instanceof HtmlBody)) {
final SgmlPage page = domNode.getPage();
if (page != null && page.getWebClient().isJavaScriptEngineEnabled()) {
final Object scriptableObject = domNode.getScriptableObject();
if (scriptableObject instanceof Element) {
final Element element = (Element) scriptableObject;
final String display = element.getWindow().getComputedStyle(element, null).getDisplay();
block = "block".equals(display);
}
}
}
if (block) {
builder.appendBlockSeparator();
}
appendChildren(builder, domNode);
if (block) {
builder.appendBlockSeparator();
}
}
/**
* Process {@link HtmlHiddenInput}.
*
* @param builder the StringBuilder to add to
* @param htmlHiddenInput the target to process
*/
protected void appendHiddenInput(final HtmlSerializerTextBuilder builder, final HtmlHiddenInput htmlHiddenInput) {
// nothing to do
}
/**
* Process {@link HtmlScript}.
*
* @param builder the StringBuilder to add to
* @param htmlScript the target to process
*/
protected void appendScript(final HtmlSerializerTextBuilder builder, final HtmlScript htmlScript) {
// nothing to do
}
/**
* Process {@link HtmlStyle}.
*
* @param builder the StringBuilder to add to
* @param htmlStyle the target to process
*/
protected void appendStyle(final HtmlSerializerTextBuilder builder, final HtmlStyle htmlStyle) {
// nothing to do
}
/**
* Process {@link HtmlNoScript}.
*
* @param builder the StringBuilder to add to
* @param htmlNoScript the target to process
*/
protected void appendNoScript(final HtmlSerializerTextBuilder builder, final HtmlNoScript htmlNoScript) {
// nothing to do
}
/**
* Process {@link HtmlNoFrames}.
*
* @param builder the StringBuilder to add to
* @param htmlNoFrames the target to process
*/
protected void appendNoFrames(final HtmlSerializerTextBuilder builder, final HtmlNoFrames htmlNoFrames) {
// nothing to do
}
/**
* Process {@link HtmlSubmitInput}.
*
* @param builder the StringBuilder to add to
* @param htmlSubmitInput the target to process
*/
protected void appendSubmitInput(final HtmlSerializerTextBuilder builder, final HtmlSubmitInput htmlSubmitInput) {
builder.append(htmlSubmitInput.asText(), Mode.NORMALIZE);
}
/**
* Process {@link HtmlInput}.
*
* @param builder the StringBuilder to add to
* @param htmlInput the target to process
*/
protected void appendInput(final HtmlSerializerTextBuilder builder, final HtmlInput htmlInput) {
builder.append(htmlInput.getValueAttribute(), Mode.NORMALIZE);
}
/**
* Process {@link HtmlResetInput}.
*
* @param builder the StringBuilder to add to
* @param htmlResetInput the target to process
*/
protected void appendResetInput(final HtmlSerializerTextBuilder builder, final HtmlResetInput htmlResetInput) {
builder.append(htmlResetInput.asText(), Mode.NORMALIZE);
}
/**
* Process {@link HtmlUnorderedList}.
* @param builder the StringBuilder to add to
* @param htmlUnorderedList the target to process
*/
protected void appendUnorderedList(final HtmlSerializerTextBuilder builder,
final HtmlUnorderedList htmlUnorderedList) {
builder.appendBlockSeparator();
boolean first = true;
for (final DomNode item : htmlUnorderedList.getChildren()) {
if (!first) {
builder.appendBlockSeparator();
}
first = false;
appendNode(builder, item);
}
builder.appendBlockSeparator();
}
/**
* Process {@link HtmlTitle}.
* @param builder the StringBuilder to add to
* @param htmlTitle the target to process
*/
protected void appendTitle(final HtmlSerializerTextBuilder builder, final HtmlTitle htmlTitle) {
// optimized version
// for the title there is no need to check the visibility
// of the containing dom text;
// this optimization defers the load of the style sheets
final DomNode child = htmlTitle.getFirstChild();
if (child instanceof DomText) {
builder.append(((DomText) child).getData(), Mode.NORMALIZE);
builder.appendBlockSeparator();
}
}
/**
* Process {@link HtmlTableRow}.
*
* @param builder the StringBuilder to add to
* @param htmlTableRow the target to process
*/
protected void appendTableRow(final HtmlSerializerTextBuilder builder, final HtmlTableRow htmlTableRow) {
boolean first = true;
for (final HtmlTableCell cell : htmlTableRow.getCells()) {
if (!first) {
builder.appendTab();
}
else {
first = false;
}
appendChildren(builder, cell); // trim?
}
}
/**
* Process {@link HtmlTextArea}.
*
* @param builder the StringBuilder to add to
* @param htmlTextArea the target to process
*/
protected void appendTextArea(final HtmlSerializerTextBuilder builder, final HtmlTextArea htmlTextArea) {
if (isVisible(htmlTextArea)) {
builder.append(htmlTextArea.getText(), Mode.PRESERVE_BLANK_NEWLINE);
}
}
/**
* Process {@link HtmlTable}.
*
* @param builder the StringBuilder to add to
* @param htmlTable the target to process
*/
protected void appendTable(final HtmlSerializerTextBuilder builder, final HtmlTable htmlTable) {
builder.appendBlockSeparator();
final String caption = htmlTable.getCaptionText();
if (caption != null) {
builder.append(caption, Mode.NORMALIZE);
builder.appendBlockSeparator();
}
boolean first = true;
// first thead has to be displayed first and first tfoot has to be displayed last
final HtmlTableHeader tableHeader = htmlTable.getHeader();
if (tableHeader != null) {
first = appendTableRows(builder, tableHeader.getRows(), true, null, null);
}
final HtmlTableFooter tableFooter = htmlTable.getFooter();
final List tableRows = htmlTable.getRows();
first = appendTableRows(builder, tableRows, first, tableHeader, tableFooter);
if (tableFooter != null) {
first = appendTableRows(builder, tableFooter.getRows(), first, null, null);
}
else if (tableRows.isEmpty()) {
final DomNode firstChild = htmlTable.getFirstChild();
if (firstChild != null) {
appendNode(builder, firstChild);
}
}
builder.appendBlockSeparator();
}
/**
* Process {@link HtmlTableRow}.
*
* @param builder the StringBuilder to add to
* @param rows the rows
* @param first if true this is the first one
* @param skipParent1 skip row if the parent is this
* @param skipParent2 skip row if the parent is this
* @return true if this was the first one
*/
protected boolean appendTableRows(final HtmlSerializerTextBuilder builder,
final List rows, boolean first, final TableRowGroup skipParent1,
final TableRowGroup skipParent2) {
for (final HtmlTableRow row : rows) {
if (row.getParentNode() == skipParent1 || row.getParentNode() == skipParent2) {
continue;
}
if (!first) {
builder.appendBlockSeparator();
}
first = false;
appendTableRow(builder, row);
}
return first;
}
/**
* Process {@link HtmlSelect}.
*
* @param builder the StringBuilder to add to
* @param htmlSelect the target to process
*/
protected void appendSelect(final HtmlSerializerTextBuilder builder, final HtmlSelect htmlSelect) {
final List options;
if (htmlSelect.isMultipleSelectEnabled()) {
options = htmlSelect.getOptions();
}
else {
options = htmlSelect.getSelectedOptions();
}
for (final Iterator i = options.iterator(); i.hasNext();) {
final HtmlOption currentOption = i.next();
appendNode(builder, currentOption);
if (i.hasNext()) {
builder.appendBlockSeparator();
}
}
}
/**
* Process {@link HtmlOrderedList} taking care to numerate it.
*
* @param builder the StringBuilder to add to
* @param htmlOrderedList the OL element
*/
protected void appendOrderedList(final HtmlSerializerTextBuilder builder, final HtmlOrderedList htmlOrderedList) {
builder.appendBlockSeparator();
boolean first = true;
int i = 1;
for (final DomNode item : htmlOrderedList.getChildren()) {
if (!first) {
builder.appendBlockSeparator();
}
first = false;
if (item instanceof HtmlListItem) {
builder.append(Integer.toString(i++), Mode.NORMALIZE);
builder.append(". ", Mode.NORMALIZE);
appendChildren(builder, item);
}
else {
appendNode(builder, item);
}
}
builder.appendBlockSeparator();
}
/**
* Process {@link HtmlPreformattedText}.
*
* @param builder the StringBuilder to add to
* @param htmlPreformattedText the target to process
*/
protected void appendPreformattedText(final HtmlSerializerTextBuilder builder,
final HtmlPreformattedText htmlPreformattedText) {
if (isVisible(htmlPreformattedText)) {
builder.appendBlockSeparator();
builder.append(htmlPreformattedText.getTextContent(), Mode.PRESERVE_BLANK_TAB_NEWLINE);
builder.appendBlockSeparator();
}
}
/**
* Process {@link HtmlInlineFrame}.
*
* @param builder the StringBuilder to add to
* @param htmlInlineFrame the target to process
*/
protected void appendInlineFrame(final HtmlSerializerTextBuilder builder,
final HtmlInlineFrame htmlInlineFrame) {
if (isVisible(htmlInlineFrame)) {
builder.appendBlockSeparator();
final Page page = htmlInlineFrame.getEnclosedPage();
if (page instanceof SgmlPage) {
builder.append(((SgmlPage) page).asText(), Mode.NORMALIZE);
}
builder.appendBlockSeparator();
}
}
/**
* Process {@link DomText}.
*
* @param builder the StringBuilder to add to
* @param domText the target to process
*/
protected void appendText(final HtmlSerializerTextBuilder builder, final DomText domText) {
final DomNode parent = domText.getParentNode();
if (parent == null || parent instanceof HtmlTitle || isVisible(parent)) {
builder.append(domText.getData(), Mode.NORMALIZE);
}
}
/**
* Process {@link DomComment}.
*
* @param builder the StringBuilder to add to
* @param domComment the target to process
*/
protected void appendComment(final HtmlSerializerTextBuilder builder, final DomComment domComment) {
// nothing to do
}
/**
* Process {@link HtmlApplet}.
*
* @param builder the StringBuilder to add to
* @param htmlApplet the target to process
*/
protected void appendApplet(final HtmlSerializerTextBuilder builder, final HtmlApplet htmlApplet) {
// nothing to do
}
/**
* Process {@link HtmlBreak}.
*
* @param builder the StringBuilder to add to
* @param htmlBreak the target to process
*/
protected void appendBreak(final HtmlSerializerTextBuilder builder, final HtmlBreak htmlBreak) {
builder.appendNewLine();
}
/**
* Process {@link HtmlCheckBoxInput}.
*
* @param builder the StringBuilder to add to
* @param htmlCheckBoxInput the target to process
*/
protected void doAppendCheckBoxInput(final HtmlSerializerTextBuilder builder,
final HtmlCheckBoxInput htmlCheckBoxInput) {
if (htmlCheckBoxInput.isChecked()) {
builder.append("checked", Mode.NORMALIZE);
}
else {
builder.append("unchecked", Mode.NORMALIZE);
}
}
/**
* Process {@link HtmlRadioButtonInput}.
*
* @param builder the StringBuilder to add to
* @param htmlRadioButtonInput the target to process
*/
protected void doAppendRadioButtonInput(final HtmlSerializerTextBuilder builder,
final HtmlRadioButtonInput htmlRadioButtonInput) {
if (htmlRadioButtonInput.isChecked()) {
builder.append("checked", Mode.NORMALIZE);
}
else {
builder.append("unchecked", Mode.NORMALIZE);
}
}
private boolean isVisible(final DomNode node) {
return !ignoreMaskedElements_ || node.isDisplayed();
}
/**
* Indicates if element that are not displayed due to style settings
* (visibility or display) should be visible in generated text.
* @param ignore indicates if masked elements should be ignored or not
*/
public void setIgnoreMaskedElements(final boolean ignore) {
ignoreMaskedElements_ = ignore;
}
protected static class HtmlSerializerTextBuilder {
/** Mode. */
protected enum Mode {
/** Collapse whitespace. */
NORMALIZE,
/** Preserve tab, blank, newline. */
PRESERVE_BLANK_TAB_NEWLINE,
/** Preserve blank, newline. */
PRESERVE_BLANK_NEWLINE
}
private enum State {
DEFAULT,
EMPTY,
TRIM,
BLANK_AT_END,
BLANK_AT_END_AFTER_NEWLINE,
NEWLINE_AT_END,
BLOCK_SEPARATOR_AT_END
}
private static final String LINE_SEPARATOR = System.lineSeparator();
private static final int LINE_SEPARATOR_LENGTH = LINE_SEPARATOR.length();
private State state_;
private final StringBuilder builder_;
private int trimRightPos_;
public HtmlSerializerTextBuilder() {
builder_ = new StringBuilder();
state_ = State.EMPTY;
trimRightPos_ = builder_.length();
}
public void append(final String content, final Mode mode) {
final int length = content.length();
if (length == 0) {
return;
}
String text = content;
if (mode == Mode.PRESERVE_BLANK_NEWLINE) {
text = StringUtils.stripEnd(text, null);
}
boolean crFound = false;
for (final char c : text.toCharArray()) {
if (mode == Mode.NORMALIZE) {
if (isSpace(c)) {
switch (state_) {
case EMPTY:
case TRIM:
case BLANK_AT_END:
case BLANK_AT_END_AFTER_NEWLINE:
case BLOCK_SEPARATOR_AT_END:
break;
case NEWLINE_AT_END:
builder_.append(' ');
state_ = State.BLANK_AT_END_AFTER_NEWLINE;
break;
default:
builder_.append(' ');
state_ = State.BLANK_AT_END;
break;
}
}
else if (c == (char) 160) {
builder_.append(' ');
state_ = State.DEFAULT;
trimRightPos_ = builder_.length();
}
else {
builder_.append(c);
state_ = State.DEFAULT;
trimRightPos_ = builder_.length();
}
continue;
}
// preserve mode
if (c == '\n') {
appendNewLine();
crFound = false;
}
else {
if (crFound) {
appendNewLine();
}
crFound = c == '\r';
if (c == '\t') {
if (mode == Mode.PRESERVE_BLANK_TAB_NEWLINE) {
appendTab();
}
else if (state_ != State.BLOCK_SEPARATOR_AT_END) {
builder_.append(' ');
}
}
else if (c == (char) 160) {
appendBlank();
}
else if (c == ' ') {
appendBlank();
}
else {
builder_.append(c);
}
trimRightPos_ = builder_.length();
}
}
if (crFound) {
appendNewLine();
}
if (mode != Mode.NORMALIZE) {
// reset state to empty to restart whitespace normalization afterwards
state_ = State.TRIM;
}
}
public void appendBlockSeparator() {
switch (state_) {
case EMPTY:
break;
case BLANK_AT_END:
builder_.setLength(trimRightPos_);
if (builder_.length() == 0) {
state_ = State.EMPTY;
}
else {
builder_.append(LINE_SEPARATOR);
state_ = State.BLOCK_SEPARATOR_AT_END;
}
break;
case BLANK_AT_END_AFTER_NEWLINE:
builder_.setLength(trimRightPos_ - LINE_SEPARATOR_LENGTH);
trimRightPos_ = trimRightPos_ - LINE_SEPARATOR_LENGTH;
if (builder_.length() == 0) {
state_ = State.EMPTY;
}
else {
builder_.append(LINE_SEPARATOR);
state_ = State.BLOCK_SEPARATOR_AT_END;
}
break;
case BLOCK_SEPARATOR_AT_END:
break;
case NEWLINE_AT_END:
builder_.setLength(builder_.length() - LINE_SEPARATOR_LENGTH);
trimRightPos_ = trimRightPos_ - LINE_SEPARATOR_LENGTH;
if (builder_.length() == 0) {
state_ = State.EMPTY;
}
else {
builder_.append(LINE_SEPARATOR);
state_ = State.BLOCK_SEPARATOR_AT_END;
}
break;
default:
builder_.append(LINE_SEPARATOR);
state_ = State.BLOCK_SEPARATOR_AT_END;
break;
}
}
public void appendNewLine() {
builder_.append(LINE_SEPARATOR);
state_ = State.NEWLINE_AT_END;
trimRightPos_ = builder_.length();
}
public void appendTab() {
builder_.append('\t');
trimRightPos_ = builder_.length();
}
private void appendBlank() {
builder_.append(' ');
trimRightPos_ = builder_.length();
}
public String getText() {
return builder_.substring(0, trimRightPos_);
}
private static boolean isSpace(final char ch) {
return ch == ' ' || ch == '\t' || ch == '\n' || ch == '\f' || ch == '\r';
}
}
}