123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179 |
- /*
- * Copyright (C) 2008, Shawn O. Pearce <spearce@spearce.org>
- * and other copyright owners as documented in the project's IP log.
- *
- * This program and the accompanying materials are made available
- * under the terms of the Eclipse Distribution License v1.0 which
- * accompanies this distribution, is reproduced below, and is
- * available at http://www.eclipse.org/org/documents/edl-v10.php
- *
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or
- * without modification, are permitted provided that the following
- * conditions are met:
- *
- * - Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- *
- * - Redistributions in binary form must reproduce the above
- * copyright notice, this list of conditions and the following
- * disclaimer in the documentation and/or other materials provided
- * with the distribution.
- *
- * - Neither the name of the Eclipse Foundation, Inc. nor the
- * names of its contributors may be used to endorse or promote
- * products derived from this software without specific prior
- * written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
- * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
- * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
- * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
- * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
- * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
- * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
- * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
- * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
- * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
- * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
- package org.eclipse.jgit.util;
-
- import java.io.BufferedReader;
- import java.io.BufferedWriter;
- import java.io.File;
- import java.io.IOException;
- import java.io.InputStream;
- import java.io.InputStreamReader;
- import java.io.OutputStream;
- import java.io.OutputStreamWriter;
- import java.io.PrintStream;
- import java.io.PrintWriter;
- import java.nio.charset.Charset;
- import java.security.AccessController;
- import java.security.PrivilegedAction;
- import java.text.MessageFormat;
- import java.util.Arrays;
- import java.util.HashMap;
- import java.util.Map;
- import java.util.concurrent.Callable;
- import java.util.concurrent.ExecutorService;
- import java.util.concurrent.Executors;
- import java.util.concurrent.TimeUnit;
- import java.util.concurrent.atomic.AtomicBoolean;
-
- import org.eclipse.jgit.api.errors.JGitInternalException;
- import org.eclipse.jgit.errors.SymlinksNotSupportedException;
- import org.eclipse.jgit.internal.JGitText;
- import org.eclipse.jgit.lib.Constants;
- import org.eclipse.jgit.lib.Repository;
- import org.eclipse.jgit.util.ProcessResult.Status;
- import org.slf4j.Logger;
- import org.slf4j.LoggerFactory;
-
- /** Abstraction to support various file system operations not in Java. */
- public abstract class FS {
- /**
- * This class creates FS instances. It will be overridden by a Java7 variant
- * if such can be detected in {@link #detect(Boolean)}.
- *
- * @since 3.0
- */
- public static class FSFactory {
- /**
- * Constructor
- */
- protected FSFactory() {
- // empty
- }
-
- /**
- * Detect the file system
- *
- * @param cygwinUsed
- * @return FS instance
- */
- public FS detect(Boolean cygwinUsed) {
- if (SystemReader.getInstance().isWindows()) {
- if (cygwinUsed == null)
- cygwinUsed = Boolean.valueOf(FS_Win32_Cygwin.isCygwin());
- if (cygwinUsed.booleanValue())
- return new FS_Win32_Cygwin();
- else
- return new FS_Win32();
- } else {
- return new FS_POSIX();
- }
- }
- }
-
- private final static Logger LOG = LoggerFactory.getLogger(FS.class);
-
- /** The auto-detected implementation selected for this operating system and JRE. */
- public static final FS DETECTED = detect();
-
- private static FSFactory factory;
-
- /**
- * Auto-detect the appropriate file system abstraction.
- *
- * @return detected file system abstraction
- */
- public static FS detect() {
- return detect(null);
- }
-
- /**
- * Auto-detect the appropriate file system abstraction, taking into account
- * the presence of a Cygwin installation on the system. Using jgit in
- * combination with Cygwin requires a more elaborate (and possibly slower)
- * resolution of file system paths.
- *
- * @param cygwinUsed
- * <ul>
- * <li><code>Boolean.TRUE</code> to assume that Cygwin is used in
- * combination with jgit</li>
- * <li><code>Boolean.FALSE</code> to assume that Cygwin is
- * <b>not</b> used with jgit</li>
- * <li><code>null</code> to auto-detect whether a Cygwin
- * installation is present on the system and in this case assume
- * that Cygwin is used</li>
- * </ul>
- *
- * Note: this parameter is only relevant on Windows.
- *
- * @return detected file system abstraction
- */
- public static FS detect(Boolean cygwinUsed) {
- if (factory == null) {
- factory = new FS.FSFactory();
- }
- return factory.detect(cygwinUsed);
- }
-
- private volatile Holder<File> userHome;
-
- /**
- * Constructs a file system abstraction.
- */
- protected FS() {
- // Do nothing by default.
- }
-
- /**
- * Initialize this FS using another's current settings.
- *
- * @param src
- * the source FS to copy from.
- */
- protected FS(FS src) {
- userHome = src.userHome;
- }
-
- /** @return a new instance of the same type of FS. */
- public abstract FS newInstance();
-
- /**
- * Does this operating system and JRE support the execute flag on files?
- *
- * @return true if this implementation can provide reasonably accurate
- * executable bit information; false otherwise.
- */
- public abstract boolean supportsExecute();
-
- /**
- * Does this operating system and JRE supports symbolic links. The
- * capability to handle symbolic links is detected at runtime.
- *
- * @return true if symbolic links may be used
- * @since 3.0
- */
- public boolean supportsSymlinks() {
- return false;
- }
-
- /**
- * Is this file system case sensitive
- *
- * @return true if this implementation is case sensitive
- */
- public abstract boolean isCaseSensitive();
-
- /**
- * Determine if the file is executable (or not).
- * <p>
- * Not all platforms and JREs support executable flags on files. If the
- * feature is unsupported this method will always return false.
- * <p>
- * <em>If the platform supports symbolic links and <code>f</code> is a symbolic link
- * this method returns false, rather than the state of the executable flags
- * on the target file.</em>
- *
- * @param f
- * abstract path to test.
- * @return true if the file is believed to be executable by the user.
- */
- public abstract boolean canExecute(File f);
-
- /**
- * Set a file to be executable by the user.
- * <p>
- * Not all platforms and JREs support executable flags on files. If the
- * feature is unsupported this method will always return false and no
- * changes will be made to the file specified.
- *
- * @param f
- * path to modify the executable status of.
- * @param canExec
- * true to enable execution; false to disable it.
- * @return true if the change succeeded; false otherwise.
- */
- public abstract boolean setExecute(File f, boolean canExec);
-
- /**
- * Get the last modified time of a file system object. If the OS/JRE support
- * symbolic links, the modification time of the link is returned, rather
- * than that of the link target.
- *
- * @param f
- * @return last modified time of f
- * @throws IOException
- * @since 3.0
- */
- public long lastModified(File f) throws IOException {
- return f.lastModified();
- }
-
- /**
- * Set the last modified time of a file system object. If the OS/JRE support
- * symbolic links, the link is modified, not the target,
- *
- * @param f
- * @param time
- * @throws IOException
- * @since 3.0
- */
- public void setLastModified(File f, long time) throws IOException {
- f.setLastModified(time);
- }
-
- /**
- * Get the length of a file or link, If the OS/JRE supports symbolic links
- * it's the length of the link, else the length of the target.
- *
- * @param path
- * @return length of a file
- * @throws IOException
- * @since 3.0
- */
- public long length(File path) throws IOException {
- return path.length();
- }
-
- /**
- * Delete a file. Throws an exception if delete fails.
- *
- * @param f
- * @throws IOException
- * this may be a Java7 subclass with detailed information
- * @since 3.3
- */
- public void delete(File f) throws IOException {
- if (!f.delete())
- throw new IOException(MessageFormat.format(
- JGitText.get().deleteFileFailed, f.getAbsolutePath()));
- }
-
- /**
- * Resolve this file to its actual path name that the JRE can use.
- * <p>
- * This method can be relatively expensive. Computing a translation may
- * require forking an external process per path name translated. Callers
- * should try to minimize the number of translations necessary by caching
- * the results.
- * <p>
- * Not all platforms and JREs require path name translation. Currently only
- * Cygwin on Win32 require translation for Cygwin based paths.
- *
- * @param dir
- * directory relative to which the path name is.
- * @param name
- * path name to translate.
- * @return the translated path. <code>new File(dir,name)</code> if this
- * platform does not require path name translation.
- */
- public File resolve(final File dir, final String name) {
- final File abspn = new File(name);
- if (abspn.isAbsolute())
- return abspn;
- return new File(dir, name);
- }
-
- /**
- * Determine the user's home directory (location where preferences are).
- * <p>
- * This method can be expensive on the first invocation if path name
- * translation is required. Subsequent invocations return a cached result.
- * <p>
- * Not all platforms and JREs require path name translation. Currently only
- * Cygwin on Win32 requires translation of the Cygwin HOME directory.
- *
- * @return the user's home directory; null if the user does not have one.
- */
- public File userHome() {
- Holder<File> p = userHome;
- if (p == null) {
- p = new Holder<File>(userHomeImpl());
- userHome = p;
- }
- return p.value;
- }
-
- /**
- * Set the user's home directory location.
- *
- * @param path
- * the location of the user's preferences; null if there is no
- * home directory for the current user.
- * @return {@code this}.
- */
- public FS setUserHome(File path) {
- userHome = new Holder<File>(path);
- return this;
- }
-
- /**
- * Does this file system have problems with atomic renames?
- *
- * @return true if the caller should retry a failed rename of a lock file.
- */
- public abstract boolean retryFailedLockFileCommit();
-
- /**
- * Determine the user's home directory (location where preferences are).
- *
- * @return the user's home directory; null if the user does not have one.
- */
- protected File userHomeImpl() {
- final String home = AccessController
- .doPrivileged(new PrivilegedAction<String>() {
- public String run() {
- return System.getProperty("user.home"); //$NON-NLS-1$
- }
- });
- if (home == null || home.length() == 0)
- return null;
- return new File(home).getAbsoluteFile();
- }
-
- /**
- * Searches the given path to see if it contains one of the given files.
- * Returns the first it finds. Returns null if not found or if path is null.
- *
- * @param path
- * List of paths to search separated by File.pathSeparator
- * @param lookFor
- * Files to search for in the given path
- * @return the first match found, or null
- * @since 3.0
- **/
- protected static File searchPath(final String path, final String... lookFor) {
- if (path == null)
- return null;
-
- for (final String p : path.split(File.pathSeparator)) {
- for (String command : lookFor) {
- final File e = new File(p, command);
- if (e.isFile())
- return e.getAbsoluteFile();
- }
- }
- return null;
- }
-
- /**
- * Execute a command and return a single line of output as a String
- *
- * @param dir
- * Working directory for the command
- * @param command
- * as component array
- * @param encoding
- * to be used to parse the command's output
- * @return the one-line output of the command
- */
- protected static String readPipe(File dir, String[] command, String encoding) {
- return readPipe(dir, command, encoding, null);
- }
-
- /**
- * Execute a command and return a single line of output as a String
- *
- * @param dir
- * Working directory for the command
- * @param command
- * as component array
- * @param encoding
- * to be used to parse the command's output
- * @param env
- * Map of environment variables to be merged with those of the
- * current process
- * @return the one-line output of the command
- * @since 4.0
- */
- protected static String readPipe(File dir, String[] command, String encoding, Map<String, String> env) {
- final boolean debug = LOG.isDebugEnabled();
- try {
- if (debug) {
- LOG.debug("readpipe " + Arrays.asList(command) + "," //$NON-NLS-1$ //$NON-NLS-2$
- + dir);
- }
- ProcessBuilder pb = new ProcessBuilder(command);
- pb.directory(dir);
- if (env != null) {
- pb.environment().putAll(env);
- }
- final Process p = pb.start();
- final BufferedReader lineRead = new BufferedReader(
- new InputStreamReader(p.getInputStream(), encoding));
- p.getOutputStream().close();
- final AtomicBoolean gooblerFail = new AtomicBoolean(false);
- Thread gobbler = new Thread() {
- public void run() {
- InputStream is = p.getErrorStream();
- try {
- int ch;
- if (debug)
- while ((ch = is.read()) != -1)
- System.err.print((char) ch);
- else
- while (is.read() != -1) {
- // ignore
- }
- } catch (IOException e) {
- // Just print on stderr for debugging
- if (debug)
- e.printStackTrace(System.err);
- gooblerFail.set(true);
- }
- try {
- is.close();
- } catch (IOException e) {
- // Just print on stderr for debugging
- if (debug) {
- LOG.debug("Caught exception in gobbler thread", e); //$NON-NLS-1$
- }
- gooblerFail.set(true);
- }
- }
- };
- gobbler.start();
- String r = null;
- try {
- r = lineRead.readLine();
- if (debug) {
- LOG.debug("readpipe may return '" + r + "'"); //$NON-NLS-1$ //$NON-NLS-2$
- LOG.debug("(ignoring remaing output:"); //$NON-NLS-1$
- }
- String l;
- while ((l = lineRead.readLine()) != null) {
- if (debug) {
- LOG.debug(l);
- }
- }
- } finally {
- p.getErrorStream().close();
- lineRead.close();
- }
-
- for (;;) {
- try {
- int rc = p.waitFor();
- gobbler.join();
- if (rc == 0 && r != null && r.length() > 0
- && !gooblerFail.get())
- return r;
- if (debug) {
- LOG.debug("readpipe rc=" + rc); //$NON-NLS-1$
- }
- break;
- } catch (InterruptedException ie) {
- // Stop bothering me, I have a zombie to reap.
- }
- }
- } catch (IOException e) {
- LOG.debug("Caught exception in FS.readPipe()", e); //$NON-NLS-1$
- }
- if (debug) {
- LOG.debug("readpipe returns null"); //$NON-NLS-1$
- }
- return null;
- }
-
- /**
- * @return the path to the Git executable.
- * @since 4.0
- */
- protected abstract File discoverGitExe();
-
- /**
- * @return the path to the system-wide Git configuration file.
- * @since 4.0
- */
- protected File discoverGitSystemConfig() {
- File gitExe = discoverGitExe();
- if (gitExe == null) {
- return null;
- }
-
- // Trick Git into printing the path to the config file by using "echo"
- // as the editor.
- Map<String, String> env = new HashMap<>();
- env.put("GIT_EDITOR", "echo"); //$NON-NLS-1$ //$NON-NLS-2$
-
- String w = readPipe(gitExe.getParentFile(),
- new String[] { "git", "config", "--system", "--edit" }, //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ //$NON-NLS-4$
- Charset.defaultCharset().name(), env);
- if (StringUtils.isEmptyOrNull(w)) {
- return null;
- }
-
- return new File(w);
- }
-
- /**
- * @param grandchild
- * @return the parent directory of this file's parent directory or
- * {@code null} in case there's no grandparent directory
- * @since 4.0
- */
- protected static File resolveGrandparentFile(File grandchild) {
- if (grandchild != null) {
- File parent = grandchild.getParentFile();
- if (parent != null)
- return parent.getParentFile();
- }
- return null;
- }
-
- /**
- * Check if a file is a symbolic link and read it
- *
- * @param path
- * @return target of link or null
- * @throws IOException
- * @since 3.0
- */
- public String readSymLink(File path) throws IOException {
- throw new SymlinksNotSupportedException(
- JGitText.get().errorSymlinksNotSupported);
- }
-
- /**
- * @param path
- * @return true if the path is a symbolic link (and we support these)
- * @throws IOException
- * @since 3.0
- */
- public boolean isSymLink(File path) throws IOException {
- return false;
- }
-
- /**
- * Tests if the path exists, in case of a symbolic link, true even if the
- * target does not exist
- *
- * @param path
- * @return true if path exists
- * @since 3.0
- */
- public boolean exists(File path) {
- return path.exists();
- }
-
- /**
- * Check if path is a directory. If the OS/JRE supports symbolic links and
- * path is a symbolic link to a directory, this method returns false.
- *
- * @param path
- * @return true if file is a directory,
- * @since 3.0
- */
- public boolean isDirectory(File path) {
- return path.isDirectory();
- }
-
- /**
- * Examine if path represents a regular file. If the OS/JRE supports
- * symbolic links the test returns false if path represents a symbolic link.
- *
- * @param path
- * @return true if path represents a regular file
- * @since 3.0
- */
- public boolean isFile(File path) {
- return path.isFile();
- }
-
- /**
- * @param path
- * @return true if path is hidden, either starts with . on unix or has the
- * hidden attribute in windows
- * @throws IOException
- * @since 3.0
- */
- public boolean isHidden(File path) throws IOException {
- return path.isHidden();
- }
-
- /**
- * Set the hidden attribute for file whose name starts with a period.
- *
- * @param path
- * @param hidden
- * @throws IOException
- * @since 3.0
- */
- public void setHidden(File path, boolean hidden) throws IOException {
- if (!path.getName().startsWith(".")) //$NON-NLS-1$
- throw new IllegalArgumentException(
- "Hiding only allowed for names that start with a period");
- }
-
- /**
- * Create a symbolic link
- *
- * @param path
- * @param target
- * @throws IOException
- * @since 3.0
- */
- public void createSymLink(File path, String target) throws IOException {
- throw new SymlinksNotSupportedException(
- JGitText.get().errorSymlinksNotSupported);
- }
-
- /**
- * See {@link FileUtils#relativize(String, String)}.
- *
- * @param base
- * The path against which <code>other</code> should be
- * relativized.
- * @param other
- * The path that will be made relative to <code>base</code>.
- * @return A relative path that, when resolved against <code>base</code>,
- * will yield the original <code>other</code>.
- * @see FileUtils#relativize(String, String)
- * @since 3.7
- */
- public String relativize(String base, String other) {
- return FileUtils.relativize(base, other);
- }
-
- /**
- * Checks whether the given hook is defined for the given repository, then
- * runs it with the given arguments.
- * <p>
- * The hook's standard output and error streams will be redirected to
- * <code>System.out</code> and <code>System.err</code> respectively. The
- * hook will have no stdin.
- * </p>
- *
- * @param repository
- * The repository for which a hook should be run.
- * @param hookName
- * The name of the hook to be executed.
- * @param args
- * Arguments to pass to this hook. Cannot be <code>null</code>,
- * but can be an empty array.
- * @return The ProcessResult describing this hook's execution.
- * @throws JGitInternalException
- * if we fail to run the hook somehow. Causes may include an
- * interrupted process or I/O errors.
- * @since 4.0
- */
- public ProcessResult runHookIfPresent(Repository repository,
- final String hookName,
- String[] args) throws JGitInternalException {
- return runHookIfPresent(repository, hookName, args, System.out, System.err,
- null);
- }
-
- /**
- * Checks whether the given hook is defined for the given repository, then
- * runs it with the given arguments.
- *
- * @param repository
- * The repository for which a hook should be run.
- * @param hookName
- * The name of the hook to be executed.
- * @param args
- * Arguments to pass to this hook. Cannot be <code>null</code>,
- * but can be an empty array.
- * @param outRedirect
- * A print stream on which to redirect the hook's stdout. Can be
- * <code>null</code>, in which case the hook's standard output
- * will be lost.
- * @param errRedirect
- * A print stream on which to redirect the hook's stderr. Can be
- * <code>null</code>, in which case the hook's standard error
- * will be lost.
- * @param stdinArgs
- * A string to pass on to the standard input of the hook. May be
- * <code>null</code>.
- * @return The ProcessResult describing this hook's execution.
- * @throws JGitInternalException
- * if we fail to run the hook somehow. Causes may include an
- * interrupted process or I/O errors.
- * @since 4.0
- */
- public ProcessResult runHookIfPresent(Repository repository,
- final String hookName,
- String[] args, PrintStream outRedirect, PrintStream errRedirect,
- String stdinArgs) throws JGitInternalException {
- return new ProcessResult(Status.NOT_SUPPORTED);
- }
-
- /**
- * See
- * {@link #runHookIfPresent(Repository, String, String[], PrintStream, PrintStream, String)}
- * . Should only be called by FS supporting shell scripts execution.
- *
- * @param repository
- * The repository for which a hook should be run.
- * @param hookName
- * The name of the hook to be executed.
- * @param args
- * Arguments to pass to this hook. Cannot be <code>null</code>,
- * but can be an empty array.
- * @param outRedirect
- * A print stream on which to redirect the hook's stdout. Can be
- * <code>null</code>, in which case the hook's standard output
- * will be lost.
- * @param errRedirect
- * A print stream on which to redirect the hook's stderr. Can be
- * <code>null</code>, in which case the hook's standard error
- * will be lost.
- * @param stdinArgs
- * A string to pass on to the standard input of the hook. May be
- * <code>null</code>.
- * @return The ProcessResult describing this hook's execution.
- * @throws JGitInternalException
- * if we fail to run the hook somehow. Causes may include an
- * interrupted process or I/O errors.
- * @since 4.0
- */
- protected ProcessResult internalRunHookIfPresent(Repository repository,
- final String hookName, String[] args, PrintStream outRedirect,
- PrintStream errRedirect, String stdinArgs)
- throws JGitInternalException {
- final File hookFile = findHook(repository, hookName);
- if (hookFile == null)
- return new ProcessResult(Status.NOT_PRESENT);
-
- final String hookPath = hookFile.getAbsolutePath();
- final File runDirectory;
- if (repository.isBare())
- runDirectory = repository.getDirectory();
- else
- runDirectory = repository.getWorkTree();
- final String cmd = relativize(runDirectory.getAbsolutePath(),
- hookPath);
- ProcessBuilder hookProcess = runInShell(cmd, args);
- hookProcess.directory(runDirectory);
- try {
- return new ProcessResult(runProcess(hookProcess, outRedirect,
- errRedirect, stdinArgs), Status.OK);
- } catch (IOException e) {
- throw new JGitInternalException(MessageFormat.format(
- JGitText.get().exceptionCaughtDuringExecutionOfHook,
- hookName), e);
- } catch (InterruptedException e) {
- throw new JGitInternalException(MessageFormat.format(
- JGitText.get().exceptionHookExecutionInterrupted,
- hookName), e);
- }
- }
-
-
- /**
- * Tries to find a hook matching the given one in the given repository.
- *
- * @param repository
- * The repository within which to find a hook.
- * @param hookName
- * The name of the hook we're trying to find.
- * @return The {@link File} containing this particular hook if it exists in
- * the given repository, <code>null</code> otherwise.
- * @since 4.0
- */
- public File findHook(Repository repository, final String hookName) {
- final File hookFile = new File(new File(repository.getDirectory(),
- Constants.HOOKS), hookName);
- return hookFile.isFile() ? hookFile : null;
- }
-
- /**
- * Runs the given process until termination, clearing its stdout and stderr
- * streams on-the-fly.
- *
- * @param hookProcessBuilder
- * The process builder configured for this hook.
- * @param outRedirect
- * A print stream on which to redirect the hook's stdout. Can be
- * <code>null</code>, in which case the hook's standard output
- * will be lost.
- * @param errRedirect
- * A print stream on which to redirect the hook's stderr. Can be
- * <code>null</code>, in which case the hook's standard error
- * will be lost.
- * @param stdinArgs
- * A string to pass on to the standard input of the hook. Can be
- * <code>null</code>.
- * @return the exit value of this hook.
- * @throws IOException
- * if an I/O error occurs while executing this hook.
- * @throws InterruptedException
- * if the current thread is interrupted while waiting for the
- * process to end.
- * @since 3.7
- */
- protected int runProcess(ProcessBuilder hookProcessBuilder,
- OutputStream outRedirect, OutputStream errRedirect, String stdinArgs)
- throws IOException, InterruptedException {
- final ExecutorService executor = Executors.newFixedThreadPool(2);
- Process process = null;
- // We'll record the first I/O exception that occurs, but keep on trying
- // to dispose of our open streams and file handles
- IOException ioException = null;
- try {
- process = hookProcessBuilder.start();
- final Callable<Void> errorGobbler = new StreamGobbler(
- process.getErrorStream(), errRedirect);
- final Callable<Void> outputGobbler = new StreamGobbler(
- process.getInputStream(), outRedirect);
- executor.submit(errorGobbler);
- executor.submit(outputGobbler);
- if (stdinArgs != null) {
- final PrintWriter stdinWriter = new PrintWriter(
- process.getOutputStream());
- stdinWriter.print(stdinArgs);
- stdinWriter.flush();
- // We are done with this hook's input. Explicitly close its
- // stdin now to kick off any blocking read the hook might have.
- stdinWriter.close();
- }
- return process.waitFor();
- } catch (IOException e) {
- ioException = e;
- } finally {
- shutdownAndAwaitTermination(executor);
- if (process != null) {
- try {
- process.waitFor();
- } catch (InterruptedException e) {
- // Thrown by the outer try.
- // Swallow this one to carry on our cleanup, and clear the
- // interrupted flag (processes throw the exception without
- // clearing the flag).
- Thread.interrupted();
- }
- // A process doesn't clean its own resources even when destroyed
- // Explicitly try and close all three streams, preserving the
- // outer I/O exception if any.
- try {
- process.getErrorStream().close();
- } catch (IOException e) {
- ioException = ioException != null ? ioException : e;
- }
- try {
- process.getInputStream().close();
- } catch (IOException e) {
- ioException = ioException != null ? ioException : e;
- }
- try {
- process.getOutputStream().close();
- } catch (IOException e) {
- ioException = ioException != null ? ioException : e;
- }
- process.destroy();
- }
- }
- // We can only be here if the outer try threw an IOException.
- throw ioException;
- }
-
- /**
- * Shuts down an {@link ExecutorService} in two phases, first by calling
- * {@link ExecutorService#shutdown() shutdown} to reject incoming tasks, and
- * then calling {@link ExecutorService#shutdownNow() shutdownNow}, if
- * necessary, to cancel any lingering tasks. Returns true if the pool has
- * been properly shutdown, false otherwise.
- * <p>
- *
- * @param pool
- * the pool to shutdown
- * @return <code>true</code> if the pool has been properly shutdown,
- * <code>false</code> otherwise.
- */
- private static boolean shutdownAndAwaitTermination(ExecutorService pool) {
- boolean hasShutdown = true;
- pool.shutdown(); // Disable new tasks from being submitted
- try {
- // Wait a while for existing tasks to terminate
- if (!pool.awaitTermination(5, TimeUnit.SECONDS)) {
- pool.shutdownNow(); // Cancel currently executing tasks
- // Wait a while for tasks to respond to being canceled
- if (!pool.awaitTermination(5, TimeUnit.SECONDS))
- hasShutdown = false;
- }
- } catch (InterruptedException ie) {
- // (Re-)Cancel if current thread also interrupted
- pool.shutdownNow();
- // Preserve interrupt status
- Thread.currentThread().interrupt();
- hasShutdown = false;
- }
- return hasShutdown;
- }
-
- /**
- * Initialize a ProcesssBuilder to run a command using the system shell.
- *
- * @param cmd
- * command to execute. This string should originate from the
- * end-user, and thus is platform specific.
- * @param args
- * arguments to pass to command. These should be protected from
- * shell evaluation.
- * @return a partially completed process builder. Caller should finish
- * populating directory, environment, and then start the process.
- */
- public abstract ProcessBuilder runInShell(String cmd, String[] args);
-
- private static class Holder<V> {
- final V value;
-
- Holder(V value) {
- this.value = value;
- }
- }
-
- /**
- * File attributes we typically care for.
- *
- * @since 3.3
- */
- public static class Attributes {
-
- /**
- * @return true if this are the attributes of a directory
- */
- public boolean isDirectory() {
- return isDirectory;
- }
-
- /**
- * @return true if this are the attributes of an executable file
- */
- public boolean isExecutable() {
- return isExecutable;
- }
-
- /**
- * @return true if this are the attributes of a symbolic link
- */
- public boolean isSymbolicLink() {
- return isSymbolicLink;
- }
-
- /**
- * @return true if this are the attributes of a regular file
- */
- public boolean isRegularFile() {
- return isRegularFile;
- }
-
- /**
- * @return the time when the file was created
- */
- public long getCreationTime() {
- return creationTime;
- }
-
- /**
- * @return the time (milliseconds since 1970-01-01) when this object was
- * last modified
- */
- public long getLastModifiedTime() {
- return lastModifiedTime;
- }
-
- private boolean isDirectory;
-
- private boolean isSymbolicLink;
-
- private boolean isRegularFile;
-
- private long creationTime;
-
- private long lastModifiedTime;
-
- private boolean isExecutable;
-
- private File file;
-
- private boolean exists;
-
- /**
- * file length
- */
- protected long length = -1;
-
- FS fs;
-
- Attributes(FS fs, File file, boolean exists, boolean isDirectory,
- boolean isExecutable, boolean isSymbolicLink,
- boolean isRegularFile, long creationTime,
- long lastModifiedTime, long length) {
- this.fs = fs;
- this.file = file;
- this.exists = exists;
- this.isDirectory = isDirectory;
- this.isExecutable = isExecutable;
- this.isSymbolicLink = isSymbolicLink;
- this.isRegularFile = isRegularFile;
- this.creationTime = creationTime;
- this.lastModifiedTime = lastModifiedTime;
- this.length = length;
- }
-
- /**
- * Constructor when there are issues with reading
- *
- * @param fs
- * @param path
- */
- public Attributes(File path, FS fs) {
- this.file = path;
- this.fs = fs;
- }
-
- /**
- * @return length of this file object
- */
- public long getLength() {
- if (length == -1)
- return length = file.length();
- return length;
- }
-
- /**
- * @return the filename
- */
- public String getName() {
- return file.getName();
- }
-
- /**
- * @return the file the attributes apply to
- */
- public File getFile() {
- return file;
- }
-
- boolean exists() {
- return exists;
- }
- }
-
- /**
- * @param path
- * @return the file attributes we care for
- * @since 3.3
- */
- public Attributes getAttributes(File path) {
- boolean isDirectory = isDirectory(path);
- boolean isFile = !isDirectory && path.isFile();
- assert path.exists() == isDirectory || isFile;
- boolean exists = isDirectory || isFile;
- boolean canExecute = exists && !isDirectory && canExecute(path);
- boolean isSymlink = false;
- long lastModified = exists ? path.lastModified() : 0L;
- long createTime = 0L;
- return new Attributes(this, path, exists, isDirectory, canExecute,
- isSymlink, isFile, createTime, lastModified, -1);
- }
-
- /**
- * Normalize the unicode path to composed form.
- *
- * @param file
- * @return NFC-format File
- * @since 3.3
- */
- public File normalize(File file) {
- return file;
- }
-
- /**
- * Normalize the unicode path to composed form.
- *
- * @param name
- * @return NFC-format string
- * @since 3.3
- */
- public String normalize(String name) {
- return name;
- }
-
- /**
- * This runnable will consume an input stream's content into an output
- * stream as soon as it gets available.
- * <p>
- * Typically used to empty processes' standard output and error, preventing
- * them to choke.
- * </p>
- * <p>
- * <b>Note</b> that a {@link StreamGobbler} will never close either of its
- * streams.
- * </p>
- */
- private static class StreamGobbler implements Callable<Void> {
- private final BufferedReader reader;
-
- private final BufferedWriter writer;
-
- public StreamGobbler(InputStream stream, OutputStream output) {
- this.reader = new BufferedReader(new InputStreamReader(stream));
- if (output == null)
- this.writer = null;
- else
- this.writer = new BufferedWriter(new OutputStreamWriter(output));
- }
-
- public Void call() throws IOException {
- boolean writeFailure = false;
-
- String line = null;
- while ((line = reader.readLine()) != null) {
- // Do not try to write again after a failure, but keep reading
- // as long as possible to prevent the input stream from choking.
- if (!writeFailure && writer != null) {
- try {
- writer.write(line);
- writer.newLine();
- writer.flush();
- } catch (IOException e) {
- writeFailure = true;
- }
- }
- }
- return null;
- }
- }
- }
|