Line data    Source code

       1             : // Copyright (C) 2013 The Android Open Source Project
       2             : //
       3             : // Licensed under the Apache License, Version 2.0 (the "License");
       4             : // you may not use this file except in compliance with the License.
       5             : // You may obtain a copy of the License at
       6             : //
       7             : // http://www.apache.org/licenses/LICENSE-2.0
       8             : //
       9             : // Unless required by applicable law or agreed to in writing, software
      10             : // distributed under the License is distributed on an "AS IS" BASIS,
      11             : // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      12             : // See the License for the specific language governing permissions and
      13             : // limitations under the License.
      14             : 
      15             : package com.google.gerrit.sshd.commands;
      16             : 
      17             : import static com.google.gerrit.sshd.CommandMetaData.Mode.MASTER_OR_SLAVE;
      18             : 
      19             : import com.google.gerrit.server.config.CanonicalWebUrl;
      20             : import com.google.gerrit.server.documentation.QueryDocumentationExecutor;
      21             : import com.google.gerrit.server.documentation.QueryDocumentationExecutor.DocQueryException;
      22             : import com.google.gerrit.server.documentation.QueryDocumentationExecutor.DocResult;
      23             : import com.google.gerrit.sshd.CommandMetaData;
      24             : import com.google.gerrit.sshd.SshCommand;
      25             : import com.google.inject.Inject;
      26             : import java.util.List;
      27             : import org.kohsuke.args4j.Argument;
      28             : 
      29             : @CommandMetaData(
      30             :     name = "apropos",
      31             :     description = "Search in Gerrit documentation",
      32             :     runsAt = MASTER_OR_SLAVE)
      33           1 : final class AproposCommand extends SshCommand {
      34             :   @Inject private QueryDocumentationExecutor searcher;
      35             :   @Inject @CanonicalWebUrl String url;
      36             : 
      37             :   @Argument(index = 0, required = true, metaVar = "QUERY")
      38             :   private String q;
      39             : 
      40             :   @Override
      41             :   public void run() throws Exception {
      42           0 :     enableGracefulStop();
      43             :     try {
      44           0 :       List<QueryDocumentationExecutor.DocResult> res = searcher.doQuery(q);
      45           0 :       for (DocResult docResult : res) {
      46           0 :         stdout.println(String.format("%s:\n%s%s\n", docResult.title, url, docResult.url));
      47           0 :       }
      48           0 :     } catch (DocQueryException dqe) {
      49           0 :       throw die(dqe);
      50           0 :     }
      51           0 :   }
      52             : }