From 5b1513a28d337e7e3453e557ee9dde292678eb81 Mon Sep 17 00:00:00 2001
From: pszlazak <piotr.szlazak@gmail.com>
Date: Sun, 17 Nov 2024 23:11:02 +0100
Subject: [PATCH] Align request policies with CGit

CGit defines the SHA request policies using a bitmask
that represents which policy is implied by another policy.

For example, in CGit the ALLOW_TIP_SHA1 is 0x01 and ALLOW_REACHABLE_SHA1
is 0x02, which are associated to two different bit in a 3-bit value.
The ALLOW_ANY_SHA1 value is 0x07 which denotes a different policy that
implies the previous two ones, because is represented with a 3-bit
bitmask having all ones.

Associate the JGit RequestPolicy enum to the same CGit bitmask values
and use the same logic for the purpose of advertising the server
capabilities.

The JGit code becomes easier to read and associate with its counterpart
in CGit, especially during the capabilities advertising phase.

Also add a new utility method RequestPolicy.implies() which is more
readable than a direct bitmask and operator.

Bug: jgit-68
Change-Id: I932150dca1211ba9c8c34a523f13e84d7390063b
(cherry picked from commit 1519c147948eb1108bdf45f2aeed84746dacff9c)
---
 .../eclipse/jgit/transport/UploadPack.java    | 38 ++++++++++++-------
 1 file changed, 25 insertions(+), 13 deletions(-)

diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/transport/UploadPack.java b/org.eclipse.jgit/src/org/eclipse/jgit/transport/UploadPack.java
index 1dcfe5691f8..e9ea9b25a6a 100644
--- a/org.eclipse.jgit/src/org/eclipse/jgit/transport/UploadPack.java
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/transport/UploadPack.java
@@ -118,13 +118,13 @@ public class UploadPack implements Closeable {
 	/** Policy the server uses to validate client requests */
 	public enum RequestPolicy {
 		/** Client may only ask for objects the server advertised a reference for. */
-		ADVERTISED,
+		ADVERTISED(0x08),
 
 		/**
 		 * Client may ask for any commit reachable from a reference advertised by
 		 * the server.
 		 */
-		REACHABLE_COMMIT,
+		REACHABLE_COMMIT(0x02),
 
 		/**
 		 * Client may ask for objects that are the tip of any reference, even if not
@@ -134,18 +134,34 @@ public enum RequestPolicy {
 		 *
 		 * @since 3.1
 		 */
-		TIP,
+		TIP(0x01),
 
 		/**
 		 * Client may ask for any commit reachable from any reference, even if that
-		 * reference wasn't advertised.
+		 * reference wasn't advertised, implies REACHABLE_COMMIT and TIP.
 		 *
 		 * @since 3.1
 		 */
-		REACHABLE_COMMIT_TIP,
+		REACHABLE_COMMIT_TIP(0x03),
 
-		/** Client may ask for any SHA-1 in the repository. */
-		ANY;
+		/** Client may ask for any SHA-1 in the repository, implies REACHABLE_COMMIT_TIP. */
+		ANY(0x07);
+
+		private final int bitmask;
+
+		RequestPolicy(int bitmask) {
+			this.bitmask = bitmask;
+		}
+
+		/**
+		 * Check if the current policy implies another, based on its bitmask.
+		 *
+		 * @param implied the implied policy based on its bitmask.
+		 * @return true if the policy is implied.
+		 */
+		public boolean implies(RequestPolicy implied) {
+			return (bitmask & implied.bitmask) != 0;
+		}
 	}
 
 	/**
@@ -1629,13 +1645,9 @@ public void sendAdvertisedRefs(RefAdvertiser adv,
 		if (!biDirectionalPipe)
 			adv.advertiseCapability(OPTION_NO_DONE);
 		RequestPolicy policy = getRequestPolicy();
-		if (policy == RequestPolicy.TIP
-				|| policy == RequestPolicy.REACHABLE_COMMIT_TIP
-				|| policy == null)
+		if (policy == null || policy.implies(RequestPolicy.TIP))
 			adv.advertiseCapability(OPTION_ALLOW_TIP_SHA1_IN_WANT);
-		if (policy == RequestPolicy.REACHABLE_COMMIT
-				|| policy == RequestPolicy.REACHABLE_COMMIT_TIP
-				|| policy == null)
+		if (policy == null || policy.implies(RequestPolicy.REACHABLE_COMMIT))
 			adv.advertiseCapability(OPTION_ALLOW_REACHABLE_SHA1_IN_WANT);
 		adv.advertiseCapability(OPTION_AGENT, UserAgent.get());
 		if (transferConfig.isAllowFilter()) {