View Javadoc
1   /*
2    * Copyright (C) 2008-2009, Google Inc.
3    * Copyright (C) 2008, Shawn O. Pearce <spearce@spearce.org>
4    * and other copyright owners as documented in the project's IP log.
5    *
6    * This program and the accompanying materials are made available
7    * under the terms of the Eclipse Distribution License v1.0 which
8    * accompanies this distribution, is reproduced below, and is
9    * available at http://www.eclipse.org/org/documents/edl-v10.php
10   *
11   * All rights reserved.
12   *
13   * Redistribution and use in source and binary forms, with or
14   * without modification, are permitted provided that the following
15   * conditions are met:
16   *
17   * - Redistributions of source code must retain the above copyright
18   *   notice, this list of conditions and the following disclaimer.
19   *
20   * - Redistributions in binary form must reproduce the above
21   *   copyright notice, this list of conditions and the following
22   *   disclaimer in the documentation and/or other materials provided
23   *   with the distribution.
24   *
25   * - Neither the name of the Eclipse Foundation, Inc. nor the
26   *   names of its contributors may be used to endorse or promote
27   *   products derived from this software without specific prior
28   *   written permission.
29   *
30   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
31   * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
32   * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
33   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
34   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
35   * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
36   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
37   * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
38   * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
39   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
40   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
41   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
42   * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
43   */
44  
45  package org.eclipse.jgit.pgm.opt;
46  
47  import java.io.File;
48  import java.io.IOException;
49  import java.text.MessageFormat;
50  
51  import org.eclipse.jgit.dircache.DirCache;
52  import org.eclipse.jgit.dircache.DirCacheIterator;
53  import org.eclipse.jgit.errors.IncorrectObjectTypeException;
54  import org.eclipse.jgit.errors.MissingObjectException;
55  import org.eclipse.jgit.lib.ObjectId;
56  import org.eclipse.jgit.lib.ObjectReader;
57  import org.eclipse.jgit.pgm.internal.CLIText;
58  import org.eclipse.jgit.treewalk.AbstractTreeIterator;
59  import org.eclipse.jgit.treewalk.CanonicalTreeParser;
60  import org.eclipse.jgit.treewalk.FileTreeIterator;
61  import org.eclipse.jgit.treewalk.WorkingTreeOptions;
62  import org.eclipse.jgit.util.FS;
63  import org.kohsuke.args4j.CmdLineException;
64  import org.kohsuke.args4j.CmdLineParser;
65  import org.kohsuke.args4j.OptionDef;
66  import org.kohsuke.args4j.spi.OptionHandler;
67  import org.kohsuke.args4j.spi.Parameters;
68  import org.kohsuke.args4j.spi.Setter;
69  
70  /**
71   * Custom argument handler
72   * {@link org.eclipse.jgit.treewalk.AbstractTreeIterator} from string values.
73   * <p>
74   * Assumes the parser has been initialized with a Repository.
75   */
76  public class AbstractTreeIteratorHandler extends
77  		OptionHandler<AbstractTreeIterator> {
78  	private final org.eclipse.jgit.pgm.opt.CmdLineParser clp;
79  
80  	/**
81  	 * Create a new handler for the command name.
82  	 * <p>
83  	 * This constructor is used only by args4j.
84  	 *
85  	 * @param parser
86  	 *            a {@link org.kohsuke.args4j.CmdLineParser} object.
87  	 * @param option
88  	 *            a {@link org.kohsuke.args4j.OptionDef} object.
89  	 * @param setter
90  	 *            a {@link org.kohsuke.args4j.spi.Setter} object.
91  	 */
92  	public AbstractTreeIteratorHandler(final CmdLineParser parser,
93  			final OptionDef option,
94  			final Setter<? super AbstractTreeIterator> setter) {
95  		super(parser, option, setter);
96  		clp = (org.eclipse.jgit.pgm.opt.CmdLineParser) parser;
97  	}
98  
99  	/** {@inheritDoc} */
100 	@Override
101 	public int parseArguments(Parameters params) throws CmdLineException {
102 		final String name = params.getParameter(0);
103 
104 		if (new File(name).isDirectory()) {
105 			setter.addValue(new FileTreeIterator(
106 				new File(name),
107 				FS.DETECTED,
108 				clp.getRepository().getConfig().get(WorkingTreeOptions.KEY)));
109 			return 1;
110 		}
111 
112 		if (new File(name).isFile()) {
113 			final DirCache dirc;
114 			try {
115 				dirc = DirCache.read(new File(name), FS.DETECTED);
116 			} catch (IOException e) {
117 				throw new CmdLineException(clp, MessageFormat.format(CLIText.get().notAnIndexFile, name), e);
118 			}
119 			setter.addValue(new DirCacheIterator(dirc));
120 			return 1;
121 		}
122 
123 		final ObjectId id;
124 		try {
125 			id = clp.getRepository().resolve(name);
126 		} catch (IOException e) {
127 			throw new CmdLineException(clp, CLIText.format(e.getMessage()));
128 		}
129 		if (id == null)
130 			throw new CmdLineException(clp,
131 					CLIText.format(CLIText.get().notATree), name);
132 
133 		final CanonicalTreeParseralTreeParser.html#CanonicalTreeParser">CanonicalTreeParser p = new CanonicalTreeParser();
134 		try (ObjectReader curs = clp.getRepository().newObjectReader()) {
135 			p.reset(curs, clp.getRevWalk().parseTree(id));
136 		} catch (MissingObjectException | IncorrectObjectTypeException e) {
137 			throw new CmdLineException(clp,
138 					CLIText.format(CLIText.get().notATree), name);
139 		} catch (IOException e) {
140 			throw new CmdLineException(clp,
141 					CLIText.format(CLIText.get().cannotReadBecause), name,
142 					e.getMessage());
143 		}
144 
145 		setter.addValue(p);
146 		return 1;
147 	}
148 
149 	/** {@inheritDoc} */
150 	@Override
151 	public String getDefaultMetaVariable() {
152 		return CLIText.get().metaVar_treeish;
153 	}
154 }