/* * The contents of this file are subject to the terms of the Common Development and * Distribution License (the License). You may not use this file except in compliance with the * License. * * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the * specific language governing permission and limitations under the License. * * When distributing Covered Software, include this CDDL Header Notice in each file and include * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL * Header, with the fields enclosed by brackets [] replaced by your own identifying * information: "Portions Copyright [year] [name of copyright owner]". * * Copyright 2012-2016 ForgeRock AS. */ package com.forgerock.opendj.ldap.tools; import static com.forgerock.opendj.cli.ArgumentConstants.*; import static com.forgerock.opendj.cli.ToolVersionHandler.newSdkVersionHandler; import static com.forgerock.opendj.ldap.tools.LDAPToolException.newToolParamException; import static com.forgerock.opendj.ldap.tools.ToolsMessages.*; import static com.forgerock.opendj.cli.Utils.filterExitCode; import static com.forgerock.opendj.cli.CommonArguments.*; import static com.forgerock.opendj.ldap.tools.Utils.getLDIFToolInputStream; import static com.forgerock.opendj.ldap.tools.Utils.getLDIFToolOutputStream; import static com.forgerock.opendj.ldap.tools.Utils.parseArguments; import static com.forgerock.opendj.ldap.tools.Utils.readFiltersFromFile; import static com.forgerock.opendj.ldap.tools.Utils.readFilterFromString; import java.io.IOException; import java.util.LinkedList; import java.util.List; import org.forgerock.i18n.LocalizableException; import org.forgerock.i18n.LocalizableMessage; import org.forgerock.i18n.LocalizedIllegalArgumentException; import org.forgerock.opendj.ldap.DN; import org.forgerock.opendj.ldap.Filter; import org.forgerock.opendj.ldap.ResultCode; import org.forgerock.opendj.ldap.SearchScope; import org.forgerock.opendj.ldap.requests.Requests; import org.forgerock.opendj.ldap.requests.SearchRequest; import org.forgerock.opendj.ldif.LDIF; import org.forgerock.opendj.ldif.LDIFEntryReader; import org.forgerock.opendj.ldif.LDIFEntryWriter; import com.forgerock.opendj.cli.ArgumentException; import com.forgerock.opendj.cli.ArgumentParser; import com.forgerock.opendj.cli.BooleanArgument; import com.forgerock.opendj.cli.ConsoleApplication; import com.forgerock.opendj.cli.IntegerArgument; import com.forgerock.opendj.cli.MultiChoiceArgument; import com.forgerock.opendj.cli.StringArgument; /** This utility can be used to perform search operations against data in an LDIF file. */ public final class LDIFSearch extends ConsoleApplication { /** * The main method for LDIFSearch tool. * * @param args * The command-line arguments provided to this program. */ public static void main(final String[] args) { final LDIFSearch ldifSearch = new LDIFSearch(); int retCode; try { retCode = ldifSearch.run(args); } catch (final LDAPToolException e) { e.printErrorMessage(ldifSearch); retCode = e.getResultCode(); } System.exit(filterExitCode(retCode)); } private LDIFSearch() { // Nothing to do. } private int run(final String[] args) throws LDAPToolException { /* Create the command-line argument parser for use with this program. */ final LocalizableMessage toolDescription = INFO_LDIFSEARCH_TOOL_DESCRIPTION.get(); final ArgumentParser argParser = LDAPToolArgumentParser.builder(LDIFSearch.class.getName()) .toolDescription(toolDescription) .trailingArgumentsUnbounded(1, "source [filter] [attributes ...]") .build(); argParser.setVersionHandler(newSdkVersionHandler()); argParser.setShortToolDescription(REF_SHORT_DESC_LDIFSEARCH.get()); final BooleanArgument showUsage; final StringArgument outputFilename; final BooleanArgument typesOnly; final IntegerArgument timeLimit; final StringArgument filterFile; final StringArgument baseDN; final MultiChoiceArgument searchScope; final IntegerArgument sizeLimit; try { outputFilename = StringArgument.builder(OPTION_LONG_OUTPUT_LDIF_FILENAME) .shortIdentifier(OPTION_SHORT_OUTPUT_LDIF_FILENAME) .description(INFO_LDIFSEARCH_DESCRIPTION_OUTPUT_FILENAME.get( INFO_OUTPUT_LDIF_FILE_PLACEHOLDER.get())) .defaultValue("stdout") .valuePlaceholder(INFO_OUTPUT_LDIF_FILE_PLACEHOLDER.get()) .buildAndAddToParser(argParser); baseDN = StringArgument.builder(OPTION_LONG_BASEDN) .shortIdentifier(OPTION_SHORT_BASEDN) .description(INFO_SEARCH_DESCRIPTION_BASEDN.get()) .required() .valuePlaceholder(INFO_BASEDN_PLACEHOLDER.get()) .buildAndAddToParser(argParser); searchScope = searchScopeArgument(); argParser.addArgument(searchScope); filterFile = filenameArgument(INFO_SEARCH_DESCRIPTION_FILENAME.get()); argParser.addArgument(filterFile); typesOnly = BooleanArgument.builder("typesOnly") .shortIdentifier('A') .description(INFO_DESCRIPTION_TYPES_ONLY.get()) .buildAndAddToParser(argParser); sizeLimit = IntegerArgument.builder("sizeLimit") .shortIdentifier('z') .description(INFO_SEARCH_DESCRIPTION_SIZE_LIMIT.get()) .defaultValue(0) .valuePlaceholder(INFO_SIZE_LIMIT_PLACEHOLDER.get()) .buildAndAddToParser(argParser); timeLimit = IntegerArgument.builder("timeLimit") .shortIdentifier('l') .description(INFO_SEARCH_DESCRIPTION_TIME_LIMIT.get()) .defaultValue(0) .valuePlaceholder(INFO_TIME_LIMIT_PLACEHOLDER.get()) .buildAndAddToParser(argParser); showUsage = showUsageArgument(); argParser.addArgument(showUsage); argParser.setUsageArgument(showUsage, getOutputStream()); } catch (final ArgumentException ae) { throw newToolParamException(ae, ERR_CANNOT_INITIALIZE_ARGS.get(ae.getMessage())); } parseArguments(argParser, getErrorStream(), args); if (argParser.usageOrVersionDisplayed()) { return ResultCode.SUCCESS.intValue(); } final List filters = new LinkedList<>(); final List attributes = new LinkedList<>(); final List trailingArguments = argParser.getTrailingArguments(); if (trailingArguments.size() > 1) { final List filterAndAttributeStrings = trailingArguments.subList(1, trailingArguments.size()); // If filter file is not present, the first trailing argument is considered the filter if (!filterFile.isPresent()) { filters.add(readFilterFromString(filterAndAttributeStrings.remove(0))); } // The rest of trailing argument are attributes attributes.addAll(filterAndAttributeStrings); } if (filterFile.isPresent()) { filters.addAll(readFiltersFromFile(filterFile.getValue())); } if (filters.isEmpty()) { argParser.displayMessageAndUsageReference(getErrStream(), ERR_SEARCH_NO_FILTERS.get()); return ResultCode.CLIENT_SIDE_PARAM_ERROR.intValue(); } final SearchRequest search; try { final SearchScope scope = searchScope.getTypedValue(); search = Requests.newSearchRequest(DN.valueOf(baseDN.getValue()), scope, filters.get(0), attributes.toArray(new String[attributes.size()])).setTypesOnly( typesOnly.isPresent()).setTimeLimit(timeLimit.getIntValue()) .setSizeLimit(sizeLimit.getIntValue()); } catch (final ArgumentException | LocalizedIllegalArgumentException e) { throw newToolParamException(e, e.getMessageObject()); } try (final LDIFEntryReader sourceReader = new LDIFEntryReader(getLDIFToolInputStream(this, trailingArguments.get(0))); final LDIFEntryWriter outputWriter = new LDIFEntryWriter(getLDIFToolOutputStream(this, outputFilename))) { LDIF.copyTo(LDIF.search(sourceReader, search), outputWriter); } catch (final IOException e) { if (e instanceof LocalizableException) { errPrintln(ERR_LDIFSEARCH_FAILED.get(((LocalizableException) e).getMessageObject())); } else { errPrintln(ERR_LDIFSEARCH_FAILED.get(e.getLocalizedMessage())); } return ResultCode.CLIENT_SIDE_LOCAL_ERROR.intValue(); } return ResultCode.SUCCESS.intValue(); } }