/*
* 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, 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.v7;
import org.opencms.configuration.CmsConfigurationManager;
import org.opencms.configuration.CmsVfsConfiguration;
import org.opencms.configuration.I_CmsXmlConfiguration;
import org.opencms.setup.xml.A_CmsXmlVfs;
import org.opencms.setup.xml.CmsSetupXmlHelper;
import java.util.ArrayList;
import java.util.List;
import org.dom4j.Document;
import org.dom4j.Node;
/**
* Changes the gallery classes to the new ajax versions.
*
* @since 7.5.0
*/
public class CmsXmlChangeGalleryClasses extends A_CmsXmlVfs {
/** List of xpaths to update. */
private List<String> m_xpaths;
/**
* @see org.opencms.setup.xml.I_CmsSetupXmlUpdate#getName()
*/
public String getName() {
return "Change Gallery Classes";
}
/**
* @see org.opencms.setup.xml.A_CmsSetupXmlUpdate#getCommonPath()
*/
@Override
protected String getCommonPath() {
// /opencms/vfs/resources/resourcetypes
StringBuffer xp = new StringBuffer(256);
xp.append("/").append(CmsConfigurationManager.N_ROOT);
xp.append("/").append(CmsVfsConfiguration.N_VFS);
xp.append("/").append(CmsVfsConfiguration.N_RESOURCES);
xp.append("/").append(CmsVfsConfiguration.N_RESOURCETYPES);
return xp.toString();
}
/**
* @see org.opencms.setup.xml.A_CmsSetupXmlUpdate#getXPathsToUpdate()
*/
@Override
protected List<String> getXPathsToUpdate() {
if (m_xpaths == null) {
// "/opencms/vfs/resources/resourcetypes/type[@name='<gallery name>']";
StringBuffer xp = new StringBuffer(256);
xp.append("/").append(CmsConfigurationManager.N_ROOT);
xp.append("/").append(CmsVfsConfiguration.N_VFS);
xp.append("/").append(CmsVfsConfiguration.N_RESOURCES);
xp.append("/").append(CmsVfsConfiguration.N_RESOURCETYPES);
xp.append("/").append(CmsVfsConfiguration.N_TYPE);
xp.append("[@").append(I_CmsXmlConfiguration.A_NAME);
xp.append("='");
m_xpaths = new ArrayList<String>();
m_xpaths.add(xp.toString() + "imagegallery']/param[@name='folder.class']");
m_xpaths.add(xp.toString() + "downloadgallery']/param[@name='folder.class']");
m_xpaths.add(xp.toString() + "htmlgallery']/param[@name='folder.class']");
m_xpaths.add(xp.toString() + "tablegallery']/param[@name='folder.class']");
m_xpaths.add(xp.toString() + "linkgallery']/param[@name='folder.class']");
}
return m_xpaths;
}
/**
* @see org.opencms.setup.xml.A_CmsSetupXmlUpdate#executeUpdate(org.dom4j.Document, java.lang.String, boolean)
*/
@Override
protected boolean executeUpdate(Document document, String xpath, boolean forReal) {
Node node = document.selectSingleNode(xpath);
String oldClass = node.getText();
if ((oldClass != null) && !oldClass.contains(".CmsAjax") && oldClass.contains(".Cms")) {
oldClass = oldClass.replace(".Cms", ".CmsAjax");
CmsSetupXmlHelper.setValue(document, xpath, oldClass);
return true;
}
return false;
}
}