1 /*
2 * Copyright (C) 2017, 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.io.InputStream;
47 import java.io.PrintStream;
48
49 import org.eclipse.jgit.annotations.Nullable;
50 import org.eclipse.jgit.attributes.Attribute;
51 import org.eclipse.jgit.hooks.PrePushHook;
52 import org.eclipse.jgit.lib.ConfigConstants;
53 import org.eclipse.jgit.lib.ObjectLoader;
54 import org.eclipse.jgit.lib.Repository;
55 import org.eclipse.jgit.util.LfsFactory;
56
57 /**
58 * Implementation of {@link LfsFactory}, using built-in (optional) LFS support.
59 *
60 * @since 4.11
61 */
62 public class BuiltinLFS extends LfsFactory {
63
64 private BuiltinLFS() {
65 SmudgeFilter.register();
66 CleanFilter.register();
67 }
68
69 /**
70 * Activates the built-in LFS support.
71 */
72 public static void register() {
73 setInstance(new BuiltinLFS());
74 }
75
76 @Override
77 public boolean isAvailable() {
78 return true;
79 }
80
81 @Override
82 public ObjectLoader applySmudgeFilter(Repository db, ObjectLoader loader,
83 Attribute attribute) throws IOException {
84 if (isEnabled(db) && (attribute == null || isEnabled(db, attribute))) {
85 return LfsBlobFilter.smudgeLfsBlob(db, loader);
86 } else {
87 return loader;
88 }
89 }
90
91 @Override
92 public LfsInputStream applyCleanFilter(Repository db, InputStream input,
93 long length, Attribute attribute) throws IOException {
94 if (isEnabled(db, attribute)) {
95 return new LfsInputStream(LfsBlobFilter.cleanLfsBlob(db, input));
96 } else {
97 return new LfsInputStream(input, length);
98 }
99 }
100
101 @Override
102 public @Nullable PrePushHook getPrePushHook(Repository repo,
103 PrintStream outputStream) {
104 if (isEnabled(repo)) {
105 return new LfsPrePushHook(repo, outputStream);
106 }
107 return null;
108 }
109
110 /**
111 * @param db
112 * the repository
113 * @return whether LFS is requested for the given repo.
114 */
115 @Override
116 public boolean isEnabled(Repository db) {
117 if (db == null) {
118 return false;
119 }
120 return db.getConfig().getBoolean(ConfigConstants.CONFIG_FILTER_SECTION,
121 ConfigConstants.CONFIG_SECTION_LFS,
122 ConfigConstants.CONFIG_KEY_USEJGITBUILTIN,
123 false);
124 }
125
126 /**
127 * @param db
128 * the repository
129 * @param attribute
130 * the attribute to check
131 * @return whether LFS filter is enabled for the given .gitattribute
132 * attribute.
133 */
134 private boolean isEnabled(Repository db, Attribute attribute) {
135 if (attribute == null) {
136 return false;
137 }
138 return isEnabled(db) && ConfigConstants.CONFIG_SECTION_LFS
139 .equals(attribute.getValue());
140 }
141
142 @Override
143 public LfsInstallCommand getInstallCommand() {
144 return new InstallBuiltinLfsCommand();
145 }
146
147 }