org.apache.myfaces.trinidadinternal.io.DebugHtmlResponseWriter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of trinidad-impl Show documentation
Private implementation of the Apache MyFaces Trinidad project
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.myfaces.trinidadinternal.io;

import java.io.IOException;
import java.io.Writer;
import java.util.Arrays;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Stack;

import javax.faces.component.UIComponent;
import javax.faces.context.ResponseWriter;

import org.apache.myfaces.trinidad.context.RenderingContext;
import org.apache.myfaces.trinidad.logging.TrinidadLogger;



/**
 * ResponseWriter that decorates another and checks for common
 * mistakes in HTML output.
 * 
 * @version $Name:  $ ($Revision: adfrt/faces/adf-faces-impl/src/main/java/oracle/adfinternal/view/faces/io/DebugHtmlResponseWriter.java#1 $) $Date: 11-nov-2005.14:59:40 $
 */
public class DebugHtmlResponseWriter extends ResponseWriterDecorator
{
  /**
   * Creates a DebugHtmlResponseWriter.
   */
  public DebugHtmlResponseWriter(ResponseWriter decorated)
  {
    super(decorated);
    _elementStack = new Stack();
  }

  /**
   * Creates a new instance of this DebugHtmlResponseWriter, using a different
   * Writer.
   */
  @Override
  public ResponseWriter cloneWithWriter(Writer writer)
  {
    DebugHtmlResponseWriter cloned =
      new DebugHtmlResponseWriter(getResponseWriter().cloneWithWriter(writer));
    cloned._elementStack.addAll(_elementStack);
    return cloned;
  }



  @Override
  public void startElement(String name, UIComponent component) throws IOException
  {
    String lowerName = name.toLowerCase();
    // check for nested 
 tag, nested  tag,
    // and nested  tag
    if ("form".equals(lowerName) ||
        "body".equals(lowerName) ||
        "html".equals(lowerName))
    {
      if(_elementStack.contains(lowerName))
        _errorWithComment("Illegal HTML: Cannot nest <" + lowerName + "> elements");
    }


    // Check for elements that are not allowed inside each other -
    // but only when PPR is off (with PPR, we're not rendering the
    // whole tree, so it's easy for supposedly illegal combinations)
    RenderingContext rc = RenderingContext.getCurrentInstance();
    if (((rc == null) || (rc.getPartialPageContext() == null)) &&
        !_elementStack.empty())
    {
      String parent = _elementStack.peek();
      Collection allowedParents = _sAllowedParents.get(lowerName);
      Collection allowedChildren = _sAllowedChildren.get(parent);
      if (((allowedParents != null)  &&
           !allowedParents.contains(parent)) ||
          ((allowedChildren != null)  &&
           // In practice,