ProtocolV2Parser.java

  1. /*
  2.  * Copyright (C) 2018, Google LLC. and others
  3.  *
  4.  * This program and the accompanying materials are made available under the
  5.  * terms of the Eclipse Distribution License v. 1.0 which is available at
  6.  * https://www.eclipse.org/org/documents/edl-v10.php.
  7.  *
  8.  * SPDX-License-Identifier: BSD-3-Clause
  9.  */
  10. package org.eclipse.jgit.transport;

  12. import static org.eclipse.jgit.transport.GitProtocolConstants.OPTION_DEEPEN_RELATIVE;
  13. import static org.eclipse.jgit.transport.GitProtocolConstants.OPTION_FILTER;
  14. import static org.eclipse.jgit.transport.GitProtocolConstants.OPTION_AGENT;
  15. import static org.eclipse.jgit.transport.GitProtocolConstants.OPTION_INCLUDE_TAG;
  16. import static org.eclipse.jgit.transport.GitProtocolConstants.OPTION_NO_PROGRESS;
  17. import static org.eclipse.jgit.transport.GitProtocolConstants.OPTION_OFS_DELTA;
  18. import static org.eclipse.jgit.transport.GitProtocolConstants.OPTION_SERVER_OPTION;
  19. import static org.eclipse.jgit.transport.GitProtocolConstants.OPTION_SIDEBAND_ALL;
  20. import static org.eclipse.jgit.transport.GitProtocolConstants.OPTION_SIDE_BAND_64K;
  21. import static org.eclipse.jgit.transport.GitProtocolConstants.OPTION_THIN_PACK;
  22. import static org.eclipse.jgit.transport.GitProtocolConstants.OPTION_WANT_REF;

  24. import java.io.IOException;
  25. import java.text.MessageFormat;
  26. import java.util.ArrayList;
  27. import java.util.List;
  28. import java.util.function.Consumer;

  30. import org.eclipse.jgit.errors.PackProtocolException;
  31. import org.eclipse.jgit.internal.JGitText;
  32. import org.eclipse.jgit.lib.ObjectId;

  34. /**
  35.  * Parse the incoming git protocol lines from the wire and translate them into a
  36.  * Request object.
  37.  *
  38.  * It requires a transferConfig object to know what the server supports (e.g.
  39.  * ref-in-want and/or filters).
  40.  */
  41. final class ProtocolV2Parser {

  43.     private final TransferConfig transferConfig;

  45.     ProtocolV2Parser(TransferConfig transferConfig) {
  46.         this.transferConfig = transferConfig;
  47.     }

  49.     /*
  50.      * Read lines until DELIM or END, calling the appropiate consumer.
  51.      *
  52.      * Returns the last read line (so caller can check if there is more to read
  53.      * in the line).
  54.      */
  55.     private static String consumeCapabilities(PacketLineIn pckIn,
  56.             Consumer<String> serverOptionConsumer,
  57.             Consumer<String> agentConsumer) throws IOException {

  59.         String serverOptionPrefix = OPTION_SERVER_OPTION + '=';
  60.         String agentPrefix = OPTION_AGENT + '=';

  62.         String line = pckIn.readString();
  63.         while (!PacketLineIn.isDelimiter(line) && !PacketLineIn.isEnd(line)) {
  64.             if (line.startsWith(serverOptionPrefix)) {
  65.                 serverOptionConsumer
  66.                         .accept(line.substring(serverOptionPrefix.length()));
  67.             } else if (line.startsWith(agentPrefix)) {
  68.                 agentConsumer.accept(line.substring(agentPrefix.length()));
  69.             } else {
  70.                 // Unrecognized capability. Ignore it.
  71.             }
  72.             line = pckIn.readString();
  73.         }

  75.         return line;
  76.     }

  78.     /**
  79.      * Parse the incoming fetch request arguments from the wire. The caller must
  80.      * be sure that what is comings is a fetch request before coming here.
  81.      *
  82.      * @param pckIn
  83.      *            incoming lines
  84.      * @return A FetchV2Request populated with information received from the
  85.      *         wire.
  86.      * @throws PackProtocolException
  87.      *             incompatible options, wrong type of arguments or other issues
  88.      *             where the request breaks the protocol.
  89.      * @throws IOException
  90.      *             an IO error prevented reading the incoming message.
  91.      */
  92.     FetchV2Request parseFetchRequest(PacketLineIn pckIn)
  93.             throws PackProtocolException, IOException {
  94.         FetchV2Request.Builder reqBuilder = FetchV2Request.builder();

  96.         // Packs are always sent multiplexed and using full 64K
  97.         // lengths.
  98.         reqBuilder.addClientCapability(OPTION_SIDE_BAND_64K);

  100.         String line = consumeCapabilities(pckIn,
  101.                 serverOption -> reqBuilder.addServerOption(serverOption),
  102.                 agent -> reqBuilder.setAgent(agent));

  104.         if (PacketLineIn.isEnd(line)) {
  105.             return reqBuilder.build();
  106.         }

  108.         if (!PacketLineIn.isDelimiter(line)) {
  109.             throw new PackProtocolException(
  110.                     MessageFormat.format(JGitText.get().unexpectedPacketLine,
  111.                             line));
  112.         }

  114.         boolean filterReceived = false;
  115.         for (String line2 : pckIn.readStrings()) {
  116.             if (line2.startsWith("want ")) { //$NON-NLS-1$
  117.                 reqBuilder.addWantId(ObjectId.fromString(line2.substring(5)));
  118.             } else if (transferConfig.isAllowRefInWant()
  119.                     && line2.startsWith(OPTION_WANT_REF + " ")) { //$NON-NLS-1$
  120.                 reqBuilder.addWantedRef(
  121.                         line2.substring(OPTION_WANT_REF.length() + 1));
  122.             } else if (line2.startsWith("have ")) { //$NON-NLS-1$
  123.                 reqBuilder.addPeerHas(ObjectId.fromString(line2.substring(5)));
  124.             } else if (line2.equals("done")) { //$NON-NLS-1$
  125.                 reqBuilder.setDoneReceived();
  126.             } else if (line2.equals(OPTION_THIN_PACK)) {
  127.                 reqBuilder.addClientCapability(OPTION_THIN_PACK);
  128.             } else if (line2.equals(OPTION_NO_PROGRESS)) {
  129.                 reqBuilder.addClientCapability(OPTION_NO_PROGRESS);
  130.             } else if (line2.equals(OPTION_INCLUDE_TAG)) {
  131.                 reqBuilder.addClientCapability(OPTION_INCLUDE_TAG);
  132.             } else if (line2.equals(OPTION_OFS_DELTA)) {
  133.                 reqBuilder.addClientCapability(OPTION_OFS_DELTA);
  134.             } else if (line2.startsWith("shallow ")) { //$NON-NLS-1$
  135.                 reqBuilder.addClientShallowCommit(
  136.                         ObjectId.fromString(line2.substring(8)));
  137.             } else if (line2.startsWith("deepen ")) { //$NON-NLS-1$
  138.                 int parsedDepth = Integer.parseInt(line2.substring(7));
  139.                 if (parsedDepth <= 0) {
  140.                     throw new PackProtocolException(
  141.                             MessageFormat.format(JGitText.get().invalidDepth,
  142.                                     Integer.valueOf(parsedDepth)));
  143.                 }
  144.                 if (reqBuilder.getDeepenSince() != 0) {
  145.                     throw new PackProtocolException(
  146.                             JGitText.get().deepenSinceWithDeepen);
  147.                 }
  148.                 if (reqBuilder.hasDeepenNotRefs()) {
  149.                     throw new PackProtocolException(
  150.                             JGitText.get().deepenNotWithDeepen);
  151.                 }
  152.                 reqBuilder.setDepth(parsedDepth);
  153.             } else if (line2.startsWith("deepen-not ")) { //$NON-NLS-1$
  154.                 reqBuilder.addDeepenNotRef(line2.substring(11));
  155.                 if (reqBuilder.getDepth() != 0) {
  156.                     throw new PackProtocolException(
  157.                             JGitText.get().deepenNotWithDeepen);
  158.                 }
  159.             } else if (line2.equals(OPTION_DEEPEN_RELATIVE)) {
  160.                 reqBuilder.addClientCapability(OPTION_DEEPEN_RELATIVE);
  161.             } else if (line2.startsWith("deepen-since ")) { //$NON-NLS-1$
  162.                 int ts = Integer.parseInt(line2.substring(13));
  163.                 if (ts <= 0) {
  164.                     throw new PackProtocolException(MessageFormat
  165.                             .format(JGitText.get().invalidTimestamp, line2));
  166.                 }
  167.                 if (reqBuilder.getDepth() != 0) {
  168.                     throw new PackProtocolException(
  169.                             JGitText.get().deepenSinceWithDeepen);
  170.                 }
  171.                 reqBuilder.setDeepenSince(ts);
  172.             } else if (transferConfig.isAllowFilter()
  173.                     && line2.startsWith(OPTION_FILTER + ' ')) {
  174.                 if (filterReceived) {
  175.                     throw new PackProtocolException(
  176.                             JGitText.get().tooManyFilters);
  177.                 }
  178.                 filterReceived = true;
  179.                 reqBuilder.setFilterSpec(FilterSpec.fromFilterLine(
  180.                         line2.substring(OPTION_FILTER.length() + 1)));
  181.             } else if (transferConfig.isAllowSidebandAll()
  182.                     && line2.equals(OPTION_SIDEBAND_ALL)) {
  183.                 reqBuilder.setSidebandAll(true);
  184.             } else if (line2.startsWith("packfile-uris ")) { //$NON-NLS-1$
  185.                 for (String s : line2.substring(14).split(",")) { //$NON-NLS-1$
  186.                     reqBuilder.addPackfileUriProtocol(s);
  187.                 }
  188.             } else {
  189.                 throw new PackProtocolException(MessageFormat
  190.                         .format(JGitText.get().unexpectedPacketLine, line2));
  191.             }
  192.         }

  194.         return reqBuilder.build();
  195.     }

  197.     /**
  198.      * Parse the incoming ls-refs request arguments from the wire. This is meant
  199.      * for calling immediately after the caller has consumed a "command=ls-refs"
  200.      * line indicating the beginning of a ls-refs request.
  201.      *
  202.      * The incoming PacketLineIn is consumed until an END line, but the caller
  203.      * is responsible for closing it (if needed)
  204.      *
  205.      * @param pckIn
  206.      *            incoming lines. This method will read until an END line.
  207.      * @return a LsRefsV2Request object with the data received in the wire.
  208.      * @throws PackProtocolException
  209.      *             for inconsistencies in the protocol (e.g. unexpected lines)
  210.      * @throws IOException
  211.      *             reporting problems reading the incoming messages from the
  212.      *             wire
  213.      */
  214.     LsRefsV2Request parseLsRefsRequest(PacketLineIn pckIn)
  215.             throws PackProtocolException, IOException {
  216.         LsRefsV2Request.Builder builder = LsRefsV2Request.builder();
  217.         List<String> prefixes = new ArrayList<>();

  219.         String line = consumeCapabilities(pckIn,
  220.                 serverOption -> builder.addServerOption(serverOption),
  221.                 agent -> builder.setAgent(agent));

  223.         if (PacketLineIn.isEnd(line)) {
  224.             return builder.build();
  225.         }

  227.         if (!PacketLineIn.isDelimiter(line)) {
  228.             throw new PackProtocolException(MessageFormat
  229.                     .format(JGitText.get().unexpectedPacketLine, line));
  230.         }

  232.         for (String line2 : pckIn.readStrings()) {
  233.             if (line2.equals("peel")) { //$NON-NLS-1$
  234.                 builder.setPeel(true);
  235.             } else if (line2.equals("symrefs")) { //$NON-NLS-1$
  236.                 builder.setSymrefs(true);
  237.             } else if (line2.startsWith("ref-prefix ")) { //$NON-NLS-1$
  238.                 prefixes.add(line2.substring("ref-prefix ".length())); //$NON-NLS-1$
  239.             } else {
  240.                 throw new PackProtocolException(MessageFormat
  241.                         .format(JGitText.get().unexpectedPacketLine, line2));
  242.             }
  243.         }

  245.         return builder.setRefPrefixes(prefixes).build();
  246.     }

  248. }
Created with JaCoCo 0.8.6.202009150832