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
|
/*
* Copyright (C) 2018, Google LLC. 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.internal.transport.parser;
import static org.eclipse.jgit.transport.GitProtocolConstants.OPTION_AGENT;
import static org.eclipse.jgit.transport.GitProtocolConstants.OPTION_SESSION_ID;
import java.util.Collections;
import java.util.HashSet;
import java.util.Set;
import org.eclipse.jgit.annotations.Nullable;
import org.eclipse.jgit.errors.PackProtocolException;
import org.eclipse.jgit.internal.JGitText;
/**
* In the pack negotiation phase (protocol v0/v1), the client sends a list of
* wants. The first "want" line is special, as it (can) have a list of
* capabilities appended.
*
* E.g. "want oid cap1 cap2 cap3"
*
* Do not confuse this line with the first one in the reference advertisement,
* which is sent by the server, looks like
* "b8f7c471373b8583ced0025cfad8c9916c484b76 HEAD\0 cap1 cap2 cap3" and is
* parsed by the BasePackConnection.readAdvertisedRefs method.
*
* This class parses the input want line and holds the results: the actual want
* line and the capabilities.
*
*/
public class FirstWant {
private final String line;
private final Set<String> capabilities;
@Nullable
private final String agent;
@Nullable
private final String clientSID;
private static final String AGENT_PREFIX = OPTION_AGENT + '=';
private static final String SESSION_ID_PREFIX = OPTION_SESSION_ID + '=';
/**
* Parse the first want line in the protocol v0/v1 pack negotiation.
*
* @param line
* line from the client.
* @return an instance of FirstWant
* @throws PackProtocolException
* if the line doesn't follow the protocol format.
*/
public static FirstWant fromLine(String line) throws PackProtocolException {
String wantLine;
Set<String> capabilities;
String agent = null;
String clientSID = null;
if (line.length() > 45) {
String opt = line.substring(45);
if (!opt.startsWith(" ")) { //$NON-NLS-1$
throw new PackProtocolException(JGitText.get().wantNoSpaceWithCapabilities);
}
opt = opt.substring(1);
HashSet<String> opts = new HashSet<>();
for (String clientCapability : opt.split(" ")) { //$NON-NLS-1$
if (clientCapability.startsWith(AGENT_PREFIX)) {
agent = clientCapability.substring(AGENT_PREFIX.length());
} else if (clientCapability.startsWith(SESSION_ID_PREFIX)) {
clientSID = clientCapability
.substring(SESSION_ID_PREFIX.length());
} else {
opts.add(clientCapability);
}
}
wantLine = line.substring(0, 45);
capabilities = Collections.unmodifiableSet(opts);
} else {
wantLine = line;
capabilities = Collections.emptySet();
}
return new FirstWant(wantLine, capabilities, agent, clientSID);
}
private FirstWant(String line, Set<String> capabilities,
@Nullable String agent, @Nullable String clientSID) {
this.line = line;
this.capabilities = capabilities;
this.agent = agent;
this.clientSID = clientSID;
}
/**
* Get line
*
* @return non-capabilities part of the line.
*/
public String getLine() {
return line;
}
/**
* Get capabilities
*
* @return capabilities parsed from the line as an immutable set (excluding
* agent and session-id).
*/
public Set<String> getCapabilities() {
return capabilities;
}
/**
* Get agent
*
* @return client user agent parsed from the line.
*/
@Nullable
public String getAgent() {
return agent;
}
/**
* Get client session-id
*
* @return client session-id parsed from the line.
*/
@Nullable
public String getClientSID() {
return clientSID;
}
}
|
