001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (C) Alkacon Software (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, 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.setup.xml.v8;
029
030import org.opencms.setup.CmsSetupBean;
031import org.opencms.setup.xml.A_CmsXmlVfs;
032import org.opencms.util.CmsStringUtil;
033
034import java.util.Collections;
035import java.util.List;
036
037import org.dom4j.Document;
038import org.dom4j.Element;
039import org.dom4j.Node;
040
041/**
042 * Adds translation rules to the opencms-vfs.xml file.<p>
043 */
044public class CmsXmlAddTranslationRules extends A_CmsXmlVfs {
045
046    /**
047     * @see org.opencms.setup.xml.I_CmsSetupXmlUpdate#getName()
048     */
049    public String getName() {
050
051        return "Add new resource translation rules";
052    }
053
054    /**
055     * @see org.opencms.setup.xml.I_CmsSetupXmlUpdate#validate(org.opencms.setup.CmsSetupBean)
056     */
057    @Override
058    public boolean validate(CmsSetupBean setupBean) throws Exception {
059
060        return CmsStringUtil.isNotEmptyOrWhitespaceOnly(getCodeToChange(setupBean));
061    }
062
063    /**
064     * @see org.opencms.setup.xml.A_CmsSetupXmlUpdate#executeUpdate(org.dom4j.Document, java.lang.String, boolean)
065     */
066    @Override
067    protected boolean executeUpdate(Document document, String xpath, boolean forReal) {
068
069        if (!forReal) {
070            return true;
071        }
072        Element parentNode = (Element)document.selectSingleNode(getCommonPath());
073        Node translationNode = parentNode.selectSingleNode("/translation[text()='s#-+#-#g']");
074        if (translationNode == null) {
075            Element newElement = parentNode.addElement("translation");
076            newElement.setText("s#-+#-#g");
077            return true;
078        } else {
079            return false;
080        }
081    }
082
083    /**
084     * @see org.opencms.setup.xml.A_CmsSetupXmlUpdate#getCommonPath()
085     */
086    @Override
087    protected String getCommonPath() {
088
089        return "/opencms/vfs/translations/filetranslations";
090    }
091
092    /**
093     * @see org.opencms.setup.xml.A_CmsSetupXmlUpdate#getXPathsToUpdate()
094     */
095    @Override
096    protected List<String> getXPathsToUpdate() {
097
098        return Collections.singletonList(getCommonPath());
099    }
100
101}