001/* 002 * This library is part of OpenCms - 003 * the Open Source Content Management System 004 * 005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com) 006 * 007 * This library is free software; you can redistribute it and/or 008 * modify it under the terms of the GNU Lesser General Public 009 * License as published by the Free Software Foundation; either 010 * version 2.1 of the License, or (at your option) any later version. 011 * 012 * This library is distributed in the hope that it will be useful, 013 * but WITHOUT ANY WARRANTY; without even the implied warranty of 014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 015 * Lesser General Public License for more details. 016 * 017 * For further information about Alkacon Software GmbH & Co. KG, please see the 018 * company website: http://www.alkacon.com 019 * 020 * For further information about OpenCms, please see the 021 * project website: http://www.opencms.org 022 * 023 * You should have received a copy of the GNU Lesser General Public 024 * License along with this library; if not, write to the Free Software 025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 026 */ 027 028package org.opencms.jsp; 029 030import javax.servlet.jsp.tagext.TagData; 031import javax.servlet.jsp.tagext.TagExtraInfo; 032 033/** 034 * This is a TagExtraInfo evaluation class that checks the attibutes of 035 * the <code><cms:include /></code> tag.<p> 036 * 037 * @since 6.0.0 038 */ 039public class CmsJspTagIncludeTEI extends TagExtraInfo { 040 041 /** Attribute name. */ 042 private static final String ATTR_ATTRIBUTE = "attribute"; 043 044 /** Attribute name. */ 045 private static final String ATTR_FILE = "file"; 046 047 /** Attribute name. */ 048 private static final String ATTR_PAGE = "page"; 049 050 /** Attribute name. */ 051 private static final String ATTR_PROPERTY = "property"; 052 053 /** Attribute name. */ 054 private static final String ATTR_SUFFIX = "suffix"; 055 056 /** 057 * Returns true if the given attribute name is specified, false otherwise.<p> 058 * 059 * @param data the tag data 060 * @param attributeName the attribute name 061 * @return true if the given attribute name is specified, false otherwise 062 */ 063 public static boolean isSpecified(TagData data, String attributeName) { 064 065 return (data.getAttribute(attributeName) != null); 066 } 067 068 /** 069 * Checks the validity of the <code><cms:include /></code> attributes.<p> 070 * 071 * The logic used is: 072 * <pre> 073 * if (hasFile && (hasSuffix || hasProperty || hasAttribute)) return false; 074 * if (hasProperty && hasAttribute) return false; 075 * if (hasSuffix && !(hasProperty || hasAttribute)) return false; 076 * </pre> 077 * 078 * @param data the tag data 079 * @return true if attributes are valid, false otherwise 080 */ 081 @Override 082 public boolean isValid(TagData data) { 083 084 boolean hasFile = isSpecified(data, ATTR_FILE) || isSpecified(data, ATTR_PAGE); 085 boolean hasSuffix = isSpecified(data, ATTR_SUFFIX); 086 boolean hasProperty = isSpecified(data, ATTR_PROPERTY); 087 boolean hasAttribute = isSpecified(data, ATTR_ATTRIBUTE); 088 // boolean hasElement = isSpecified(data, C_ATTR_ELEMENT); 089 090 if (hasFile && (hasSuffix || hasProperty || hasAttribute)) { 091 return false; 092 } 093 if (hasProperty && hasAttribute) { 094 return false; 095 } 096 if (hasSuffix && !(hasProperty || hasAttribute)) { 097 return false; 098 } 099 100 return true; 101 } 102}