Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
org.apache.solr.common.util.DOMUtil Maven / Gradle / Ivy
/*
* 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.solr.common.util;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Properties;
import java.util.Set;
import org.apache.solr.common.ConfigNode;
import org.apache.solr.common.SolrException;
import org.w3c.dom.NamedNodeMap;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import static org.apache.solr.common.params.CommonParams.NAME;
/**
*
*/
public class DOMUtil {
public static final String XML_RESERVED_PREFIX = "xml";
public static final Set NL_TAGS = new HashSet<>(Arrays.asList("str", "int", "long", "float", "double", "bool", "null"));
public static Map toMap(NamedNodeMap attrs) {
return toMapExcept(attrs);
}
public static Map toMap(ConfigNode node) {
return toMapExcept(node);
}
public static Map toMapExcept(ConfigNode node, String... exclusions) {
Map args = new HashMap<>();
node.attributes().forEachEntry((k, v) -> {
for (String ex : exclusions) if (ex.equals(k)) return;
args.put(k,v);
});
return args;
}
public static Map toMapExcept(NamedNodeMap attrs, String... exclusions) {
Map args = new HashMap<>();
outer: for (int j=0; j childNodesToNamedList(Node nd) {
return nodesToNamedList(nd.getChildNodes());
}
@SuppressWarnings({"rawtypes"})
public static List childNodesToList(Node nd) {
return nodesToList(nd.getChildNodes());
}
public static NamedList childNodesToNamedList(ConfigNode node) {
return readNamedListChildren(node);
}
public static NamedList nodesToNamedList(NodeList nlst) {
NamedList clst = new NamedList<>();
for (int i=0; i readNamedListChildren(ConfigNode configNode) {
NamedList result = new NamedList<>();
configNode.forEachChild(it -> {
String tag = it.name();
String varName = it.attributes().get("name");
if (NL_TAGS.contains(tag)) {
result.add(varName, parseVal(tag, varName, it.txt()));
}
if ("lst".equals(tag)) {
result.add(varName, readNamedListChildren(it));
} else if ("arr".equals(tag)) {
List l = new ArrayList<>();
result.add(varName, l);
it.forEachChild(n -> {
if (NL_TAGS.contains(n.name())) {
l.add(parseVal(n.name(), null, n.txt()));
} else if("lst".equals(n.name())){
l.add(readNamedListChildren(n));
}
return Boolean.TRUE;
});
}
return Boolean.TRUE;
});
return result;
}
/**
* Drop in replacement for Node.getTextContent().
*
*
* This method is provided to support the same functionality as
* Node.getTextContent() but in a way that is DOM Level 2 compatible.
*
*
* @see DOM Object Model Core
*/
public static String getText(Node nd) {
short type = nd.getNodeType();
// for most node types, we can defer to the recursive helper method,
// but when asked for the text of these types, we must return null
// (Not the empty string)
switch (type) {
case Node.DOCUMENT_NODE: /* fall through */
case Node.DOCUMENT_TYPE_NODE: /* fall through */
case Node.NOTATION_NODE: /* fall through */
return null;
}
StringBuilder sb = new StringBuilder();
getText(nd, sb);
return sb.toString();
}
/** @see #getText(Node) */
private static void getText(Node nd, StringBuilder buf) {
short type = nd.getNodeType();
switch (type) {
case Node.ELEMENT_NODE: /* fall through */
case Node.ENTITY_NODE: /* fall through */
case Node.ENTITY_REFERENCE_NODE: /* fall through */
case Node.DOCUMENT_FRAGMENT_NODE:
NodeList childs = nd.getChildNodes();
for (int i = 0; i < childs.getLength(); i++) {
Node child = childs.item(i);
short childType = child.getNodeType();
if (childType != Node.COMMENT_NODE &&
childType != Node.PROCESSING_INSTRUCTION_NODE) {
getText(child, buf);
}
}
break;
case Node.ATTRIBUTE_NODE: /* fall through */
/* Putting Attribute nodes in this section does not exactly
match the definition of how textContent should behave
according to the DOM Level-3 Core documentation - which
specifies that the Attr's children should have their
textContent concated (Attr's can have a single child which
is either Text node or an EntityReference). In practice,
DOM implementations do not seem to use child nodes of
Attributes, storing the "text" directly as the nodeValue.
Fortunately, the DOM Spec indicates that when Attr.nodeValue
is read, it should return the nodeValue from the child Node,
so this approach should work both for strict implementations,
and implementations actually encountered.
*/
case Node.TEXT_NODE: /* fall through */
case Node.CDATA_SECTION_NODE: /* fall through */
case Node.COMMENT_NODE: /* fall through */
case Node.PROCESSING_INSTRUCTION_NODE: /* fall through */
buf.append(nd.getNodeValue());
break;
case Node.DOCUMENT_NODE: /* fall through */
case Node.DOCUMENT_TYPE_NODE: /* fall through */
case Node.NOTATION_NODE: /* fall through */
default:
/* :NOOP: */
}
}
/**
* Replaces ${system.property[:default value]} references in all attributes
* and text nodes of supplied node. If the system property is not defined and no
* default value is provided, a runtime exception is thrown.
*
* @param node DOM node to walk for substitutions
*/
public static void substituteSystemProperties(Node node) {
substituteProperties(node, null);
}
/**
* Replaces ${property[:default value]} references in all attributes
* and text nodes of supplied node. If the property is not defined neither in the
* given Properties instance nor in System.getProperty and no
* default value is provided, a runtime exception is thrown.
*
* @param node DOM node to walk for substitutions
* @param properties the Properties instance from which a value can be looked up
*/
public static void substituteProperties(Node node, Properties properties) {
// loop through child nodes
Node child;
Node next = node.getFirstChild();
while ((child = next) != null) {
// set next before we change anything
next = child.getNextSibling();
// handle child by node type
if (child.getNodeType() == Node.TEXT_NODE) {
child.setNodeValue(PropertiesUtil.substituteProperty(child.getNodeValue(), properties));
} else if (child.getNodeType() == Node.ELEMENT_NODE) {
// handle child elements with recursive call
NamedNodeMap attributes = child.getAttributes();
for (int i = 0; i < attributes.getLength(); i++) {
Node attribute = attributes.item(i);
attribute.setNodeValue(PropertiesUtil.substituteProperty(attribute.getNodeValue(), properties));
}
substituteProperties(child, properties);
}
}
}
public static String substituteProperty(String value, Properties coreProperties) {
if (value == null || value.indexOf('$') == -1) {
return value;
}
List fragments = new ArrayList<>();
List propertyRefs = new ArrayList<>();
parsePropertyString(value, fragments, propertyRefs);
StringBuilder sb = new StringBuilder();
Iterator i = fragments.iterator();
Iterator j = propertyRefs.iterator();
while (i.hasNext()) {
String fragment = i.next();
if (fragment == null) {
String propertyName = j.next();
String defaultValue = null;
int colon_index = propertyName.indexOf(':');
if (colon_index > -1) {
defaultValue = propertyName.substring(colon_index + 1);
propertyName = propertyName.substring(0,colon_index);
}
if (coreProperties != null) {
fragment = coreProperties.getProperty(propertyName);
}
if (fragment == null) {
fragment = System.getProperty(propertyName, defaultValue);
}
if (fragment == null) {
throw new SolrException( SolrException.ErrorCode.SERVER_ERROR, "No system property or default value specified for " + propertyName + " value:" + value);
}
}
sb.append(fragment);
}
return sb.toString();
}
/*
* This method borrowed from Ant's PropertyHelper.parsePropertyStringDefault:
* http://svn.apache.org/repos/asf/ant/core/trunk/src/main/org/apache/tools/ant/PropertyHelper.java
*/
private static void parsePropertyString(String value, List fragments, List propertyRefs) {
int prev = 0;
int pos;
//search for the next instance of $ from the 'prev' position
while ((pos = value.indexOf("$", prev)) >= 0) {
//if there was any text before this, add it as a fragment
//TODO, this check could be modified to go if pos>prev;
//seems like this current version could stick empty strings
//into the list
if (pos > 0) {
fragments.add(value.substring(prev, pos));
}
//if we are at the end of the string, we tack on a $
//then move past it
if (pos == (value.length() - 1)) {
fragments.add("$");
prev = pos + 1;
} else if (value.charAt(pos + 1) != '{') {
//peek ahead to see if the next char is a property or not
//not a property: insert the char as a literal
/*
fragments.addElement(value.substring(pos + 1, pos + 2));
prev = pos + 2;
*/
if (value.charAt(pos + 1) == '$') {
//backwards compatibility two $ map to one mode
fragments.add("$");
prev = pos + 2;
} else {
//new behaviour: $X maps to $X for all values of X!='$'
fragments.add(value.substring(pos, pos + 2));
prev = pos + 2;
}
} else {
//property found, extract its name or bail on a typo
int endName = value.indexOf('}', pos);
if (endName < 0) {
throw new RuntimeException("Syntax error in property: " + value);
}
String propertyName = value.substring(pos + 2, endName);
fragments.add(null);
propertyRefs.add(propertyName);
prev = endName + 1;
}
}
//no more $ signs found
//if there is any tail to the string, append it
if (prev < value.length()) {
fragments.add(value.substring(prev));
}
}
}
