This repository was archived by the owner on Mar 29, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 184
Expand file tree
/
Copy pathGitilesFilter.java
More file actions
433 lines (391 loc) · 15.1 KB
/
Copy pathGitilesFilter.java
File metadata and controls
433 lines (391 loc) · 15.1 KB
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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
// Copyright 2012 Google Inc. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.google.gitiles;
import static com.google.common.base.MoreObjects.firstNonNull;
import static com.google.common.base.Preconditions.checkNotNull;
import static com.google.common.base.Preconditions.checkState;
import static com.google.gitiles.GitilesServlet.STATIC_PREFIX;
import static com.google.gitiles.Renderer.fileUrlMapper;
import static java.util.stream.Collectors.toList;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.LinkedListMultimap;
import com.google.common.collect.ListMultimap;
import com.google.common.collect.Maps;
import com.google.gitiles.blame.BlameServlet;
import com.google.gitiles.blame.cache.BlameCache;
import com.google.gitiles.blame.cache.BlameCacheImpl;
import com.google.gitiles.doc.DocServlet;
import java.io.File;
import java.io.IOException;
import java.net.UnknownHostException;
import java.util.Arrays;
import java.util.Iterator;
import java.util.Map;
import java.util.regex.Pattern;
import javax.annotation.Nullable;
import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.eclipse.jgit.errors.ConfigInvalidException;
import org.eclipse.jgit.http.server.glue.MetaFilter;
import org.eclipse.jgit.http.server.glue.ServletBinder;
import org.eclipse.jgit.lib.Config;
import org.eclipse.jgit.transport.resolver.FileResolver;
import org.eclipse.jgit.transport.resolver.RepositoryResolver;
/**
* MetaFilter to serve Gitiles.
*
* <p>Do not use directly; use {@link GitilesServlet}.
*/
class GitilesFilter extends MetaFilter {
// The following regexes have the following capture groups:
// 1. The whole string, which causes RegexPipeline to set REGEX_GROUPS but
// not otherwise modify the original request.
// 2. The repository name part, before /<CMD>.
// 3. The command, <CMD>, with no slashes and beginning with +. Commands have
// names analogous to (but not exactly the same as) git command names, such
// as "+log" and "+show". The bare command "+" maps to one of the other
// commands based on the revision/path, and may change over time.
// 4. The revision/path part, after /<CMD> (called just "path" below). This is
// split into a revision and a path by RevisionParser.
private static final String CMD = "\\+[a-z0-9-]*";
@VisibleForTesting
static final Pattern ROOT_REGEX =
Pattern.compile(
""
+ "^( " // 1. Everything
+ " /* " // Excess slashes
+ " (/) " // 2. Repo name (just slash)
+ " () " // 3. Command
+ " () " // 4. Path
+ ")$ ",
Pattern.COMMENTS);
@VisibleForTesting
static final Pattern REPO_REGEX =
Pattern.compile(
""
+ "^( " // 1. Everything
+ " /* " // Excess slashes
+ " ( " // 2. Repo name
+ " / " // Leading slash
+ " (?:.(?! " // Anything, as long as it's not followed by...
+ " /"
+ CMD
+ "/ " // the special "/<CMD>/" separator,
+ " |/"
+ CMD
+ "$ " // or "/<CMD>" at the end of the string
+ " ))*? "
+ " ) "
+ " /* " // Trailing slashes
+ " () " // 3. Command
+ " () " // 4. Path
+ ")$ ",
Pattern.COMMENTS);
@VisibleForTesting
static final Pattern REPO_PATH_REGEX =
Pattern.compile(
""
+ "^( " // 1. Everything
+ " /* " // Excess slashes
+ " ( " // 2. Repo name
+ " / " // Leading slash
+ " .*? " // Anything, non-greedy
+ " ) "
+ " /("
+ CMD
+ ")" // 3. Command
+ " ( " // 4. Path
+ " (?:/.*)? " // Slash path, or nothing.
+ " ) "
+ ")$ ",
Pattern.COMMENTS);
private static class DispatchFilter extends AbstractHttpFilter {
private final ListMultimap<GitilesView.Type, Filter> filters;
private final Map<GitilesView.Type, HttpServlet> servlets;
private DispatchFilter(
ListMultimap<GitilesView.Type, Filter> filters,
Map<GitilesView.Type, HttpServlet> servlets) {
this.filters = LinkedListMultimap.create(filters);
this.servlets = ImmutableMap.copyOf(servlets);
for (GitilesView.Type type : GitilesView.Type.values()) {
checkState(servlets.containsKey(type), "Missing handler for view %s", type);
}
}
@Override
public void doFilter(HttpServletRequest req, HttpServletResponse res, FilterChain chain)
throws IOException, ServletException {
GitilesView view = checkNotNull(ViewFilter.getView(req));
final Iterator<Filter> itr = filters.get(view.getType()).iterator();
final HttpServlet servlet = servlets.get(view.getType());
new FilterChain() {
@Override
public void doFilter(ServletRequest req, ServletResponse res)
throws IOException, ServletException {
if (itr.hasNext()) {
itr.next().doFilter(req, res, this);
} else {
servlet.service(req, res);
}
}
}.doFilter(req, res);
}
}
private final ListMultimap<GitilesView.Type, Filter> filters = LinkedListMultimap.create();
private final Map<GitilesView.Type, HttpServlet> servlets = Maps.newHashMap();
private Config config;
private Renderer renderer;
private GitilesUrls urls;
private Linkifier linkifier;
private GitilesAccess.Factory accessFactory;
private RepositoryResolver<HttpServletRequest> resolver;
private VisibilityCache visibilityCache;
private TimeCache timeCache;
private BlameCache blameCache;
private GitwebRedirectFilter gitwebRedirect;
private Filter errorHandler;
private boolean initialized;
GitilesFilter() {}
GitilesFilter(
Config config,
@Nullable Renderer renderer,
@Nullable GitilesUrls urls,
@Nullable GitilesAccess.Factory accessFactory,
@Nullable RepositoryResolver<HttpServletRequest> resolver,
@Nullable VisibilityCache visibilityCache,
@Nullable TimeCache timeCache,
@Nullable BlameCache blameCache,
@Nullable GitwebRedirectFilter gitwebRedirect,
@Nullable Filter errorHandler) {
this.config = checkNotNull(config, "config");
this.renderer = renderer;
this.urls = urls;
this.accessFactory = accessFactory;
this.visibilityCache = visibilityCache;
this.timeCache = timeCache;
this.blameCache = blameCache;
this.gitwebRedirect = gitwebRedirect;
if (resolver != null) {
this.resolver = resolver;
}
this.errorHandler = errorHandler;
}
@Override
public synchronized void init(FilterConfig config) throws ServletException {
super.init(config);
setDefaultFields(config);
for (GitilesView.Type type : GitilesView.Type.values()) {
if (!servlets.containsKey(type)) {
servlets.put(type, getDefaultHandler(type));
}
}
Filter repositoryFilter = new RepositoryFilter(resolver);
Filter viewFilter = new ViewFilter(accessFactory, urls, visibilityCache);
Filter dispatchFilter = new DispatchFilter(filters, servlets);
ServletBinder root = serveRegex(ROOT_REGEX).through(viewFilter);
if (gitwebRedirect != null) {
root.through(gitwebRedirect);
}
root.through(dispatchFilter);
serveRegex(REPO_REGEX).through(repositoryFilter).through(viewFilter).through(dispatchFilter);
serveRegex(REPO_PATH_REGEX)
.through(repositoryFilter)
.through(viewFilter)
.through(dispatchFilter);
initialized = true;
}
@Override
protected ServletBinder register(ServletBinder b) {
b.through(errorHandler);
return b;
}
public synchronized BaseServlet getDefaultHandler(GitilesView.Type view) {
checkNotInitialized();
switch (view) {
case HOST_INDEX:
return new HostIndexServlet(accessFactory, renderer, urls);
case REPOSITORY_INDEX:
return new RepositoryIndexServlet(accessFactory, renderer, timeCache);
case REFS:
return new RefServlet(accessFactory, renderer, timeCache);
case REVISION:
return new RevisionServlet(accessFactory, renderer, linkifier());
case SHOW:
case PATH:
return new PathServlet(accessFactory, renderer, urls);
case DIFF:
return new DiffServlet(accessFactory, renderer, linkifier());
case LOG:
return new LogServlet(accessFactory, renderer, linkifier());
case DESCRIBE:
return new DescribeServlet(accessFactory);
case ARCHIVE:
return new ArchiveServlet(accessFactory);
case BLAME:
return new BlameServlet(accessFactory, renderer, blameCache);
case DOC:
case ROOTED_DOC:
return new DocServlet(accessFactory, renderer);
default:
throw new IllegalArgumentException("Invalid view type: " + view);
}
}
public synchronized void setRenderer(Renderer renderer) {
checkNotInitialized();
this.renderer = checkNotNull(renderer, "renderer");
}
synchronized void addFilter(GitilesView.Type view, Filter filter) {
checkNotInitialized();
filters.put(checkNotNull(view, "view"), checkNotNull(filter, "filter for %s", view));
}
synchronized void setHandler(GitilesView.Type view, HttpServlet handler) {
checkNotInitialized();
servlets.put(checkNotNull(view, "view"), checkNotNull(handler, "handler for %s", view));
}
private synchronized void checkNotInitialized() {
checkState(!initialized, "Gitiles already initialized");
}
private synchronized Linkifier linkifier() {
if (linkifier == null) {
checkState(urls != null, "GitilesUrls not yet set");
linkifier = new Linkifier(urls, config);
}
return linkifier;
}
private void setDefaultFields(FilterConfig filterConfig) throws ServletException {
setDefaultConfig(filterConfig);
setDefaultRenderer(filterConfig);
setDefaultUrls();
setDefaultAccess();
setDefaultVisibilityCache();
setDefaultTimeCache();
setDefaultBlameCache();
setDefaultGitwebRedirect();
setDefaultErrorHandler();
}
private void setDefaultConfig(FilterConfig filterConfig) throws ServletException {
if (config == null) {
try {
config = GitilesConfig.loadDefault(filterConfig);
} catch (IOException | ConfigInvalidException e) {
throw new ServletException(e);
}
}
}
private void setDefaultRenderer(FilterConfig filterConfig) {
if (renderer == null) {
renderer =
new DefaultRenderer(
filterConfig.getServletContext().getContextPath() + STATIC_PREFIX,
Arrays.stream(config.getStringList("gitiles", null, "customTemplates"))
.map(fileUrlMapper())
.collect(toList()),
firstNonNull(config.getString("gitiles", null, "siteTitle"), "Gitiles"));
}
}
private void setDefaultUrls() throws ServletException {
if (urls == null) {
try {
urls =
new DefaultUrls(
config.getString("gitiles", null, "canonicalHostName"),
getBaseGitUrl(config),
config.getString("gitiles", null, "gerritUrl"));
} catch (UnknownHostException e) {
throw new ServletException(e);
}
}
}
private void setDefaultAccess() throws ServletException {
if (accessFactory == null || resolver == null) {
String basePath = config.getString("gitiles", null, "basePath");
if (basePath == null) {
throw new ServletException("gitiles.basePath not set");
}
boolean exportAll = config.getBoolean("gitiles", null, "exportAll", false);
FileResolver<HttpServletRequest> fileResolver;
if (resolver == null) {
fileResolver = new FileResolver<>(new File(basePath), exportAll);
resolver = fileResolver;
} else if (resolver instanceof FileResolver) {
fileResolver = (FileResolver<HttpServletRequest>) resolver;
} else {
fileResolver = null;
}
if (accessFactory == null) {
checkState(fileResolver != null, "need a FileResolver when GitilesAccess.Factory not set");
try {
accessFactory =
new DefaultAccess.Factory(
new File(basePath), getBaseGitUrl(config), config, fileResolver);
} catch (IOException e) {
throw new ServletException(e);
}
}
}
}
private void setDefaultVisibilityCache() {
if (visibilityCache == null) {
if (config.getSubsections("cache").contains("visibility")) {
visibilityCache = new VisibilityCache(ConfigUtil.getCacheBuilder(config, "visibility"));
} else {
visibilityCache = new VisibilityCache();
}
}
}
private void setDefaultTimeCache() {
if (timeCache == null) {
if (config.getSubsections("cache").contains("tagTime")) {
timeCache = new TimeCache(ConfigUtil.getCacheBuilder(config, "tagTime"));
} else {
timeCache = new TimeCache();
}
}
}
private void setDefaultBlameCache() {
if (blameCache == null) {
if (config.getSubsections("cache").contains("blame")) {
blameCache = new BlameCacheImpl(ConfigUtil.getCacheBuilder(config, "blame"));
} else {
blameCache = new BlameCacheImpl();
}
}
}
private void setDefaultGitwebRedirect() {
if (gitwebRedirect == null) {
if (config.getBoolean("gitiles", null, "redirectGitweb", true)) {
gitwebRedirect = new GitwebRedirectFilter();
}
}
}
private void setDefaultErrorHandler() {
if (errorHandler == null) {
errorHandler = new DefaultErrorHandlingFilter(renderer);
}
}
private static String getBaseGitUrl(Config config) throws ServletException {
String baseGitUrl = config.getString("gitiles", null, "baseGitUrl");
if (baseGitUrl == null) {
throw new ServletException("gitiles.baseGitUrl not set");
}
return baseGitUrl;
}
}