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 import java.text.MessageFormat;
47
48 import org.eclipse.jgit.errors.ConfigInvalidException;
49 import org.eclipse.jgit.lfs.internal.LfsText;
50 import org.eclipse.jgit.lib.ConfigConstants;
51 import org.eclipse.jgit.lib.Repository;
52 import org.eclipse.jgit.lib.StoredConfig;
53 import org.eclipse.jgit.storage.file.FileBasedConfig;
54 import org.eclipse.jgit.util.FS;
55 import org.eclipse.jgit.util.LfsFactory.LfsInstallCommand;
56 import org.eclipse.jgit.util.SystemReader;
57
58 /**
59 * Installs all required LFS properties for the current user, analogous to 'git
60 * lfs install', but defaulting to using JGit builtin hooks.
61 *
62 * @since 4.11
63 */
64 public class InstallBuiltinLfsCommand implements LfsInstallCommand {
65
66 private static final String[] ARGS_USER = new String[] { "lfs", "install" }; //$NON-NLS-1$//$NON-NLS-2$
67
68 private static final String[] ARGS_LOCAL = new String[] { "lfs", "install", //$NON-NLS-1$//$NON-NLS-2$
69 "--local" }; //$NON-NLS-1$
70
71 private Repository repository;
72
73 /** {@inheritDoc} */
74 @Override
75 public Void call() throws Exception {
76 StoredConfig cfg = null;
77 if (repository == null) {
78 cfg = loadUserConfig();
79 } else {
80 cfg = repository.getConfig();
81 }
82
83 cfg.setBoolean(ConfigConstants.CONFIG_FILTER_SECTION,
84 ConfigConstants.CONFIG_SECTION_LFS,
85 ConfigConstants.CONFIG_KEY_USEJGITBUILTIN, true);
86 cfg.setBoolean(ConfigConstants.CONFIG_FILTER_SECTION,
87 ConfigConstants.CONFIG_SECTION_LFS,
88 ConfigConstants.CONFIG_KEY_REQUIRED, true);
89
90 cfg.save();
91
92 // try to run git lfs install, we really don't care if it is present
93 // and/or works here (yet).
94 ProcessBuilder builder = FS.DETECTED.runInShell("git", //$NON-NLS-1$
95 repository == null ? ARGS_USER : ARGS_LOCAL);
96 if (repository != null) {
97 builder.directory(repository.isBare() ? repository.getDirectory()
98 : repository.getWorkTree());
99 }
100 FS.DETECTED.runProcess(builder, null, null, (String) null);
101
102 return null;
103 }
104
105 /**
106 * Set the repository to install LFS for
107 *
108 * @param repo
109 * the repository to install LFS into locally instead of the user
110 * configuration
111 * @return this command
112 */
113 @Override
114 public LfsInstallCommand setRepository(Repository repo) {
115 this.repository = repo;
116 return this;
117 }
118
119 private StoredConfig loadUserConfig() throws IOException {
120 FileBasedConfig c = SystemReader.getInstance().openUserConfig(null,
121 FS.DETECTED);
122 try {
123 c.load();
124 } catch (ConfigInvalidException e1) {
125 throw new IOException(MessageFormat
126 .format(LfsText.get().userConfigInvalid, c.getFile()
127 .getAbsolutePath(), e1),
128 e1);
129 }
130
131 return c;
132 }
133
134 }