1 /*
2 * Copyright (C) 2011, Christian Halstrick <christian.halstrick@sap.com>
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.api;
44
45 import java.io.IOException;
46 import java.util.LinkedList;
47 import java.util.List;
48
49 import org.eclipse.jgit.api.errors.GitAPIException;
50 import org.eclipse.jgit.api.errors.JGitInternalException;
51 import org.eclipse.jgit.errors.NoWorkTreeException;
52 import org.eclipse.jgit.lib.Constants;
53 import org.eclipse.jgit.lib.IndexDiff;
54 import org.eclipse.jgit.lib.ProgressMonitor;
55 import org.eclipse.jgit.lib.Repository;
56 import org.eclipse.jgit.submodule.SubmoduleWalk.IgnoreSubmoduleMode;
57 import org.eclipse.jgit.treewalk.FileTreeIterator;
58 import org.eclipse.jgit.treewalk.WorkingTreeIterator;
59 import org.eclipse.jgit.treewalk.filter.PathFilterGroup;
60
61 /**
62 * A class used to execute a {@code Status} command. It has setters for all
63 * supported options and arguments of this command and a {@link #call()} method
64 * to finally execute the command. Each instance of this class should only be
65 * used for one invocation of the command (means: one call to {@link #call()})
66 *
67 * @see <a
68 * href="http://www.kernel.org/pub/software/scm/git/docs/git-status.html"
69 * >Git documentation about Status</a>
70 */
71 public class StatusCommand extends GitCommand<Status> {
72 private WorkingTreeIterator workingTreeIt;
73 private List<String> paths = null;
74 private ProgressMonitor progressMonitor = null;
75
76 private IgnoreSubmoduleMode ignoreSubmoduleMode = null;
77
78 /**
79 * @param repo
80 */
81 protected StatusCommand(Repository repo) {
82 super(repo);
83 }
84
85 /**
86 * @param mode
87 * @return {@code this}
88 * @since 3.6
89 */
90 public StatusCommand setIgnoreSubmodules(IgnoreSubmoduleMode mode) {
91 ignoreSubmoduleMode = mode;
92 return this;
93 }
94
95 /**
96 * Show only the status of files which match the given paths. The path must
97 * either name a file or a directory exactly. All paths are always relative
98 * to the repository root. If a directory is specified all files recursively
99 * underneath that directory are matched. If this method is called multiple
100 * times then the status of those files is reported which match at least one
101 * of the given paths. Note that regex expressions or wildcards are not
102 * supported.
103 *
104 * @param path
105 * repository-relative path of file/directory to show status for
106 * (with <code>/</code> as separator)
107 * @return {@code this}
108 * @since 3.1
109 */
110 public StatusCommand addPath(String path) {
111 if (paths == null)
112 paths = new LinkedList<String>();
113 paths.add(path);
114 return this;
115 }
116
117 /**
118 * Returns the paths filtering this status.
119 *
120 * @return the paths for which the status is shown or <code>null</code> if
121 * the complete status for the whole repo is shown.
122 * @since 3.1
123 */
124 public List<String> getPaths() {
125 return paths;
126 }
127
128 /**
129 * Executes the {@code Status} command with all the options and parameters
130 * collected by the setter methods of this class. Each instance of this
131 * class should only be used for one invocation of the command. Don't call
132 * this method twice on an instance.
133 *
134 * @return a {@link Status} object telling about each path where working
135 * tree, index or HEAD differ from each other.
136 */
137 public Status call() throws GitAPIException, NoWorkTreeException {
138 if (workingTreeIt == null)
139 workingTreeIt = new FileTreeIterator(repo);
140
141 try {
142 IndexDiff diff = new IndexDiff(repo, Constants.HEAD, workingTreeIt);
143 if (ignoreSubmoduleMode != null)
144 diff.setIgnoreSubmoduleMode(ignoreSubmoduleMode);
145 if (paths != null)
146 diff.setFilter(PathFilterGroup.createFromStrings(paths));
147 if (progressMonitor == null)
148 diff.diff();
149 else
150 diff.diff(progressMonitor, ProgressMonitor.UNKNOWN,
151 ProgressMonitor.UNKNOWN, ""); //$NON-NLS-1$
152 return new Status(diff);
153 } catch (IOException e) {
154 throw new JGitInternalException(e.getMessage(), e);
155 }
156 }
157
158 /**
159 * To set the {@link WorkingTreeIterator} which should be used. If this
160 * method is not called a standard {@link FileTreeIterator} is used.
161 *
162 * @param workingTreeIt
163 * a working tree iterator
164 * @return {@code this}
165 */
166 public StatusCommand setWorkingTreeIt(WorkingTreeIterator workingTreeIt) {
167 this.workingTreeIt = workingTreeIt;
168 return this;
169 }
170
171 /**
172 * To set the {@link ProgressMonitor} which contains callback methods to
173 * inform you about the progress of this command.
174 *
175 * @param progressMonitor
176 * @return {@code this}
177 * @since 3.1
178 */
179 public StatusCommand setProgressMonitor(ProgressMonitor progressMonitor) {
180 this.progressMonitor = progressMonitor;
181 return this;
182 }
183 }