/*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (c) Alkacon Software GmbH (http://www.alkacon.com)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* For further information about Alkacon Software GmbH, please see the
* company website: http://www.alkacon.com
*
* For further information about OpenCms, please see the
* project website: http://www.opencms.org
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.opencms.setup.xml;
import org.opencms.configuration.CmsConfigurationManager;
import org.opencms.i18n.CmsEncoder;
import org.opencms.setup.CmsSetupBean;
import org.opencms.util.CmsCollectionsGenericWrapper;
import org.opencms.util.CmsStringUtil;
import org.opencms.xml.CmsXmlUtils;
import java.io.StringReader;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import org.dom4j.Branch;
import org.dom4j.Document;
import org.dom4j.DocumentException;
import org.dom4j.DocumentFactory;
import org.dom4j.Node;
import org.dom4j.io.SAXReader;
/**
* Skeleton for xml update plugins.<p>
*
* @since 6.1.8
*/
public abstract class A_CmsSetupXmlUpdate implements I_CmsSetupXmlUpdate {
/**
* @see org.opencms.setup.xml.I_CmsSetupXmlUpdate#execute(org.opencms.setup.CmsSetupBean)
*/
public void execute(CmsSetupBean setupBean) throws Exception {
Document doc = setupBean.getXmlHelper().getDocument(getXmlFilename());
Iterator<String> itRemove = getXPathsToRemove().iterator();
while (itRemove.hasNext()) {
String xpath = itRemove.next();
CmsSetupXmlHelper.setValue(doc, xpath, null);
}
Iterator<String> itUpdate = getXPathsToUpdate().iterator();
while (itUpdate.hasNext()) {
String xpath = itUpdate.next();
executeUpdate(doc, xpath, true);
}
}
/**
* @see org.opencms.setup.xml.I_CmsSetupXmlUpdate#getCodeToChange(org.opencms.setup.CmsSetupBean)
*/
public String getCodeToChange(CmsSetupBean setupBean) throws Exception {
String ret = "";
Document doc = setupBean.getXmlHelper().getDocument(getXmlFilename());
// get the nodes to be deleted
Iterator<String> itRemove = getXPathsToRemove().iterator();
while (itRemove.hasNext()) {
String xpath = itRemove.next();
Iterator<Node> it = CmsCollectionsGenericWrapper.<Node> list(doc.selectNodes(xpath)).iterator();
while (it.hasNext()) {
Node node = it.next();
if (node != null) {
ret += CmsXmlUtils.marshal(node, CmsEncoder.ENCODING_UTF_8);
}
}
}
// create new temp doc to modify
String parentPath = getCommonPath();
// could be better done...
Document newDoc = prepareDoc(doc);
boolean modified = false;
// update the temp doc
Iterator<String> itUpdate = getXPathsToUpdate().iterator();
while (itUpdate.hasNext()) {
String xpath = itUpdate.next();
updateDoc(doc, newDoc, xpath);
boolean exe = executeUpdate(newDoc, xpath, false);
modified = modified || exe;
if ((parentPath == null) && exe) {
Node node = newDoc.selectSingleNode(xpath);
if (node != null) {
ret += CmsXmlUtils.marshal(node, CmsEncoder.ENCODING_UTF_8);
}
}
}
if ((parentPath != null) && modified) {
Node node = newDoc.selectSingleNode(parentPath);
if (node != null) {
ret += CmsXmlUtils.marshal(node, CmsEncoder.ENCODING_UTF_8);
}
}
return ret.trim();
}
/**
* @see org.opencms.setup.xml.I_CmsSetupXmlUpdate#validate(org.opencms.setup.CmsSetupBean)
*/
public boolean validate(CmsSetupBean setupBean) throws Exception {
return CmsStringUtil.isNotEmptyOrWhitespaceOnly(getCodeToChange(setupBean));
}
/**
* Executes the adding/updating changes on the given document.<p>
*
* Only needs to be overriden if {@link #getXPathsToUpdate()} is not empty.<p>
*
* @param document the document to apply the changes to
* @param xpath the xpath to execute the changes for
* @param forReal is <code>false</code>, it is only on a empty doc to display the changes to the user
*
* @return if something was modified
*/
protected boolean executeUpdate(Document document, String xpath, boolean forReal) {
return false;
}
/**
* Returns a parent path that is common for all nodes to modify.<p>
*
* @return common parent path
*/
protected String getCommonPath() {
return null;
}
/**
* Returns a list of xpaths for the nodes to remove.<p>
*
* @return a list of strings
*/
protected List<String> getXPathsToRemove() {
return new ArrayList<String>();
}
/**
* Returns a list of xpaths for the nodes to add/update.<p>
*
* @return a list of strings
*/
protected List<String> getXPathsToUpdate() {
return new ArrayList<String>();
}
/**
* Prepares a new document.<p>
*
* @param doc the original document
*
* @return a new document
*/
protected Document prepareDoc(Document doc) {
Document newDoc = new DocumentFactory().createDocument();
newDoc.addElement(CmsConfigurationManager.N_ROOT);
newDoc.setName(doc.getName());
return newDoc;
}
/**
* Updates the given doc inserting the given node corresponding to the given xpath.<p>
*
* @param document the original document to update
* @param newDoc the document to update
* @param xpath the corresponding xpath
*/
protected void updateDoc(Document document, Document newDoc, String xpath) {
Node node = document.selectSingleNode(xpath);
if (node != null) {
CmsSetupXmlHelper.setValue(newDoc, CmsXmlUtils.removeLastComplexXpathElement(xpath), " ");
node = (Node)node.clone();
node.setParent(null);
((Branch)newDoc.selectSingleNode(CmsXmlUtils.removeLastComplexXpathElement(xpath))).add(node);
}
}
/**
* Creates a dom4j element from an XML string.<p>
*
* @param xml the xml string
* @return the dom4j element
*
* @throws DocumentException if the XML parsing fails
*/
public static org.dom4j.Element createElementFromXml(String xml) throws DocumentException {
SAXReader reader = new SAXReader();
Document newNodeDocument = reader.read(new StringReader(xml));
return newNodeDocument.getRootElement();
}
}