WordToHtmlUtils.java
/* ====================================================================
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
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.
==================================================================== */
package org.apache.poi.hwpf.converter;
import java.util.Locale;
import java.util.Set;
import org.apache.poi.hwpf.usermodel.BorderCode;
import org.apache.poi.hwpf.usermodel.CharacterRun;
import org.apache.poi.hwpf.usermodel.Paragraph;
import org.apache.poi.hwpf.usermodel.TableCell;
import org.apache.poi.hwpf.usermodel.TableRow;
import org.apache.poi.util.Beta;
import org.w3c.dom.Element;
@Beta
public class WordToHtmlUtils extends AbstractWordUtils
{
private static final Set<String> SAFE_HYPERLINK_SCHEMES = Set.of(
"http", "https", "ftp", "mailto", "file", "news", "tel" );
public static void addBold( final boolean bold, StringBuilder style )
{
style.append("font-weight:").append(bold ? "bold" : "normal").append(";");
}
public static void addBorder( BorderCode borderCode, String where,
StringBuilder style )
{
if ( borderCode == null || borderCode.isEmpty() )
return;
if ( isEmpty( where ) )
{
style.append( "border:" );
}
else
{
style.append( "border-" );
style.append( where );
}
style.append( ":" );
if ( borderCode.getLineWidth() < 8 )
style.append( "thin" );
else
style.append( getBorderWidth( borderCode ) );
style.append( ' ' );
style.append( getBorderType( borderCode ) );
style.append( ' ' );
style.append( getColor( borderCode.getColor() ) );
style.append( ';' );
}
public static void addCharactersProperties(
final CharacterRun characterRun, StringBuilder style )
{
addBorder( characterRun.getBorder(), EMPTY, style );
if ( characterRun.isCapitalized() )
{
style.append( "text-transform:uppercase;" );
}
if ( characterRun.getIco24() != -1 )
{
style.append("color:").append(getColor24(characterRun.getIco24())).append(";");
}
if ( characterRun.isHighlighted() )
{
style.append("background-color:").append(getColor(characterRun.getHighlightedColor())).append(";");
}
if ( characterRun.isStrikeThrough() )
{
style.append( "text-decoration:line-through;" );
}
if ( characterRun.isShadowed() )
{
style.append("text-shadow:").append(characterRun.getFontSize() / 24).append("pt;");
}
if ( characterRun.isSmallCaps() )
{
style.append( "font-variant:small-caps;" );
}
if ( characterRun.getSubSuperScriptIndex() == 1 )
{
style.append( "vertical-align:super;" );
style.append( "font-size:smaller;" );
}
if ( characterRun.getSubSuperScriptIndex() == 2 )
{
style.append( "vertical-align:sub;" );
style.append( "font-size:smaller;" );
}
if ( characterRun.getUnderlineCode() > 0 )
{
style.append( "text-decoration:underline;" );
}
if ( characterRun.isVanished() )
{
style.append( "visibility:hidden;" );
}
}
public static void addFontFamily( final String fontFamily,
StringBuilder style )
{
if ( isEmpty( fontFamily ) )
return;
style.append("font-family:").append(cssFontFamily(fontFamily)).append(";");
}
/**
* The font name comes straight from the document and ends up in the text of the
* {@code <style>} element, which the html output method writes unescaped. Names whose
* space-separated words are all CSS identifiers (letters, digits, hyphens and underscores,
* not starting with a digit or a hyphen and digit) are written as they are; anything
* else is written as a CSS string, with quotes, backslashes, control characters and the
* HTML delimiters hex-escaped, so the name can neither close the style element nor add
* declarations of its own.
*/
static String cssFontFamily( final String fontFamily )
{
if ( isCssIdentifiers( fontFamily ) )
return fontFamily;
StringBuilder sb = new StringBuilder( fontFamily.length() + 2 );
sb.append( '"' );
for ( int i = 0; i < fontFamily.length(); i++ )
{
char c = fontFamily.charAt( i );
if ( c < 0x20 || c == '"' || c == '\\' || c == '<' || c == '>' )
{
sb.append( '\\' ).append( Integer.toHexString( c ) ).append( ' ' );
}
else
{
sb.append( c );
}
}
sb.append( '"' );
return sb.toString();
}
private static boolean isCssIdentifiers( final String fontFamily )
{
boolean wordStart = true;
for ( int i = 0; i < fontFamily.length(); i++ )
{
char c = fontFamily.charAt( i );
if ( c == ' ' )
{
wordStart = true;
continue;
}
if ( !Character.isLetterOrDigit( c ) && c != '-' && c != '_' )
return false;
if ( wordStart )
{
// an identifier must not start with a digit, or with a hyphen and a digit
char first = c == '-' && i + 1 < fontFamily.length() ? fontFamily.charAt( i + 1 ) : c;
if ( Character.isDigit( first ) )
return false;
wordStart = false;
}
}
return true;
}
/**
* The target of a HYPERLINK field comes straight from the document and ends up in the
* {@code href} of a link, where a scheme like {@code javascript:} runs script in the page
* when the link is followed. Targets without a scheme (relative paths, fragments, UNC
* paths), Windows drive paths and the common document link schemes are accepted. The
* scheme is looked up the way browsers parse it, i.e. after dropping tabs and line breaks
* anywhere and control characters and spaces at the start.
* <p>
* {@link WordToHtmlConverter} and {@link WordToFoConverter} always apply this check, before
* any validator set with {@link WordToHtmlConverter#setHyperlinkValidator(java.util.function.Predicate)}
* or {@link WordToFoConverter#setHyperlinkValidator(java.util.function.Predicate)}.
*
* @param hyperlink the target of a HYPERLINK field
* @return true if the target can be written as the {@code href} of a link
* @since 6.1.0
*/
public static boolean isSafeHyperlink( final String hyperlink )
{
StringBuilder target = new StringBuilder( hyperlink.length() );
for ( int i = 0; i < hyperlink.length(); i++ )
{
char c = hyperlink.charAt( i );
if ( c != '\t' && c != '\n' && c != '\r' && ( c > ' ' || target.length() > 0 ) )
target.append( c );
}
// scheme = ALPHA *( ALPHA / DIGIT / "+" / "-" / "." ) ":"
int end = 0;
while ( end < target.length() && isSchemeChar( target.charAt( end ), end == 0 ) )
end++;
// no scheme at all, or a single letter, i.e. a drive like C:\
if ( end < 2 || end == target.length() || target.charAt( end ) != ':' )
return true;
return SAFE_HYPERLINK_SCHEMES.contains( target.substring( 0, end ).toLowerCase( Locale.ROOT ) );
}
private static boolean isSchemeChar( final char c, final boolean first )
{
if ( ( c >= 'a' && c <= 'z' ) || ( c >= 'A' && c <= 'Z' ) )
return true;
return !first && ( ( c >= '0' && c <= '9' ) || c == '+' || c == '-' || c == '.' );
}
public static void addFontSize( final int fontSize, StringBuilder style )
{
style.append("font-size:").append(fontSize).append("pt;");
}
public static void addIndent( Paragraph paragraph, StringBuilder style )
{
addIndent( style, "text-indent", paragraph.getFirstLineIndent() );
addIndent( style, "margin-left", paragraph.getIndentFromLeft() );
addIndent( style, "margin-right", paragraph.getIndentFromRight() );
addIndent( style, "margin-top", paragraph.getSpacingBefore() );
addIndent( style, "margin-bottom", paragraph.getSpacingAfter() );
}
private static void addIndent( StringBuilder style, final String cssName,
final int twipsValue )
{
if ( twipsValue == 0 )
return;
style.append(cssName).append(":").append(twipsValue / TWIPS_PER_INCH).append("in;");
}
public static void addJustification( Paragraph paragraph,
final StringBuilder style )
{
String justification = getJustification( paragraph.getJustification() );
if ( isNotEmpty( justification ) )
style.append("text-align:").append(justification).append(";");
}
public static void addParagraphProperties( Paragraph paragraph,
StringBuilder style )
{
addIndent( paragraph, style );
addJustification( paragraph, style );
addBorder( paragraph.getBottomBorder(), "bottom", style );
addBorder( paragraph.getLeftBorder(), "left", style );
addBorder( paragraph.getRightBorder(), "right", style );
addBorder( paragraph.getTopBorder(), "top", style );
if ( paragraph.pageBreakBefore() )
{
style.append( "break-before:page;" );
}
style.append("hyphenate:").append(paragraph.isAutoHyphenated() ? "auto" : "none").append(";");
if ( paragraph.keepOnPage() )
{
style.append( "keep-together.within-page:always;" );
}
if ( paragraph.keepWithNext() )
{
style.append( "keep-with-next.within-page:always;" );
}
}
public static void addTableCellProperties( TableRow tableRow,
TableCell tableCell, boolean toppest, boolean bottomest,
boolean leftest, boolean rightest, StringBuilder style )
{
style.append("width:").append(tableCell.getWidth() / TWIPS_PER_INCH).append("in;");
style.append("padding-start:").append(tableRow.getGapHalf() / TWIPS_PER_INCH).append("in;");
style.append("padding-end:").append(tableRow.getGapHalf() / TWIPS_PER_INCH).append("in;");
BorderCode top = tableCell.getBrcTop() != null
&& tableCell.getBrcTop().getBorderType() != 0 ? tableCell
.getBrcTop() : toppest ? tableRow.getTopBorder() : tableRow
.getHorizontalBorder();
BorderCode bottom = tableCell.getBrcBottom() != null
&& tableCell.getBrcBottom().getBorderType() != 0 ? tableCell
.getBrcBottom() : bottomest ? tableRow.getBottomBorder()
: tableRow.getHorizontalBorder();
BorderCode left = tableCell.getBrcLeft() != null
&& tableCell.getBrcLeft().getBorderType() != 0 ? tableCell
.getBrcLeft() : leftest ? tableRow.getLeftBorder() : tableRow
.getVerticalBorder();
BorderCode right = tableCell.getBrcRight() != null
&& tableCell.getBrcRight().getBorderType() != 0 ? tableCell
.getBrcRight() : rightest ? tableRow.getRightBorder()
: tableRow.getVerticalBorder();
addBorder( bottom, "bottom", style );
addBorder( left, "left", style );
addBorder( right, "right", style );
addBorder( top, "top", style );
}
public static void addTableRowProperties( TableRow tableRow,
StringBuilder style )
{
if ( tableRow.getRowHeight() > 0 )
{
style.append("height:").append(tableRow.getRowHeight() / TWIPS_PER_INCH).append("in;");
}
if ( !tableRow.cantSplit() )
{
style.append( "keep-together:always;" );
}
}
static void compactSpans( Element pElement )
{
compactChildNodesR( pElement, "span" );
}
}