org.apache.shindig.gadgets.parse.DefaultHtmlSerializer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of shindig-gadgets Show documentation

Renders gadgets, provides the gadget metadata service, and serves all javascript required by the OpenSocial specification.

The 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.shindig.gadgets.parse;

import org.cyberneko.html.HTMLElements;
import org.w3c.dom.Attr;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.NamedNodeMap;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;

import java.io.IOException;
import java.io.StringWriter;

/**
 * This parser does not try to escape entities in text content as it expects the parser
 * to have retained the original entity references rather than its resolved form in text nodes.
 */
public class DefaultHtmlSerializer implements HtmlSerializer {

  /** {@inheritDoc} */
  public String serialize(Document doc) {
    try {
      StringWriter sw = HtmlSerialization.createWriter(doc);
      if (doc.getDoctype() != null) {
        HtmlSerialization.outputDocType(doc.getDoctype(), sw);
      }
      this.serialize(doc, sw);
      return sw.toString();
    } catch (IOException ioe) {
      return null;
    }
  }

  public void serialize(Node n, Appendable output) throws IOException {
    serialize(n, output, false);
  }

  private void serialize(Node n, Appendable output, boolean xmlMode)
      throws IOException {
    if (n == null) return;
    switch (n.getNodeType()) {
      case Node.CDATA_SECTION_NODE: {
        break;
      }
      case Node.COMMENT_NODE: {
        writeComment(n, output);
        break;
      }
      case Node.DOCUMENT_NODE: {
        NodeList children = n.getChildNodes();
        for (int i = 0; i < children.getLength(); i++) {
          serialize(children.item(i), output, xmlMode);
        }
        break;
      }
      case Node.ELEMENT_NODE: {
        Element elem = (Element) n;
        NodeList children = elem.getChildNodes();
        elem = substituteElement(elem);

        HTMLElements.Element htmlElement =
            HTMLElements.getElement(elem.getNodeName());

        HtmlSerialization.printStartElement(elem, output, xmlMode && htmlElement.isEmpty());

        // Special HTML elements -