All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • org.apache.solr.common.util.DOMUtil Maven / Gradle / Ivy

    There is a newer version: 9.7.0
    Show newest version
    /*
 * 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 static org.apache.solr.common.params.CommonParams.NAME;

import java.util.ArrayList;
import java.util.HashMap;
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;

/** */
public class DOMUtil {

  public static final String XML_RESERVED_PREFIX = "xml";

  public static final Set NL_TAGS =
      Set.of("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()
        .forEach(
            (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 < attrs.getLength(); j++) {
      Node attr = attrs.item(j);

      // automatically exclude things in the xml namespace, ie: xml:base
      if (XML_RESERVED_PREFIX.equals(attr.getPrefix())) continue outer;

      String attrName = attr.getNodeName();
      for (String ex : exclusions) if (ex.equals(attrName)) continue outer;
      String val = attr.getNodeValue();
      args.put(attrName, val);
    }
    return args;
  }

  public static Node getChild(Node node, String name) {
    if (!node.hasChildNodes()) return null;
    NodeList lst = node.getChildNodes();
    if (lst == null) return null;
    for (int i = 0; i < lst.getLength(); i++) {
      Node child = lst.item(i);
      if (name.equals(child.getNodeName())) return child;
    }
    return null;
  }

  public static String getAttr(NamedNodeMap attrs, String name) {
    return getAttr(attrs, name, null);
  }

  public static String getAttr(Node nd, String name) {
    return getAttr(nd.getAttributes(), name);
  }

  public static String getAttrOrDefault(Node nd, String name, String def) {
    String attr = getAttr(nd.getAttributes(), name);
    return attr == null ? def : attr;
  }

  public static String getAttr(NamedNodeMap attrs, String name, String missing_err) {
    Node attr = attrs == null ? null : attrs.getNamedItem(name);
    if (attr == null) {
      if (missing_err == null) return null;
      throw new RuntimeException(missing_err + ": missing mandatory attribute '" + name + "'");
    }
    String val = attr.getNodeValue();
    return val;
  }

  public static String getAttr(ConfigNode node, String name, String missing_err) {
    String attr = node.attributes().get(name);
    if (attr == null) {
      if (missing_err == null) return null;
      throw new RuntimeException(missing_err + ": missing mandatory attribute '" + name + "'");
    }
    return attr;
  }

  public static String getAttr(Node node, String name, String missing_err) {
    return getAttr(node.getAttributes(), name, missing_err);
  }

  //////////////////////////////////////////////////////////
  // Routines to parse XML in the syntax of the Solr query
  // response schema.
  // Should these be moved to Config?  Should all of these things?
  //////////////////////////////////////////////////////////
  public static NamedList childNodesToNamedList(Node nd) {
    return nodesToNamedList(nd.getChildNodes());
  }

  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 < nlst.getLength(); i++) {
      addToNamedList(nlst.item(i), clst, null);
    }
    return clst;
  }

  public static List nodesToList(NodeList nlst) {
    List lst = new ArrayList<>();
    for (int i = 0; i < nlst.getLength(); i++) {
      addToNamedList(nlst.item(i), null, lst);
    }
    return lst;
  }

  /**
   * Examines a Node from the DOM representation of a NamedList and adds the contents of that node
   * to both the specified NamedList and List passed as arguments.
   *
   * @param nd The Node whose type will be used to determine how to parse the text content. If there
   *     is a 'name' attribute it will be used when adding to the NamedList
   * @param nlst A NamedList to add the item to with name if application. If this param is null it
   *     will be ignored.
   * @param arr A List to add the item to. If this param is null it will be ignored.
   */
  public static void addToNamedList(Node nd, NamedList nlst, List arr) {
    // Nodes often include whitespace, etc... so just return if this
    // is not an Element.
    if (nd.getNodeType() != Node.ELEMENT_NODE) return;

    final String type = nd.getNodeName();

    final String name = getAttr(nd, NAME);

    Object val = null;

    if ("lst".equals(type)) {
      val = childNodesToNamedList(nd);
    } else if ("arr".equals(type)) {
      val = childNodesToList(nd);
    } else {
      final String textValue = getText(nd);
      val = parseVal(type, name, textValue);
    }

    if (nlst != null) nlst.add(name, val);
    if (arr != null) arr.add(val);
  }

  private static Object parseVal(String type, String name, String textValue) {
    Object val = null;
    try {
      if ("str".equals(type)) {
        val = textValue;
      } else if ("int".equals(type)) {
        val = Integer.valueOf(textValue);
      } else if ("long".equals(type)) {
        val = Long.valueOf(textValue);
      } else if ("float".equals(type)) {
        val = Float.valueOf(textValue);
      } else if ("double".equals(type)) {
        val = Double.valueOf(textValue);
      } else if ("bool".equals(type)) {
        val = StrUtils.parseBool(textValue);
      } else if ("null".equals(type)) {
        val = null;
      }
      // :NOTE: Unexpected Node names are ignored
      // :TODO: should we generate an error here?
    } catch (NumberFormatException nfe) {
      throw new SolrException(
          SolrException.ErrorCode.SERVER_ERROR,
          "Value "
              + (null != name ? ("of '" + name + "' ") : "")
              + "can not be parsed as '"
              + type
              + "': \""
              + textValue
              + "\"",
          nfe);
    }
    return val;
  }

  public static NamedList 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 contacted (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, either 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 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));
    }
  }
}
    
    
    
    

    




    
    
    © 2015 - 2025 Weber Informatics LLC | Privacy Policy