Search.java revision 3dc379d98a11243103242e2b43b1ab1322795b7e
893N/A/*
2362N/A * CDDL HEADER START
893N/A *
893N/A * The contents of this file are subject to the terms of the
893N/A * Common Development and Distribution License (the "License").
893N/A * You may not use this file except in compliance with the License.
2362N/A *
893N/A * See LICENSE.txt included in this distribution for the specific
2362N/A * language governing permissions and limitations under the License.
893N/A *
893N/A * When distributing Covered Code, include this CDDL HEADER in each
893N/A * file and include the License file at LICENSE.txt.
893N/A * If applicable, add the following below this CDDL HEADER, with the
893N/A * fields enclosed by brackets "[]" replaced with your own identifying
893N/A * information: Portions Copyright [yyyy] [name of copyright owner]
893N/A *
893N/A * CDDL HEADER END
893N/A */
893N/A
893N/A/*
2362N/A * Copyright (c) 2008, 2014, Oracle and/or its affiliates. All rights reserved.
2362N/A */
2362N/Apackage org.opensolaris.opengrok.search;
893N/A
893N/Aimport java.io.BufferedReader;
893N/Aimport java.io.File;
893N/Aimport java.io.IOException;
893N/Aimport java.io.InputStreamReader;
893N/Aimport java.text.ParseException;
893N/Aimport java.util.ArrayList;
893N/Aimport java.util.List;
893N/Aimport org.opensolaris.opengrok.configuration.RuntimeEnvironment;
893N/Aimport org.opensolaris.opengrok.util.Getopt;
893N/A
893N/A/**
893N/A * Search and list the matching files
893N/A */
893N/A@SuppressWarnings({"PMD.AvoidPrintStackTrace", "PMD.SystemPrintln"})
893N/Afinal class Search {
893N/A
893N/A private static final String usage = "USAGE: Search -R <configuration.xml> [-d | -r | -p | -h | -f | -t] 'query string' ..\n" +
893N/A "\t -R <configuration.xml> Read configuration from the specified file\n" +
893N/A "\t -d Symbol Definitions\n" +
893N/A "\t -r Symbol References\n" +
893N/A "\t -p Path\n" +
893N/A "\t -h History\n" +
893N/A "\t -f Full text\n" +
893N/A "\t -t Type";
893N/A
893N/A private SearchEngine engine;
893N/A final List<Hit> results = new ArrayList<>();
893N/A int totalResults =0;
893N/A int nhits=0;
893N/A
893N/A @SuppressWarnings({"PMD.SwitchStmtsShouldHaveDefault"})
893N/A protected boolean parseCmdLine(String[] argv) {
893N/A engine = new SearchEngine();
893N/A Getopt getopt = new Getopt(argv, "R:d:r:p:h:f:t:");
893N/A try {
893N/A getopt.parse();
893N/A } catch (ParseException e) {
893N/A System.err.println(e.getMessage());
893N/A System.err.println(usage);
893N/A return false;
893N/A }
893N/A
893N/A int cmd;
893N/A while ((cmd = getopt.getOpt()) != -1) {
893N/A switch (cmd) {
893N/A case 'R':
893N/A try {
893N/A RuntimeEnvironment.getInstance().readConfiguration(new File(getopt.getOptarg()));
893N/A } catch (IOException e) {
893N/A System.err.println("Failed to read config file: ");
893N/A System.err.println(e.getMessage());
893N/A return false;
893N/A }
893N/A break;
893N/A case 'd':
893N/A engine.setDefinition(getopt.getOptarg());
893N/A break;
893N/A case 'r':
893N/A engine.setSymbol(getopt.getOptarg());
893N/A break;
893N/A case 'p':
893N/A engine.setFile(getopt.getOptarg());
893N/A break;
893N/A case 'h':
893N/A engine.setHistory(getopt.getOptarg());
893N/A break;
893N/A case 'f':
893N/A engine.setFreetext(getopt.getOptarg());
893N/A break;
893N/A case 't':
893N/A engine.setType(getopt.getOptarg());
893N/A break;
893N/A }
893N/A }
893N/A
893N/A return true;
893N/A }
893N/A
893N/A protected boolean search() {
893N/A if (RuntimeEnvironment.getInstance().getDataRootPath() == null) {
893N/A System.err.println("You must specify a configuration file");
893N/A System.err.println(usage);
893N/A return false;
893N/A }
893N/A
893N/A if (engine == null || !engine.isValidQuery()) {
893N/A System.err.println("You did not specify a valid query");
893N/A System.err.println(usage);
893N/A return false;
893N/A }
893N/A
893N/A results.clear();
893N/A nhits = engine.search();
893N/A if (nhits > 0) {
893N/A engine.results(0, nhits, results);
893N/A }
893N/A totalResults = engine.totalHits;
893N/A
893N/A return true;
893N/A }
893N/A
893N/A protected void dumpResults() {
893N/A if (results.isEmpty()) {
893N/A System.err.println("Your search \"" + engine.getQuery() + "\" did not match any files.");
893N/A } else {
893N/A String root = RuntimeEnvironment.getInstance().getSourceRootPath();
893N/A System.out.println("Printing results 1 - " + nhits +" of " + totalResults + " total matching documents collected.");
893N/A for (Hit hit : results) {
893N/A File file = new File(root, hit.getPath());
893N/A System.out.println(file.getAbsolutePath() + ":"+hit.getLineno()+" [" + hit.getLine() + "]");
893N/A }
893N/A
893N/A if (nhits<totalResults) {
893N/A System.out.println("Printed results 1 - " + nhits +" of " + totalResults + " total matching documents collected.");
893N/A System.out.println("Collect the rest (y/n) ?");
893N/A BufferedReader in;
893N/A try {
893N/A in = new BufferedReader(new InputStreamReader(System.in, "UTF-8"));
893N/A String line = in.readLine();
893N/A if (null == line || line.length() == 0 || line.charAt(0) == 'n') {
893N/A return;
893N/A }
893N/A } catch (IOException ex) {
893N/A System.err.println(ex.getMessage());
893N/A }
893N/A engine.results(nhits, totalResults, results);
893N/A for (Hit hit : results) {
893N/A File file = new File(root, hit.getPath());
893N/A System.out.println(file.getAbsolutePath() + ":"+hit.getLineno()+" [" + hit.getLine() + "]");
893N/A }
893N/A }
893N/A }
893N/A }
893N/A
893N/A /**
893N/A * usage Search index "query" prune path
893N/A * @param argv command line arguments
893N/A */
893N/A public static void main(String[] argv) {
893N/A Search searcher = new Search();
893N/A boolean success = false;
893N/A
893N/A if (searcher.parseCmdLine(argv) && searcher.search()) {
893N/A success = true;
893N/A searcher.dumpResults();
893N/A }
893N/A
893N/A if (!success) {
893N/A System.exit(1);
893N/A }
893N/A }
893N/A}