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.internal.transport.parser;
44
45 import static java.util.Arrays.asList;
46 import static java.util.Collections.emptySet;
47 import static java.util.Collections.unmodifiableSet;
48 import static java.util.stream.Collectors.toSet;
49
50 import java.util.Set;
51
52 import org.eclipse.jgit.annotations.NonNull;
53
54 /**
55 * In a push, the client sends a list of commands. The first command
56 * is special, as it can include a list of capabilities at its end.
57 * <p>
58 * For example:
59 * "oid oid name\0cap1 cap cap3"
60 * <p>
61 * Not to be confused with {@link FirstWant}, nor with the first line
62 * of the reference advertisement parsed by
63 * {@code BasePackConnection.readAdvertisedRefs}.
64 * <p>
65 * This class parses the inputted command line and holds the results:
66 * the actual command line and the capabilities.
67 */
68 public final class FirstCommand {
69 private final String line;
70 private final Set<String> capabilities;
71
72 /**
73 * Parse the first line of a receive-pack request.
74 *
75 * @param line
76 * line from the client.
77 * @return an instance of FirstCommand with capabilities parsed out
78 */
79 @NonNull
80 public static FirstCommand fromLine(String line) {
81 int nul = line.indexOf('\0');
82 if (nul < 0) {
83 return new FirstCommand(line, emptySet());
84 }
85 Set<String> opts =
86 asList(line.substring(nul + 1).split(" ")) //$NON-NLS-1$
87 .stream()
88 .collect(toSet());
89 return new FirstCommand(line.substring(0, nul), unmodifiableSet(opts));
90 }
91
92 private FirstCommand(String line, Set<String> capabilities) {
93 this.line = line;
94 this.capabilities = capabilities;
95 }
96
97 /** @return non-capabilities part of the line. */
98 @NonNull
99 public String getLine() {
100 return line;
101 }
102
103 /** @return capabilities parsed from the line, as an immutable set. */
104 @NonNull
105 public Set<String> getCapabilities() {
106 return capabilities;
107 }
108 }