org.opencms.setup.xml.v8.CmsXmlAddSolrSearch Maven / Gradle / Ivy
Show all versions of opencms-test Show documentation
/*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (c) Alkacon Software GmbH & Co. KG (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 & Co. KG, 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.v8;
import org.opencms.setup.xml.A_CmsXmlSearch;
import java.util.Collections;
import java.util.List;
import org.dom4j.Attribute;
import org.dom4j.Document;
import org.dom4j.DocumentException;
import org.dom4j.Element;
/**
* Adds the solr search node.
*
* @since 8.0.0
*/
public class CmsXmlAddSolrSearch extends A_CmsXmlSearch {
/**
* @see org.opencms.setup.xml.CmsXmlUpdateAction#executeUpdate(org.dom4j.Document, java.lang.String, boolean)
*/
@SuppressWarnings("unchecked")
@Override
public boolean executeUpdate(Document doc, String xpath, boolean forReal) {
Element node = (Element)doc.selectSingleNode("/opencms/search");
if (node.selectSingleNode("solr") == null) {
String solrComment = " To enable Solr in OpenCms you must create a solr/ home\n"
+ " directory in the WEB-INF folder of your OpenCms application.\n"
+ " Copy the solr/ folder from the OpenCms standard distribution\n"
+ " as a starting point for your configuration. ";
try {
Element solrElement = createElementFromXml(" ");
solrElement.addComment(solrComment);
node.elements().add(0, solrElement);
} catch (DocumentException e) {
System.out.println("Could not add solr node");
return false;
}
} else {
String solrComment = "\n"
+ " During the update Solr will be disabled in the WEB-INF/config/opencms-search.xml.\n"
+ " To update Solr you must update the 'schema.xml and' the 'solrconfig.xml' manually.\n"
+ " The new default configuration files are located in the solr-update/ directory in\n"
+ " the WEB-INF folder of your application. If you are using the default configuration\n"
+ " from the distribution, it is sufficient to copy the new configuration files to the\n"
+ " WEB-INF/solr folder. Else if you have customized the Solr configuration you might\n"
+ " want to merge the 'schema.xml' and the 'solrconfig.xml' first. When you are done\n"
+ " set the attribute enabled to 'true' again.\n";
Element solrElement = (Element)node.selectSingleNode("solr");
Attribute a = solrElement.attribute("enabled");
if (a != null) {
a.setValue("false");
}
solrElement.addComment(solrComment);
}
try {
tryToAddMissingElement(
doc,
"//index[name='Solr Offline']",
"//indexes",
"\n"
+ " Solr Offline \n"
+ " offline \n"
+ " Offline \n"
+ " all \n"
+ " solr_fields \n"
+ " \n"
+ " \n"
+ " \n"
+ " org.opencms.search.solr.CmsSolrLinkProcessor\n"
+ " ");
tryToAddMissingElement(
doc,
"//index[name='Solr Online']",
"//indexes",
"\n"
+ " Solr Online \n"
+ " auto \n"
+ " Online \n"
+ " all \n"
+ " solr_fields \n"
+ " \n"
+ " \n"
+ " \n"
+ " org.opencms.search.solr.CmsSolrLinkProcessor\n"
+ " ");
Element solrSource = (Element)(doc.selectSingleNode("//indexsource[name='solr_source']"));
// will be added again in next step
if (solrSource != null) {
solrSource.detach();
}
tryToAddMissingElement(
doc,
"//indexsource[name='solr_source']",
"//indexsources",
"\n"
+ " solr_source \n"
+ " \n"
+ " \n"
+ " / \n"
+ " \n"
+ " \n"
+ " xmlcontent-solr \n"
+ " containerpage-solr \n"
+ " xmlpage \n"
+ " text \n"
+ " jsp \n"
+ " pdf \n"
+ " rtf \n"
+ " html \n"
+ " image \n"
+ " generic \n"
+ " msoffice-ole2 \n"
+ " msoffice-ooxml \n"
+ " openoffice \n"
+ " \n"
+ " ");
tryToAddMissingElement(
doc,
"//fieldconfiguration[name='solr_fields']",
"//fieldconfigurations",
"\n"
+ " solr_fields \n"
+ " The Solr search index field configuration. \n"
+ " \n"
+ " ");
tryToAddMissingElement(
doc,
"//documenttype[name='xmlcontent-solr']",
"//documenttypes",
"\n"
+ " xmlcontent-solr \n"
+ " org.opencms.search.solr.CmsSolrDocumentXmlContent \n"
+ " \n"
+ " text/html \n"
+ " \n"
+ " \n"
+ " xmlcontent-solr \n"
+ " \n"
+ " ");
tryToAddMissingElement(
doc,
"//documenttype[name='containerpage-solr']",
"//documenttypes",
"\n"
+ " containerpage-solr \n"
+ " org.opencms.search.solr.CmsSolrDocumentContainerPage \n"
+ " \n"
+ " text/html \n"
+ " \n"
+ " \n"
+ " containerpage-solr \n"
+ " \n"
+ " ");
} catch (DocumentException e) {
e.printStackTrace();
}
return true;
}
/**
* @see org.opencms.setup.xml.I_CmsSetupXmlUpdate#getName()
*/
public String getName() {
return "Add the Solr configuration";
}
/**
* Adds an XML configuration element if it is missing.
*
* @param doc the document
* @param checkPath the xpath of the element
* @param parentPath the xpath of the parent to which the element should be added if it's not found
* @param xmlToAdd the XML of the element to add
*
* @throws DocumentException if something goes wrong
*/
public void tryToAddMissingElement(Document doc, String checkPath, String parentPath, String xmlToAdd)
throws DocumentException {
if (doc.selectSingleNode(checkPath) == null) {
Element parent = (Element)(doc.selectSingleNode(parentPath));
if (parent != null) {
parent.add(createElementFromXml(xmlToAdd));
} else {
System.err.println("Failed to add missing element: checkPath = " + checkPath);
}
}
}
/**
* @see org.opencms.setup.xml.A_CmsSetupXmlUpdate#getCommonPath()
*/
@Override
protected String getCommonPath() {
return "/opencms/search";
}
/**
* @see org.opencms.setup.xml.A_CmsSetupXmlUpdate#getXPathsToUpdate()
*/
@Override
protected List getXPathsToUpdate() {
return Collections.singletonList("/opencms/search");
}
}