1 /*
2 * Copyright (C) 2018, Google LLC.
3 * and other copyright owners as documented in the project's IP log.
4 *
5 * This program and the accompanying materials are made available
6 * under the terms of the Eclipse Distribution License v1.0 which
7 * accompanies this distribution, is reproduced below, and is
8 * available at http://www.eclipse.org/org/documents/edl-v10.php
9 *
10 * All rights reserved.
11 *
12 * Redistribution and use in source and binary forms, with or
13 * without modification, are permitted provided that the following
14 * conditions are met:
15 *
16 * - Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 *
19 * - Redistributions in binary form must reproduce the above
20 * copyright notice, this list of conditions and the following
21 * disclaimer in the documentation and/or other materials provided
22 * with the distribution.
23 *
24 * - Neither the name of the Eclipse Foundation, Inc. nor the
25 * names of its contributors may be used to endorse or promote
26 * products derived from this software without specific prior
27 * written permission.
28 *
29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
30 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
31 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
32 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
34 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
35 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
36 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
37 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
38 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42 */
43 package org.eclipse.jgit.transport;
44
45 import static org.eclipse.jgit.transport.GitProtocolConstants.OPTION_FILTER;
46
47 import java.io.EOFException;
48 import java.io.IOException;
49 import java.text.MessageFormat;
50
51 import org.eclipse.jgit.errors.PackProtocolException;
52 import org.eclipse.jgit.internal.JGitText;
53 import org.eclipse.jgit.internal.transport.parser.FirstWant;
54 import org.eclipse.jgit.lib.ObjectId;
55
56 /**
57 * Parser for git protocol versions 0 and 1.
58 *
59 * It reads the lines coming through the {@link PacketLineIn} and builds a
60 * {@link FetchV0Request} object.
61 *
62 * It requires a transferConfig object to know if the server supports filters.
63 */
64 final class ProtocolV0Parser {
65
66 private final TransferConfig transferConfig;
67
68 ProtocolV0Parser(TransferConfig transferConfig) {
69 this.transferConfig = transferConfig;
70 }
71
72 /**
73 * Parse an incoming protocol v1 upload request arguments from the wire.
74 *
75 * The incoming PacketLineIn is consumed until an END line, but the caller
76 * is responsible for closing it (if needed).
77 *
78 * @param pckIn
79 * incoming lines. This method will read until an END line.
80 * @return a FetchV0Request with the data received in the wire.
81 * @throws PackProtocolException
82 * @throws IOException
83 */
84 FetchV0Request recvWants(PacketLineIn pckIn)
85 throws PackProtocolException, IOException {
86 FetchV0Request.Builder reqBuilder = new FetchV0Request.Builder();
87
88 boolean isFirst = true;
89 boolean filterReceived = false;
90
91 for (;;) {
92 String line;
93 try {
94 line = pckIn.readString();
95 } catch (EOFException eof) {
96 if (isFirst) {
97 break;
98 }
99 throw eof;
100 }
101
102 if (PacketLineIn.isEnd(line)) {
103 break;
104 }
105
106 if (line.startsWith("deepen ")) { //$NON-NLS-1$
107 int depth = Integer.parseInt(line.substring(7));
108 if (depth <= 0) {
109 throw new PackProtocolException(
110 MessageFormat.format(JGitText.get().invalidDepth,
111 Integer.valueOf(depth)));
112 }
113 reqBuilder.setDepth(depth);
114 continue;
115 }
116
117 if (line.startsWith("shallow ")) { //$NON-NLS-1$
118 reqBuilder.addClientShallowCommit(
119 ObjectId.fromString(line.substring(8)));
120 continue;
121 }
122
123 if (transferConfig.isAllowFilter()
124 && line.startsWith(OPTION_FILTER + " ")) { //$NON-NLS-1$
125 String arg = line.substring(OPTION_FILTER.length() + 1);
126
127 if (filterReceived) {
128 throw new PackProtocolException(
129 JGitText.get().tooManyFilters);
130 }
131 filterReceived = true;
132
133 reqBuilder.setFilterSpec(FilterSpec.fromFilterLine(arg));
134 continue;
135 }
136
137 if (!line.startsWith("want ") || line.length() < 45) { //$NON-NLS-1$
138 throw new PackProtocolException(MessageFormat
139 .format(JGitText.get().expectedGot, "want", line)); //$NON-NLS-1$
140 }
141
142 if (isFirst) {
143 if (line.length() > 45) {
144 FirstWant firstLine = FirstWant.fromLine(line);
145 reqBuilder.addClientCapabilities(firstLine.getCapabilities());
146 reqBuilder.setAgent(firstLine.getAgent());
147 line = firstLine.getLine();
148 }
149 }
150
151 reqBuilder.addWantId(ObjectId.fromString(line.substring(5)));
152 isFirst = false;
153 }
154
155 return reqBuilder.build();
156 }
157
158 }