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
|
/*
* Copyright (C) 2008-2009, Google Inc.
* Copyright (C) 2009, Robin Rosenberg <robin.rosenberg@dewire.com>
* and other copyright owners as documented in the project's IP log.
*
* This program and the accompanying materials are made available
* under the terms of the Eclipse Distribution License v1.0 which
* accompanies this distribution, is reproduced below, and is
* available at http://www.eclipse.org/org/documents/edl-v10.php
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or
* without modification, are permitted provided that the following
* conditions are met:
*
* - Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* - Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided
* with the distribution.
*
* - Neither the name of the Eclipse Foundation, Inc. nor the
* names of its contributors may be used to endorse or promote
* products derived from this software without specific prior
* written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.eclipse.jgit.transport;
import java.io.IOException;
import java.util.Collection;
import org.eclipse.jgit.annotations.Nullable;
import org.eclipse.jgit.lib.Config;
import org.eclipse.jgit.lib.Config.SectionParser;
import org.eclipse.jgit.lib.Repository;
import org.eclipse.jgit.transport.resolver.ServiceNotAuthorizedException;
import org.eclipse.jgit.transport.resolver.ServiceNotEnabledException;
/**
* A service exposed by {@link org.eclipse.jgit.transport.Daemon} over anonymous
* <code>git://</code>.
*/
public abstract class DaemonService {
private final String command;
private final SectionParser<ServiceConfig> configKey;
private boolean enabled;
private boolean overridable;
DaemonService(String cmdName, String cfgName) {
command = cmdName.startsWith("git-") ? cmdName : "git-" + cmdName; //$NON-NLS-1$ //$NON-NLS-2$
configKey = cfg -> new ServiceConfig(DaemonService.this, cfg, cfgName);
overridable = true;
}
private static class ServiceConfig {
final boolean enabled;
ServiceConfig(final DaemonService service, final Config cfg,
final String name) {
enabled = cfg.getBoolean("daemon", name, service.isEnabled()); //$NON-NLS-1$
}
}
/**
* Whether this service is enabled for invocation.
*
* @return whether this service is enabled for invocation.
*/
public boolean isEnabled() {
return enabled;
}
/**
* Set if it is allowed to use this service
*
* @param on
* {@code true} to allow this service to be used; {@code false}
* to deny it.
*/
public void setEnabled(boolean on) {
enabled = on;
}
/** @return can this service be configured in the repository config file? */
/**
* Whether this service can be configured in the repository config file
*
* @return whether this service can be configured in the repository config
* file
*/
public boolean isOverridable() {
return overridable;
}
/**
* Whether to permit repositories to override this service's enabled state
* with the <code>daemon.servicename</code> config setting.
*
* @param on
* {@code true} to permit repositories to override this service's
* enabled state with the <code>daemon.servicename</code> config
* setting.
*/
public void setOverridable(boolean on) {
overridable = on;
}
/**
* Get name of the command requested by clients.
*
* @return name of the command requested by clients.
*/
public String getCommandName() {
return command;
}
/**
* Determine if this service can handle the requested command.
*
* @param commandLine
* input line from the client.
* @return true if this command can accept the given command line.
*/
public boolean handles(String commandLine) {
return command.length() + 1 < commandLine.length()
&& commandLine.charAt(command.length()) == ' '
&& commandLine.startsWith(command);
}
void execute(DaemonClient client, String commandLine,
@Nullable Collection<String> extraParameters)
throws IOException, ServiceNotEnabledException,
ServiceNotAuthorizedException {
final String name = commandLine.substring(command.length() + 1);
try (Repository db = client.getDaemon().openRepository(client, name)) {
if (isEnabledFor(db)) {
execute(client, db, extraParameters);
}
} catch (ServiceMayNotContinueException e) {
// An error when opening the repo means the client is expecting a ref
// advertisement, so use that style of error.
PacketLineOut pktOut = new PacketLineOut(client.getOutputStream());
pktOut.writeString("ERR " + e.getMessage() + "\n"); //$NON-NLS-1$ //$NON-NLS-2$
}
}
private boolean isEnabledFor(Repository db) {
if (isOverridable())
return db.getConfig().get(configKey).enabled;
return isEnabled();
}
abstract void execute(DaemonClient client, Repository db,
@Nullable Collection<String> extraParameters)
throws IOException, ServiceNotEnabledException,
ServiceNotAuthorizedException;
}
|
