/* * SonarQube * Copyright (C) 2009-2025 SonarSource SA * mailto:info AT sonarsource DOT com * * This program is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 3 of the License, or (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public License * along with this program; if not, write to the Free Software Foundation, * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ package org.sonar.alm.client; import java.io.IOException; import java.net.MalformedURLException; import java.net.URL; import java.util.Optional; import java.util.function.Function; import java.util.regex.Matcher; import java.util.regex.Pattern; import javax.annotation.CheckForNull; import javax.annotation.Nullable; import okhttp3.FormBody; import okhttp3.MediaType; import okhttp3.OkHttpClient; import okhttp3.Request; import okhttp3.RequestBody; import okhttp3.ResponseBody; import org.apache.commons.lang3.StringUtils; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.sonar.auth.github.security.AccessToken; import org.sonarqube.ws.client.OkHttpClientBuilder; import static com.google.common.base.Preconditions.checkArgument; import static java.net.HttpURLConnection.HTTP_ACCEPTED; import static java.net.HttpURLConnection.HTTP_CREATED; import static java.net.HttpURLConnection.HTTP_NO_CONTENT; import static java.net.HttpURLConnection.HTTP_OK; import static java.util.Optional.empty; import static java.util.Optional.of; import static java.util.Optional.ofNullable; public abstract class GenericApplicationHttpClient implements ApplicationHttpClient { private static final Logger LOG = LoggerFactory.getLogger(GenericApplicationHttpClient.class); private static final Pattern NEXT_LINK_PATTERN = Pattern.compile("<([^<]+)>; rel=\"next\""); private final DevopsPlatformHeaders devopsPlatformHeaders; private final OkHttpClient client; protected GenericApplicationHttpClient(DevopsPlatformHeaders devopsPlatformHeaders, TimeoutConfiguration timeoutConfiguration) { this.devopsPlatformHeaders = devopsPlatformHeaders; client = new OkHttpClientBuilder() .setConnectTimeoutMs(timeoutConfiguration.getConnectTimeout()) .setReadTimeoutMs(timeoutConfiguration.getReadTimeout()) .setFollowRedirects(false) .build(); } @Override public GetResponse get(String appUrl, AccessToken token, String endPoint) throws IOException { return get(appUrl, token, endPoint, true); } @Override public GetResponse getSilent(String appUrl, AccessToken token, String endPoint) throws IOException { return get(appUrl, token, endPoint, false); } private GetResponse get(String appUrl, AccessToken token, String endPoint, boolean withLog) throws IOException { validateEndPoint(endPoint); try (okhttp3.Response response = client.newCall(newGetRequest(appUrl, token, endPoint)).execute()) { int responseCode = response.code(); RateLimit rateLimit = readRateLimit(response); if (responseCode != HTTP_OK) { String content = StringUtils.trimToNull(attemptReadContent(response)); if (withLog) { LOG.warn("GET response did not have expected HTTP code (was {}): {}", responseCode, content); } return new GetResponseImpl(responseCode, content, null, rateLimit); } return new GetResponseImpl(responseCode, readContent(response.body()).orElse(null), readNextEndPoint(response), rateLimit); } } private static void validateEndPoint(String endPoint) { checkArgument(endPoint.startsWith("/") || endPoint.startsWith("http") || endPoint.isEmpty(), "endpoint must start with '/' or 'http'"); } private Request newGetRequest(String appUrl, AccessToken token, String endPoint) { return newRequestBuilder(appUrl, token, endPoint).get().build(); } @Override public Response post(String appUrl, @Nullable AccessToken token, String endPoint) throws IOException { return doPost(appUrl, token, endPoint, new FormBody.Builder().build()); } @Override public Response post(String appUrl, AccessToken token, String endPoint, String json) throws IOException { RequestBody body = RequestBody.create(json, MediaType.parse("application/json; charset=utf-8")); return doPost(appUrl, token, endPoint, body); } @Override public Response patch(String appUrl, AccessToken token, String endPoint, String json) throws IOException { RequestBody body = RequestBody.create(json, MediaType.parse("application/json; charset=utf-8")); return doPatch(appUrl, token, endPoint, body); } @Override public Response delete(String appUrl, AccessToken token, String endPoint) throws IOException { validateEndPoint(endPoint); try (okhttp3.Response response = client.newCall(newDeleteRequest(appUrl, token, endPoint)).execute()) { int responseCode = response.code(); RateLimit rateLimit = readRateLimit(response); if (responseCode != HTTP_NO_CONTENT) { String content = attemptReadContent(response); LOG.warn("DELETE response did not have expected HTTP code (was {}): {}", responseCode, content); return new ResponseImpl(responseCode, content, rateLimit); } return new ResponseImpl(responseCode, null, rateLimit); } } private Request newDeleteRequest(String appUrl, AccessToken token, String endPoint) { return newRequestBuilder(appUrl, token, endPoint).delete().build(); } private Response doPost(String appUrl, @Nullable AccessToken token, String endPoint, RequestBody body) throws IOException { validateEndPoint(endPoint); try (okhttp3.Response response = client.newCall(newPostRequest(appUrl, token, endPoint, body)).execute()) { int responseCode = response.code(); RateLimit rateLimit = readRateLimit(response); if (responseCode == HTTP_OK || responseCode == HTTP_CREATED || responseCode == HTTP_ACCEPTED) { return new ResponseImpl(responseCode, readContent(response.body()).orElse(null), rateLimit); } else if (responseCode == HTTP_NO_CONTENT) { return new ResponseImpl(responseCode, null, rateLimit); } String content = attemptReadContent(response); LOG.warn("POST response did not have expected HTTP code (was {}): {}", responseCode, content); return new ResponseImpl(responseCode, content, rateLimit); } } private Response doPatch(String appUrl, AccessToken token, String endPoint, RequestBody body) throws IOException { validateEndPoint(endPoint); try (okhttp3.Response response = client.newCall(newPatchRequest(token, appUrl, endPoint, body)).execute()) { int responseCode = response.code(); RateLimit rateLimit = readRateLimit(response); if (responseCode == HTTP_OK) { return new ResponseImpl(responseCode, readContent(response.body()).orElse(null), rateLimit); } else if (responseCode == HTTP_NO_CONTENT) { return new ResponseImpl(responseCode, null, rateLimit); } String content = attemptReadContent(response); LOG.warn("PATCH response did not have expected HTTP code (was {}): {}", responseCode, content); return new ResponseImpl(responseCode, content, rateLimit); } } private Request newPostRequest(String appUrl, @Nullable AccessToken token, String endPoint, RequestBody body) { return newRequestBuilder(appUrl, token, endPoint).post(body).build(); } private Request newPatchRequest(AccessToken token, String appUrl, String endPoint, RequestBody body) { return newRequestBuilder(appUrl, token, endPoint).patch(body).build(); } private Request.Builder newRequestBuilder(String appUrl, @Nullable AccessToken token, String endPoint) { Request.Builder url = new Request.Builder().url(toAbsoluteEndPoint(appUrl, endPoint)); if (token != null) { url.addHeader(devopsPlatformHeaders.getAuthorizationHeader(), token.getAuthorizationHeaderPrefix() + " " + token.getValue()); devopsPlatformHeaders.getApiVersion().ifPresent(apiVersion -> url.addHeader(devopsPlatformHeaders.getApiVersionHeader().orElseThrow(), apiVersion) ); } return url; } private static String toAbsoluteEndPoint(String host, String endPoint) { if (endPoint.startsWith("http")) { return endPoint; } try { return new URL(host + endPoint).toExternalForm(); } catch (MalformedURLException e) { throw new IllegalArgumentException(String.format("%s is not a valid url", host + endPoint)); } } private static String attemptReadContent(okhttp3.Response response) { try { return readContent(response.body()).orElse(null); } catch (IOException e) { return null; } } private static Optional readContent(@Nullable ResponseBody body) throws IOException { if (body == null) { return empty(); } try { return of(body.string()); } finally { body.close(); } } @CheckForNull private static String readNextEndPoint(okhttp3.Response response) { String links = Optional.ofNullable(response.headers().get("link")).orElse(""); Matcher nextLinkMatcher = NEXT_LINK_PATTERN.matcher(links); if (!nextLinkMatcher.find()) { return null; } String nextUrl = nextLinkMatcher.group(1); if (response.request().url().toString().equals(nextUrl)) { return null; } return nextUrl; } @CheckForNull private RateLimit readRateLimit(okhttp3.Response response) { Integer remaining = headerValueOrNull(response, devopsPlatformHeaders.getRateLimitRemainingHeader(), Integer::valueOf); Integer limit = headerValueOrNull(response, devopsPlatformHeaders.getRateLimitLimitHeader(), Integer::valueOf); Long reset = headerValueOrNull(response, devopsPlatformHeaders.getRateLimitResetHeader(), Long::valueOf); if (remaining == null || limit == null || reset == null) { return null; } return new RateLimit(remaining, limit, reset); } @CheckForNull private static T headerValueOrNull(okhttp3.Response response, String header, Function mapper) { return ofNullable(response.headers().get(header)).map(mapper::apply).orElse(null); } private static class ResponseImpl implements Response { private final int code; private final String content; private final RateLimit rateLimit; private ResponseImpl(int code, @Nullable String content, @Nullable RateLimit rateLimit) { this.code = code; this.content = content; this.rateLimit = rateLimit; } @Override public int getCode() { return code; } @Override public Optional getContent() { return ofNullable(content); } @Override @CheckForNull public RateLimit getRateLimit() { return rateLimit; } } private static final class GetResponseImpl extends ResponseImpl implements GetResponse { private final String nextEndPoint; private GetResponseImpl(int code, @Nullable String content, @Nullable String nextEndPoint, @Nullable RateLimit rateLimit) { super(code, content, rateLimit); this.nextEndPoint = nextEndPoint; } @Override public Optional getNextEndPoint() { return ofNullable(nextEndPoint); } } }