anchela commented on a change in pull request #128: URL: https://github.com/apache/sling-org-apache-sling-feature-cpconverter/pull/128#discussion_r816745359
########## File path: src/main/java/org/apache/sling/feature/cpconverter/handlers/IndexDefinitionsEntryHandler.java ########## @@ -0,0 +1,129 @@ +/* + * 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.sling.feature.cpconverter.handlers; + +import java.io.IOException; +import java.io.InputStream; +import java.util.Optional; + +import javax.jcr.RepositoryException; + +import org.apache.jackrabbit.util.Text; +import org.apache.jackrabbit.vault.fs.api.WorkspaceFilter; +import org.apache.jackrabbit.vault.fs.io.Archive; +import org.apache.jackrabbit.vault.fs.io.Archive.Entry; +import org.apache.jackrabbit.vault.fs.io.DocViewParser; +import org.apache.jackrabbit.vault.fs.io.DocViewParser.XmlParseException; +import org.apache.jackrabbit.vault.fs.io.DocViewParserHandler; +import org.apache.jackrabbit.vault.util.DocViewNode2; +import org.apache.jackrabbit.vault.util.PlatformNameFormat; +import org.apache.sling.feature.cpconverter.ContentPackage2FeatureModelConverter; +import org.apache.sling.feature.cpconverter.ConverterException; +import org.apache.sling.feature.cpconverter.index.IndexDefinitions; +import org.apache.sling.feature.cpconverter.index.IndexManager; +import org.jetbrains.annotations.NotNull; +import org.xml.sax.InputSource; + +/** + * Handler for Jackrabbit Oak index definitions + * + * <p>This implementation scans content packages for entries stored under <tt>/oak:index</tt> + * and exposes them to the {@link IndexManager} for further processing. + * + */ +public class IndexDefinitionsEntryHandler extends AbstractRegexEntryHandler { + + private final class IndexDefinitionsParserHandler implements DocViewParserHandler { + private final WorkspaceFilter filter; + private IndexDefinitions definitions; + + public IndexDefinitionsParserHandler(WorkspaceFilter filter, IndexDefinitions definitions) { + this.filter = filter; + this.definitions = definitions; + } + + @Override + public void startDocViewNode(@NotNull String nodePath, @NotNull DocViewNode2 docViewNode, + @NotNull Optional<DocViewNode2> parentDocViewNode, int line, int column) + throws IOException, RepositoryException { + + if ( nodePath.startsWith(IndexDefinitions.OAK_INDEX_PATH) && filter.contains(nodePath) ) { + definitions.addNode(Text.getRelativeParent(nodePath, 1), docViewNode); + } + } + + @Override + public void endDocViewNode(@NotNull String nodePath, @NotNull DocViewNode2 docViewNode, + @NotNull Optional<DocViewNode2> parentDocViewNode, int line, int column) + throws IOException, RepositoryException { + // nothing to do + } + + @Override + public void startPrefixMapping(String prefix, String uri) { + definitions.registerPrefixMapping(prefix, uri); + } + } + + public IndexDefinitionsEntryHandler() { + super("/jcr_root/" + PlatformNameFormat.getPlatformName(IndexDefinitions.OAK_INDEX_NAME)+ "/.*(/)?/*.xml"); + } + + @Override + public void handle(@NotNull String path, @NotNull Archive archive, @NotNull Entry entry, + @NotNull ContentPackage2FeatureModelConverter converter) throws IOException, ConverterException { + + IndexManager indexManager = converter.getIndexManager(); + if ( indexManager == null ) { + logger.info("{} not present, will skip index definition extraction", IndexManager.class.getName()); + } else { + try (InputStream is = archive.openInputStream(entry)) { + + String platformPath = path.replaceAll("^/jcr_root", "") + .replaceAll("/\\.content\\.xml$", "") + .replace(".dir", ""); + String repositoryPath = PlatformNameFormat.getRepositoryPath(platformPath); + InputSource inputSource = new InputSource(is); + + boolean isDocView = false; + // DocViewParser.isDocView closes the input stream it is passed + try ( InputStream isCheck = archive.openInputStream(entry) ) { + isDocView = DocViewParser.isDocView(new InputSource(isCheck)); + } + if ( isDocView ) { + DocViewParser parser = new DocViewParser(); + IndexDefinitionsParserHandler handler = new IndexDefinitionsParserHandler(archive.getMetaInf().getFilter(), indexManager.getIndexes()); + + parser.parse(repositoryPath, inputSource, handler); + + } else { + // binary file, should we attach? + if ( archive.getMetaInf().getFilter().contains(repositoryPath)) { + indexManager.getIndexes().registerBinary(repositoryPath, is); + } + } + + + } catch (XmlParseException e) { + throw new ConverterException("Failed parsing the index definitions", e); + } + } + + // TODO - is this the right way to keep the index entries in the content package? Review comment: yes, there are multiple variants of 'addEntry' but all are designed to make sure package entries end up in the converted content package. ########## File path: src/main/java/org/apache/sling/feature/cpconverter/handlers/IndexDefinitionsEntryHandler.java ########## @@ -0,0 +1,129 @@ +/* + * 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.sling.feature.cpconverter.handlers; + +import java.io.IOException; +import java.io.InputStream; +import java.util.Optional; + +import javax.jcr.RepositoryException; + +import org.apache.jackrabbit.util.Text; +import org.apache.jackrabbit.vault.fs.api.WorkspaceFilter; +import org.apache.jackrabbit.vault.fs.io.Archive; +import org.apache.jackrabbit.vault.fs.io.Archive.Entry; +import org.apache.jackrabbit.vault.fs.io.DocViewParser; +import org.apache.jackrabbit.vault.fs.io.DocViewParser.XmlParseException; +import org.apache.jackrabbit.vault.fs.io.DocViewParserHandler; +import org.apache.jackrabbit.vault.util.DocViewNode2; +import org.apache.jackrabbit.vault.util.PlatformNameFormat; +import org.apache.sling.feature.cpconverter.ContentPackage2FeatureModelConverter; +import org.apache.sling.feature.cpconverter.ConverterException; +import org.apache.sling.feature.cpconverter.index.IndexDefinitions; +import org.apache.sling.feature.cpconverter.index.IndexManager; +import org.jetbrains.annotations.NotNull; +import org.xml.sax.InputSource; + +/** + * Handler for Jackrabbit Oak index definitions + * + * <p>This implementation scans content packages for entries stored under <tt>/oak:index</tt> + * and exposes them to the {@link IndexManager} for further processing. + * + */ +public class IndexDefinitionsEntryHandler extends AbstractRegexEntryHandler { + + private final class IndexDefinitionsParserHandler implements DocViewParserHandler { + private final WorkspaceFilter filter; + private IndexDefinitions definitions; + + public IndexDefinitionsParserHandler(WorkspaceFilter filter, IndexDefinitions definitions) { + this.filter = filter; + this.definitions = definitions; + } + + @Override + public void startDocViewNode(@NotNull String nodePath, @NotNull DocViewNode2 docViewNode, + @NotNull Optional<DocViewNode2> parentDocViewNode, int line, int column) + throws IOException, RepositoryException { + + if ( nodePath.startsWith(IndexDefinitions.OAK_INDEX_PATH) && filter.contains(nodePath) ) { Review comment: index definitions can be located anywhere in the repository not just at /oak:index -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
