1 /*
2 * Copyright (C) 2018, Markus Duft <markus.duft@ssi-schaefer.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.lfs;
44
45 import java.io.IOException;
46
47 import org.eclipse.jgit.api.errors.InvalidConfigurationException;
48 import org.eclipse.jgit.errors.ConfigInvalidException;
49 import org.eclipse.jgit.lib.ConfigConstants;
50 import org.eclipse.jgit.lib.Repository;
51 import org.eclipse.jgit.lib.StoredConfig;
52 import org.eclipse.jgit.util.FS;
53 import org.eclipse.jgit.util.LfsFactory.LfsInstallCommand;
54 import org.eclipse.jgit.util.SystemReader;
55
56 /**
57 * Installs all required LFS properties for the current user, analogous to 'git
58 * lfs install', but defaulting to using JGit builtin hooks.
59 *
60 * @since 4.11
61 */
62 public class InstallBuiltinLfsCommand implements LfsInstallCommand {
63
64 private static final String[] ARGS_USER = new String[] { "lfs", "install" }; //$NON-NLS-1$//$NON-NLS-2$
65
66 private static final String[] ARGS_LOCAL = new String[] { "lfs", "install", //$NON-NLS-1$//$NON-NLS-2$
67 "--local" }; //$NON-NLS-1$
68
69 private Repository repository;
70
71 /**
72 * {@inheritDoc}
73 *
74 * @throws IOException
75 * if an I/O error occurs while accessing a git config or
76 * executing {@code git lfs install} in an external process
77 * @throws InvalidConfigurationException
78 * if a git configuration is invalid
79 * @throws InterruptedException
80 * if the current thread is interrupted while waiting for the
81 * {@code git lfs install} executed in an external process
82 */
83 @Override
84 public Void call() throws IOException, InvalidConfigurationException,
85 InterruptedException {
86 StoredConfig cfg = null;
87 if (repository == null) {
88 try {
89 cfg = SystemReader.getInstance().getUserConfig();
90 } catch (ConfigInvalidException e) {
91 throw new InvalidConfigurationException(e.getMessage(), e);
92 }
93 } else {
94 cfg = repository.getConfig();
95 }
96
97 cfg.setBoolean(ConfigConstants.CONFIG_FILTER_SECTION,
98 ConfigConstants.CONFIG_SECTION_LFS,
99 ConfigConstants.CONFIG_KEY_USEJGITBUILTIN, true);
100 cfg.setBoolean(ConfigConstants.CONFIG_FILTER_SECTION,
101 ConfigConstants.CONFIG_SECTION_LFS,
102 ConfigConstants.CONFIG_KEY_REQUIRED, true);
103
104 cfg.save();
105
106 // try to run git lfs install, we really don't care if it is present
107 // and/or works here (yet).
108 ProcessBuilder builder = FS.DETECTED.runInShell("git", //$NON-NLS-1$
109 repository == null ? ARGS_USER : ARGS_LOCAL);
110 if (repository != null) {
111 builder.directory(repository.isBare() ? repository.getDirectory()
112 : repository.getWorkTree());
113 }
114 FS.DETECTED.runProcess(builder, null, null, (String) null);
115
116 return null;
117 }
118
119 /**
120 * Set the repository to install LFS for
121 *
122 * @param repo
123 * the repository to install LFS into locally instead of the user
124 * configuration
125 * @return this command
126 */
127 @Override
128 public LfsInstallCommand setRepository(Repository repo) {
129 this.repository = repo;
130 return this;
131 }
132
133 }