1 /*
2 * Copyright (C) 2018, Salesforce.
3 * and other copyright owners as documented in the project's IP log.
4 *
5 * This program and the accompanying materials are made available
6 * under the terms of the Eclipse Distribution License v1.0 which
7 * accompanies this distribution, is reproduced below, and is
8 * available at http://www.eclipse.org/org/documents/edl-v10.php
9 *
10 * All rights reserved.
11 *
12 * Redistribution and use in source and binary forms, with or
13 * without modification, are permitted provided that the following
14 * conditions are met:
15 *
16 * - Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 *
19 * - Redistributions in binary form must reproduce the above
20 * copyright notice, this list of conditions and the following
21 * disclaimer in the documentation and/or other materials provided
22 * with the distribution.
23 *
24 * - Neither the name of the Eclipse Foundation, Inc. nor the
25 * names of its contributors may be used to endorse or promote
26 * products derived from this software without specific prior
27 * written permission.
28 *
29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
30 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
31 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
32 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
34 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
35 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
36 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
37 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
38 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42 */
43 package org.eclipse.jgit.pgm.opt;
44
45 import org.kohsuke.args4j.CmdLineException;
46 import org.kohsuke.args4j.CmdLineParser;
47 import org.kohsuke.args4j.OptionDef;
48 import org.kohsuke.args4j.spi.Parameters;
49 import org.kohsuke.args4j.spi.Setter;
50 import org.kohsuke.args4j.spi.StringOptionHandler;
51
52 /**
53 * Special handler for the <code>--gpg-sign</code> option of the
54 * <code>commit</code> command.
55 *
56 * The following rules apply:
57 * <ul>
58 * <li>If no key is given, i.e. just <code>--gpg-sign</code> is passed, then it
59 * is the same as <code>--gpg-sign=default</code></li>
60 * </ul>
61 *
62 * @since 5.3
63 */
64 public class GpgSignHandler extends StringOptionHandler {
65
66 /**
67 * The value "default" which will be used when just the option is specified
68 * without any argument
69 */
70 public static final String DEFAULT = "default"; //$NON-NLS-1$
71
72 /**
73 * <p>
74 * Constructor for GpgSignHandler.
75 * </p>
76 *
77 * @param parser
78 * The parser to which this handler belongs.
79 * @param option
80 * The annotation.
81 * @param setter
82 * Object to be used for setting value.
83 */
84 public GpgSignHandler(CmdLineParser parser, OptionDef option,
85 Setter<? super String> setter) {
86 super(parser, option, setter);
87 }
88
89 /** {@inheritDoc} */
90 @Override
91 public int parseArguments(Parameters params) throws CmdLineException {
92 String alias = params.getParameter(-1);
93 if ("--gpg-sign".equals(alias) || "-S".equals(alias)) { //$NON-NLS-1$ //$NON-NLS-2$
94 try {
95 String key = params.getParameter(0);
96 if (key == null || key.startsWith("-")) { //$NON-NLS-1$
97 // ignore invalid values and assume default
98 setter.addValue(DEFAULT);
99 return 0;
100 }
101
102 // use what we have
103 setter.addValue(key);
104 return 1;
105 } catch (CmdLineException e) {
106 // no additional value, assume default
107 setter.addValue(DEFAULT);
108 return 0;
109 }
110 }
111 return 0;
112 }
113
114 }