blob: eadab2184667d201b6385beb51f603be0ba41dcc (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
|
/*
* Copyright (C) 2009-2010, Google Inc. and others
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0 which is available at
* https://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
package org.eclipse.jgit.http.server;
import java.util.Enumeration;
import jakarta.servlet.Filter;
import jakarta.servlet.FilterConfig;
import jakarta.servlet.ServletConfig;
import jakarta.servlet.ServletContext;
import jakarta.servlet.ServletException;
import jakarta.servlet.http.HttpServletRequest;
import org.eclipse.jgit.http.server.glue.MetaServlet;
import org.eclipse.jgit.http.server.resolver.AsIsFileService;
import org.eclipse.jgit.transport.resolver.ReceivePackFactory;
import org.eclipse.jgit.transport.resolver.RepositoryResolver;
import org.eclipse.jgit.transport.resolver.UploadPackFactory;
/**
* Handles Git repository access over HTTP.
* <p>
* Applications embedding this servlet should map a directory path within the
* application to this servlet, for example:
*
* <pre>
* <servlet>
* <servlet-name>GitServlet</servlet-name>
* <servlet-class>org.eclipse.jgit.http.server.GitServlet</servlet-class>
* <init-param>
* <param-name>base-path</param-name>
* <param-value>/var/srv/git</param-value>
* </init-param>
* <init-param>
* <param-name>export-all</param-name>
* <param-value>0</param-value>
* </init-param>
* </servlet>
* <servlet-mapping>
* <servlet-name>GitServlet</servlet-name>
* <url-pattern>/git/*</url-pattern>
* </servlet-mapping>
* </pre>
*
* <p>
* Applications may wish to add additional repository action URLs to this
* servlet by taking advantage of its extension from
* {@link org.eclipse.jgit.http.server.glue.MetaServlet}. Callers may register
* their own URL suffix translations through {@link #serve(String)}, or their
* regex translations through {@link #serveRegex(String)}. Each translation
* should contain a complete filter pipeline which ends with the HttpServlet
* that should handle the requested action.
*/
public class GitServlet extends MetaServlet {
private static final long serialVersionUID = 1L;
private final GitFilter gitFilter;
/**
* New servlet that will load its base directory from {@code web.xml}.
* <p>
* The required parameter {@code base-path} must be configured to point to
* the local filesystem directory where all served Git repositories reside.
*/
public GitServlet() {
super(new GitFilter());
gitFilter = (GitFilter) getDelegateFilter();
}
/**
* New servlet configured with a specific resolver.
*
* @param resolver
* the resolver to use when matching URL to Git repository. If
* null the {@code base-path} parameter will be looked for in the
* parameter table during init, which usually comes from the
* {@code web.xml} file of the web application.
*/
public void setRepositoryResolver(RepositoryResolver<HttpServletRequest> resolver) {
gitFilter.setRepositoryResolver(resolver);
}
/**
* Set AsIsFileService
*
* @param f
* the filter to validate direct access to repository files
* through a dumb client. If {@code null} then dumb client
* support is completely disabled.
*/
public void setAsIsFileService(AsIsFileService f) {
gitFilter.setAsIsFileService(f);
}
/**
* Set upload-pack factory
*
* @param f
* the factory to construct and configure an
* {@link org.eclipse.jgit.transport.UploadPack} session when a
* fetch or clone is requested by a client.
*/
public void setUploadPackFactory(UploadPackFactory<HttpServletRequest> f) {
gitFilter.setUploadPackFactory(f);
}
/**
* Set a custom error handler for git-upload-pack.
*
* @param h
* A custom error handler for git-upload-pack.
* @since 5.9.1
*/
public void setUploadPackErrorHandler(UploadPackErrorHandler h) {
gitFilter.setUploadPackErrorHandler(h);
}
/**
* Add upload-pack filter
*
* @param filter
* filter to apply before any of the UploadPack operations. The
* UploadPack instance is available in the request attribute
* {@link org.eclipse.jgit.http.server.ServletUtils#ATTRIBUTE_HANDLER}.
* @since 7.0
*/
public void addUploadPackFilter(Filter filter) {
gitFilter.addUploadPackFilter(filter);
}
/**
* Set receive-pack factory
*
* @param f
* the factory to construct and configure a
* {@link org.eclipse.jgit.transport.ReceivePack} session when a
* push is requested by a client.
*/
public void setReceivePackFactory(ReceivePackFactory<HttpServletRequest> f) {
gitFilter.setReceivePackFactory(f);
}
/**
* Set a custom error handler for git-receive-pack.
*
* @param h
* A custom error handler for git-receive-pack.
* @since 5.9.1
*/
public void setReceivePackErrorHandler(ReceivePackErrorHandler h) {
gitFilter.setReceivePackErrorHandler(h);
}
/**
* Add receive-pack filter
*
* @param filter
* filter to apply before any of the ReceivePack operations. The
* ReceivePack instance is available in the request attribute
* {@link org.eclipse.jgit.http.server.ServletUtils#ATTRIBUTE_HANDLER}.
* @since 7.0
*/
public void addReceivePackFilter(Filter filter) {
gitFilter.addReceivePackFilter(filter);
}
@Override
public void init(ServletConfig config) throws ServletException {
gitFilter.init(new FilterConfig() {
@Override
public String getFilterName() {
return gitFilter.getClass().getName();
}
@Override
public String getInitParameter(String name) {
return config.getInitParameter(name);
}
@Override
public Enumeration<String> getInitParameterNames() {
return config.getInitParameterNames();
}
@Override
public ServletContext getServletContext() {
return config.getServletContext();
}
});
}
}
|
