/*
* 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.lenya.cms.site.tree;
import java.util.ArrayList;
import java.util.List;
import org.apache.avalon.framework.container.ContainerUtil;
import org.apache.avalon.framework.logger.AbstractLogEnabled;
import org.apache.avalon.framework.logger.Logger;
import org.apache.lenya.cms.publication.DocumentException;
import org.apache.lenya.cms.publication.DocumentFactory;
import org.apache.lenya.cms.site.Link;
import org.apache.lenya.cms.site.SiteException;
import org.apache.lenya.cms.site.SiteNode;
import org.apache.lenya.cms.site.SiteStructure;
import org.apache.lenya.util.Assert;
import org.apache.lenya.xml.NamespaceHelper;
import org.w3c.dom.Element;
import org.w3c.dom.NamedNodeMap;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
/**
* Concrete implementation of the <code>SiteTreeNode</code> interface.
*
* @see org.apache.lenya.cms.site.tree.SiteTreeNode
* @version $Id: SiteTreeNodeImpl.java 155316 2005-02-25 10:53:29Z andreas $
*/
public class SiteTreeNodeImpl extends AbstractLogEnabled implements SiteTreeNode {
/**
* <code>ID_ATTRIBUTE_NAME</code> The id attribute
*/
public static final String ID_ATTRIBUTE_NAME = "id";
/**
* <code>UUID_ATTRIBUTE_NAME</code> The uuid attribute
*/
public static final String UUID_ATTRIBUTE_NAME = "uuid";
/**
* <code>ISIBLEINNAV_ATTRIBUTE_NAME</code>The visibleinnav attribute
*/
public static final String VISIBLEINNAV_ATTRIBUTE_NAME = "visibleinnav";
/**
* <code>HREF_ATTRIBUTE_NAME</code> The href attribute
*/
public static final String HREF_ATTRIBUTE_NAME = "href";
/**
* <code>SUFFIX_ATTRIBUTE_NAME</code> The suffix attribute
*/
public static final String SUFFIX_ATTRIBUTE_NAME = "suffix";
/**
* <code>LINK_ATTRIBUTE_NAME</code> The link attribute
*/
public static final String LINK_ATTRIBUTE_NAME = "link";
/**
* <code>LANGUAGE_ATTRIBUTE_NAME</code> The language attribute
*/
public static final String LANGUAGE_ATTRIBUTE_NAME = "xml:lang";
/**
* <code>NODE_NAME</code> The node name
*/
public static final String NODE_NAME = "node";
/**
* <code>LABEL_NAME</code> The label name
*/
public static final String LABEL_NAME = "label";
private Element node = null;
private DefaultSiteTree tree;
private DocumentFactory factory;
/**
* Creates a new SiteTreeNodeImpl object.
* @param factory The document factory.
* @param tree The tree.
* @param node The node.
* @param logger The logger.
*
* @param _node the node which is to be wrapped by this SiteTreeNode
*/
protected SiteTreeNodeImpl(DocumentFactory factory, DefaultSiteTree tree, Element node, Logger logger) {
ContainerUtil.enableLogging(this, logger);
this.node = node;
this.tree = tree;
this.factory = factory;
}
public String getName() {
if (this.node == this.node.getOwnerDocument().getDocumentElement()) {
return "";
}
return this.node.getAttributes().getNamedItem(ID_ATTRIBUTE_NAME).getNodeValue();
}
public String getUuid() {
if (this.node == this.node.getOwnerDocument().getDocumentElement()) {
getLogger().warn("Node equals OwnerDocument: " + this);
return "";
}
Element element = (Element) this.node;
if (element.hasAttribute(UUID_ATTRIBUTE_NAME)) {
return element.getAttribute(UUID_ATTRIBUTE_NAME);
} else {
if (getLanguages().length > 0) {
String path = getPath();
getLogger().warn(
"Assuming non-UUID content because no 'uuid' attribute is set"
+ " and the node contains links. Returning path [" + path
+ "] as UUID.");
return path;
} else {
return null;
}
}
}
public String getPath() {
String absoluteId = "";
Node currentNode = this.node;
NamedNodeMap attributes = null;
Node idAttribute = null;
while (currentNode != null) {
attributes = currentNode.getAttributes();
if (attributes == null) {
break;
}
idAttribute = attributes.getNamedItem(ID_ATTRIBUTE_NAME);
if (idAttribute == null) {
break;
}
absoluteId = "/" + idAttribute.getNodeValue() + absoluteId;
currentNode = currentNode.getParentNode();
}
return absoluteId;
}
protected SiteTreeLink[] getLinks() {
ArrayList labels = new ArrayList();
NodeList children = this.node.getChildNodes();
for (int i = 0; i < children.getLength(); i++) {
Node child = children.item(i);
if ((child.getNodeType() == Node.ELEMENT_NODE)
&& child.getNodeName().equals(LABEL_NAME)) {
String labelLanguage = null;
Node languageAttribute = child.getAttributes()
.getNamedItem(LANGUAGE_ATTRIBUTE_NAME);
if (languageAttribute != null) {
labelLanguage = languageAttribute.getNodeValue();
}
labels.add(new SiteTreeLink(this.factory, this, labelLanguage,
(Element) child));
}
}
return (SiteTreeLink[]) labels.toArray(new SiteTreeLink[labels.size()]);
}
public void addLabel(String language, String label) throws SiteException {
Assert.isTrue("not contains " + language, !hasLink(language));
NamespaceHelper helper = getNamespaceHelper();
Element labelElem = helper.createElement(SiteTreeNodeImpl.LABEL_NAME, label);
labelElem.setAttribute(SiteTreeNodeImpl.LANGUAGE_ATTRIBUTE_NAME, language);
node.insertBefore(labelElem, node.getFirstChild());
getTree().changed();
}
public void removeLabel(String language) {
if (!hasLink(language)) {
throw new RuntimeException(this + " does not contain the language [" + language + "]");
} else {
// this node doesn't contain this label
try {
NodeList children = this.node.getChildNodes();
for (int i = 0; i < children.getLength(); i++) {
Node child = children.item(i);
if ((child.getNodeType() == Node.ELEMENT_NODE)
&& child.getNodeName().equals(LABEL_NAME)) {
Node languageAttribute = child.getAttributes().getNamedItem(
LANGUAGE_ATTRIBUTE_NAME);
if (languageAttribute != null
&& languageAttribute.getNodeValue().equals(language)) {
this.node.removeChild(child);
getTree().changed();
break;
}
}
}
deleteIfEmpty();
} catch (SiteException e) {
throw new RuntimeException("could not save sitetree after deleting label of "
+ this + " [" + language + "]");
}
}
}
protected void deleteIfEmpty() throws SiteException {
if (getLanguages().length == 0 && getChildren().length == 0) {
delete();
}
}
/**
* @see org.apache.lenya.cms.site.tree.SiteTreeNode#visibleInNav()
*/
public boolean visibleInNav() {
Node attribute = this.node.getAttributes().getNamedItem(VISIBLEINNAV_ATTRIBUTE_NAME);
if (attribute != null) {
return attribute.getNodeValue().equals("true");
}
return true;
}
/**
* @see org.apache.lenya.cms.site.tree.SiteTreeNode#getHref()
*/
public String getHref() {
Node attribute = this.node.getAttributes().getNamedItem(HREF_ATTRIBUTE_NAME);
if (attribute != null) {
return attribute.getNodeValue();
}
return null;
}
/**
* @see org.apache.lenya.cms.site.tree.SiteTreeNode#getSuffix()
*/
public String getSuffix() {
Node attribute = this.node.getAttributes().getNamedItem(SUFFIX_ATTRIBUTE_NAME);
if (attribute != null) {
return attribute.getNodeValue();
}
return null;
}
/**
* @see org.apache.lenya.cms.site.tree.SiteTreeNode#hasLink()
*/
public boolean hasLink() {
Node attribute = this.node.getAttributes().getNamedItem(LINK_ATTRIBUTE_NAME);
if (attribute != null) {
return attribute.getNodeValue().equals("true");
}
return false;
}
/**
* @see org.apache.lenya.cms.site.tree.SiteTreeNode#getChildren()
*/
public SiteNode[] getChildren() {
List childElements = new ArrayList();
NamespaceHelper helper = getNamespaceHelper();
Element[] elements = helper.getChildren((Element) this.node, SiteTreeNodeImpl.NODE_NAME);
for (int i = 0; i < elements.length; i++) {
SiteTreeNode newNode = new SiteTreeNodeImpl(this.factory, getTree(), elements[i],
getLogger());
childElements.add(newNode);
}
return (SiteNode[]) childElements.toArray(new SiteNode[childElements.size()]);
}
/**
* @see org.apache.lenya.cms.site.tree.SiteTreeNode#removeChildren()
*/
public SiteTreeNode[] removeChildren() {
List childElements = new ArrayList();
NamespaceHelper helper = getNamespaceHelper();
Element[] elements = helper.getChildren((Element) this.node, SiteTreeNodeImpl.NODE_NAME);
for (int i = 0; i < elements.length; i++) {
this.node.removeChild(elements[i]);
SiteTreeNode newNode = new SiteTreeNodeImpl(this.factory, getTree(), elements[i],
getLogger());
childElements.add(newNode);
}
return (SiteTreeNode[]) childElements.toArray(new SiteTreeNode[childElements.size()]);
}
/**
* @see org.apache.lenya.cms.site.tree.SiteTreeNode#getNextSiblings()
*/
public SiteTreeNode[] getNextSiblings() {
List siblingElements = new ArrayList();
NamespaceHelper helper = getNamespaceHelper();
Element[] elements = helper
.getNextSiblings((Element) this.node, SiteTreeNodeImpl.NODE_NAME);
for (int i = 0; i < elements.length; i++) {
SiteTreeNode newNode = new SiteTreeNodeImpl(this.factory, getTree(), elements[i],
getLogger());
siblingElements.add(newNode);
}
return (SiteTreeNode[]) siblingElements.toArray(new SiteTreeNode[siblingElements.size()]);
}
/**
* @see org.apache.lenya.cms.site.tree.SiteTreeNode#getPrecedingSiblings()
*/
public SiteTreeNode[] getPrecedingSiblings() {
List siblingElements = new ArrayList();
NamespaceHelper helper = getNamespaceHelper();
Element[] elements = helper.getPrecedingSiblings((Element) this.node,
SiteTreeNodeImpl.NODE_NAME);
for (int i = 0; i < elements.length; i++) {
SiteTreeNode newNode = new SiteTreeNodeImpl(this.factory, getTree(), elements[i],
getLogger());
siblingElements.add(newNode);
}
return (SiteTreeNode[]) siblingElements.toArray(new SiteTreeNode[siblingElements.size()]);
}
/**
* @see org.apache.lenya.cms.site.tree.SiteTreeNode#getNextSiblingDocumentId()
*/
public String getNextSiblingDocumentId() {
SiteTreeNode[] siblings = getNextSiblings();
if (siblings != null && siblings.length > 0) {
return siblings[0].getPath();
}
return null;
}
/**
* @see org.apache.lenya.cms.site.tree.SiteTreeNode#accept(org.apache.lenya.cms.site.tree.SiteTreeNodeVisitor)
*/
public void accept(SiteTreeNodeVisitor visitor) throws DocumentException {
visitor.visitSiteTreeNode(this);
}
/**
* @see org.apache.lenya.cms.site.tree.SiteTreeNode#acceptSubtree(org.apache.lenya.cms.site.tree.SiteTreeNodeVisitor)
*/
public void acceptSubtree(SiteTreeNodeVisitor visitor) throws DocumentException {
this.accept(visitor);
SiteNode[] children = this.getChildren();
if (children == null) {
getLogger().info("The node " + getPath() + " has no children");
return;
}
for (int i = 0; i < children.length; i++) {
((SiteTreeNodeImpl) children[i]).acceptSubtree(visitor);
}
}
protected void acceptReverseSubtree(SiteTreeNodeVisitor visitor) throws DocumentException {
List orderedNodes = this.postOrder();
for (int i = 0; i < orderedNodes.size(); i++) {
SiteTreeNodeImpl _node = (SiteTreeNodeImpl) orderedNodes.get(i);
_node.accept(visitor);
}
}
/**
* @see org.apache.lenya.cms.site.tree.SiteTreeNode#postOrder()
*/
public List postOrder() {
List list = new ArrayList();
SiteNode[] children = this.getChildren();
for (int i = 0; i < children.length; i++) {
List orderedChildren = ((SiteTreeNodeImpl) children[i]).postOrder();
list.addAll(orderedChildren);
}
list.add(this);
return list;
}
/**
* @see org.apache.lenya.cms.site.tree.SiteTreeNode#setNodeAttribute(String, String)
*/
public void setNodeAttribute(String attributeName, String attributeValue) {
Element element = (Element) this.node;
element.setAttribute(attributeName, attributeValue);
}
/**
* @see org.apache.lenya.cms.site.tree.SiteTreeNode#getChildren(java.lang.String)
*/
public SiteTreeNode[] getChildren(String language) {
SiteNode[] children = getChildren();
List languageChildren = new ArrayList();
for (int i = 0; i < children.length; i++) {
if (children[i].hasLink(language)) {
languageChildren.add(children[i]);
}
}
return (SiteTreeNode[]) languageChildren.toArray(new SiteTreeNode[languageChildren.size()]);
}
/**
* @see org.apache.lenya.cms.site.tree.SiteTreeNode#getParent()
*/
public SiteNode getParent() throws SiteException {
SiteTreeNode parent = null;
Node parentNode = this.node.getParentNode();
if (parentNode.getNodeType() == Node.ELEMENT_NODE
&& parentNode.getLocalName().equals(NODE_NAME)) {
parent = new SiteTreeNodeImpl(this.factory, getTree(), (Element) parentNode,
getLogger());
ContainerUtil.enableLogging(parent, getLogger());
} else {
throw new SiteException("The node [" + this + "] has no parent.");
}
return parent;
}
/**
* Returns the namespace helper of the sitetree XML document.
* @return A namespace helper.
*/
protected NamespaceHelper getNamespaceHelper() {
NamespaceHelper helper = new NamespaceHelper(DefaultSiteTree.NAMESPACE_URI, "", this.node
.getOwnerDocument());
return helper;
}
/**
* @see org.apache.lenya.cms.site.tree.SiteTreeNode#getParent(java.lang.String)
*/
public SiteTreeNode getParent(String language) {
SiteTreeNode parent;
try {
parent = (SiteTreeNode) getParent();
} catch (SiteException e) {
throw new RuntimeException(e);
}
if (!parent.hasLink(language)) {
parent = null;
}
return parent;
}
/**
* @see org.apache.lenya.cms.site.tree.SiteTreeNode#preOrder()
*/
public List preOrder() {
List list = new ArrayList();
list.add(this);
SiteNode[] children = this.getChildren();
for (int i = 0; i < children.length; i++) {
List orderedChildren = ((SiteTreeNodeImpl) children[i]).preOrder();
list.addAll(orderedChildren);
}
return list;
}
public String getNodeAttribute(String attributeName) {
Element element = (Element) this.node;
return element.getAttribute(attributeName);
}
public void setUUID(String uuid) {
setNodeAttribute(UUID_ATTRIBUTE_NAME, uuid);
}
public SiteStructure getStructure() {
return getTree();
}
protected DefaultSiteTree getTree() {
return this.tree;
}
public String[] getLanguages() {
Link[] links = getLinks();
String[] languages = new String[links.length];
for (int i = 0; i < links.length; i++) {
languages[i] = links[i].getLanguage();
}
return languages;
}
public Link getLink(String language) throws SiteException {
Link link = getLinkInternal(language);
if (link == null) {
throw new SiteException("The node [" + this + "] doesn't contain the language ["
+ language + "].");
}
return link;
}
protected SiteTreeLink getLinkInternal(String language) {
SiteTreeLink[] links = getLinks();
for (int i = 0; i < links.length; i++) {
if (links[i].getLanguage().equals(language)) {
return links[i];
}
}
return null;
}
public boolean hasLink(String language) {
return getLinkInternal(language) != null;
}
public boolean equals(Object obj) {
if (!getClass().isInstance(obj)) {
return false;
}
return getKey().equals(((SiteTreeNodeImpl) obj).getKey());
}
protected String getKey() {
return getTree().getPublication().getId() + ":" + getTree().getArea() + ":" + getPath();
}
public int hashCode() {
return getKey().hashCode();
}
public String toString() {
return getKey();
}
public boolean isVisible() {
String value = getNodeAttribute(SiteTreeNodeImpl.VISIBLEINNAV_ATTRIBUTE_NAME);
if (value != null && !value.equals("")) {
return Boolean.valueOf(value).booleanValue();
} else {
return true;
}
}
public synchronized void setVisible(boolean visibleInNav) {
if (visibleInNav) {
setNodeAttribute(SiteTreeNodeImpl.VISIBLEINNAV_ATTRIBUTE_NAME, "true");
} else {
setNodeAttribute(SiteTreeNodeImpl.VISIBLEINNAV_ATTRIBUTE_NAME, "false");
}
save();
}
public void delete() {
try {
SiteTreeNodeImpl parent = null;
if (!isTopLevel()) {
parent = (SiteTreeNodeImpl) getParent();
}
getTree().removeNode(getPath());
if (parent != null) {
parent.deleteIfEmpty();
}
} catch (SiteException e) {
throw new RuntimeException(e);
}
}
public boolean isTopLevel() {
return getPath().lastIndexOf("/") == 0;
}
protected void save() {
try {
((DefaultSiteTree) getTree()).saveDocument();
} catch (SiteException e) {
throw new RuntimeException(e);
}
}
}