1 /*
2 * Copyright (C) 2008-2009, Google Inc.
3 * Copyright (C) 2009, Robin Rosenberg <robin.rosenberg@dewire.com>
4 * and other copyright owners as documented in the project's IP log.
5 *
6 * This program and the accompanying materials are made available
7 * under the terms of the Eclipse Distribution License v1.0 which
8 * accompanies this distribution, is reproduced below, and is
9 * available at http://www.eclipse.org/org/documents/edl-v10.php
10 *
11 * All rights reserved.
12 *
13 * Redistribution and use in source and binary forms, with or
14 * without modification, are permitted provided that the following
15 * conditions are met:
16 *
17 * - Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
19 *
20 * - Redistributions in binary form must reproduce the above
21 * copyright notice, this list of conditions and the following
22 * disclaimer in the documentation and/or other materials provided
23 * with the distribution.
24 *
25 * - Neither the name of the Eclipse Foundation, Inc. nor the
26 * names of its contributors may be used to endorse or promote
27 * products derived from this software without specific prior
28 * written permission.
29 *
30 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
31 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
32 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
33 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
34 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
35 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
36 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
37 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
38 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
39 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
40 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
41 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
42 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
43 */
44
45 package org.eclipse.jgit.transport;
46
47 import java.io.IOException;
48
49 import org.eclipse.jgit.lib.Config;
50 import org.eclipse.jgit.lib.Config.SectionParser;
51 import org.eclipse.jgit.lib.Repository;
52 import org.eclipse.jgit.transport.resolver.ServiceNotAuthorizedException;
53 import org.eclipse.jgit.transport.resolver.ServiceNotEnabledException;
54
55 /**
56 * A service exposed by {@link org.eclipse.jgit.transport.Daemon} over anonymous
57 * <code>git://</code>.
58 */
59 public abstract class DaemonService {
60 private final String command;
61
62 private final SectionParser<ServiceConfig> configKey;
63
64 private boolean enabled;
65
66 private boolean overridable;
67
68 DaemonService(final String cmdName, final String cfgName) {
69 command = cmdName.startsWith("git-") ? cmdName : "git-" + cmdName; //$NON-NLS-1$ //$NON-NLS-2$
70 configKey = cfg -> new ServiceConfig(DaemonService.this, cfg, cfgName);
71 overridable = true;
72 }
73
74 private static class ServiceConfig {
75 final boolean enabled;
76
77 ServiceConfig(final DaemonService service, final Config cfg,
78 final String name) {
79 enabled = cfg.getBoolean("daemon", name, service.isEnabled()); //$NON-NLS-1$
80 }
81 }
82
83 /**
84 * Whether this service is enabled for invocation.
85 *
86 * @return whether this service is enabled for invocation.
87 */
88 public boolean isEnabled() {
89 return enabled;
90 }
91
92 /**
93 * Set if it is allowed to use this service
94 *
95 * @param on
96 * {@code true} to allow this service to be used; {@code false}
97 * to deny it.
98 */
99 public void setEnabled(final boolean on) {
100 enabled = on;
101 }
102
103 /** @return can this service be configured in the repository config file? */
104 /**
105 * Whether this service can be configured in the repository config file
106 *
107 * @return whether this service can be configured in the repository config
108 * file
109 */
110 public boolean isOverridable() {
111 return overridable;
112 }
113
114 /**
115 * Whether to permit repositories to override this service's enabled state
116 * with the <code>daemon.servicename</code> config setting.
117 *
118 * @param on
119 * {@code true} to permit repositories to override this service's
120 * enabled state with the <code>daemon.servicename</code> config
121 * setting.
122 */
123 public void setOverridable(final boolean on) {
124 overridable = on;
125 }
126
127 /**
128 * Get name of the command requested by clients.
129 *
130 * @return name of the command requested by clients.
131 */
132 public String getCommandName() {
133 return command;
134 }
135
136 /**
137 * Determine if this service can handle the requested command.
138 *
139 * @param commandLine
140 * input line from the client.
141 * @return true if this command can accept the given command line.
142 */
143 public boolean handles(final String commandLine) {
144 return command.length() + 1 < commandLine.length()
145 && commandLine.charAt(command.length()) == ' '
146 && commandLine.startsWith(command);
147 }
148
149 void execute(final DaemonClient client, final String commandLine)
150 throws IOException, ServiceNotEnabledException,
151 ServiceNotAuthorizedException {
152 final String name = commandLine.substring(command.length() + 1);
153 Repository db;
154 try {
155 db = client.getDaemon().openRepository(client, name);
156 } catch (ServiceMayNotContinueException e) {
157 // An error when opening the repo means the client is expecting a ref
158 // advertisement, so use that style of error.
159 PacketLineOut pktOut = new PacketLineOut(client.getOutputStream());
160 pktOut.writeString("ERR " + e.getMessage() + "\n"); //$NON-NLS-1$ //$NON-NLS-2$
161 db = null;
162 }
163 if (db == null)
164 return;
165 try {
166 if (isEnabledFor(db))
167 execute(client, db);
168 } finally {
169 db.close();
170 }
171 }
172
173 private boolean isEnabledFor(final Repository db) {
174 if (isOverridable())
175 return db.getConfig().get(configKey).enabled;
176 return isEnabled();
177 }
178
179 abstract void execute(DaemonClient client, Repository db)
180 throws IOException, ServiceNotEnabledException,
181 ServiceNotAuthorizedException;
182 }