-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Removes reliance on Okhttp3 for sbt 1.7+ support (#33)
* Added a GitlabUrlHandler that extends the BasicURLHandler used by sbt to inject headers into the download, upload, and geturl requests for sbt 1.7.1 support. Commented out code that relied okhttp3 * Code clean up + added host to creds so that we only send the gitlab credentials when the host matches * renamed publishResolver to avoid conflicts with user resolvers * Moved host away from credentials since some people might want to set it directly
- Loading branch information
Showing
6 changed files
with
293 additions
and
69 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| {"name":"sbt","version":"1.7.1","bspVersion":"2.0.0-M5","languages":["scala"],"argv":["/usr/local/Cellar/openjdk@11/11.0.12/libexec/openjdk.jdk/Contents/Home/bin/java","-Xms100m","-Xmx100m","-classpath","/Users/benlist/Library/Application Support/JetBrains/IntelliJIdea2022.2/plugins/Scala/launcher/sbt-launch.jar","xsbt.boot.Boot","-bsp","--sbt-launch-jar=/Users/benlist/Library/Application%20Support/JetBrains/IntelliJIdea2022.2/plugins/Scala/launcher/sbt-launch.jar"]} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| sbt.version=1.3.10 | ||
| sbt.version=1.7.1 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
278 changes: 278 additions & 0 deletions
278
src/main/scala/com/gilcloud/sbt/gitlab/GitlabUrlHandler.scala
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,278 @@ | ||
| package com.gilcloud.sbt.gitlab | ||
|
|
||
| import org.apache.ivy.Ivy | ||
| import org.apache.ivy.util.{ CopyProgressListener, Message, FileUtil} | ||
| import org.apache.ivy.util.url.{ BasicURLHandler, IvyAuthenticator, URLHandler } | ||
| import org.apache.ivy.util.url.URLHandler.{ URLInfo, UNAVAILABLE } | ||
|
|
||
| import java.net.{HttpURLConnection, URL, URLConnection, URLDecoder, UnknownHostException} | ||
| import java.io.* | ||
| import java.util | ||
| import scala.collection.mutable | ||
| import scala.jdk.CollectionConverters._ | ||
|
|
||
|
|
||
| // Implementation of the methods below are copied directly from the BasicURL Handler | ||
| // Modifications were made to the getUrlInfo, download, and upload functions | ||
| // to add gitlab credentials to the header of the request's when the domain matches | ||
| case class GitlabUrlHandler(gitlabHost: String, credentials: GitlabCredentials) extends BasicURLHandler { | ||
| private val BUFFER_SIZE = 64 * 1024 | ||
| private val ERROR_BODY_TRUNCATE_LEN = 512 | ||
|
|
||
| private object HttpStatus { | ||
| private[GitlabUrlHandler] val SC_OK = 200 | ||
| private[GitlabUrlHandler] val SC_PROXY_AUTHENTICATION_REQUIRED = 407 | ||
| } | ||
|
|
||
| // This is requires to access the constructor of URLInfo. | ||
| private[gitlab] class SbtUrlInfo( | ||
| available: Boolean, | ||
| contentLength: Long, | ||
| lastModified: Long, | ||
| bodyCharset: String | ||
| ) extends URLInfo(available, contentLength, lastModified, bodyCharset) { | ||
| def this(available: Boolean, contentLength: Long, lastModified: Long) = { | ||
| this(available, contentLength, lastModified, null) | ||
| } | ||
| } | ||
|
|
||
|
|
||
| private def getHeadersAsDebugString(headers: util.Map[String, util.List[String]]) = { | ||
| val builder = new mutable.StringBuilder("") | ||
| if (headers != null) { | ||
| for (header <- headers.entrySet.asScala) { | ||
| val key = header.getKey | ||
| if (key != null) { | ||
| builder.append(header.getKey) | ||
| builder.append(": ") | ||
| } | ||
| builder.append(String.join("\n ", header.getValue)) | ||
| builder.append("\n") | ||
| } | ||
| } | ||
| builder.toString | ||
| } | ||
|
|
||
| private def readResponseBody(conn: HttpURLConnection): Unit = { | ||
| val buffer = new Array[Byte](BUFFER_SIZE) | ||
| var inStream: InputStream = null | ||
| try { | ||
| inStream = conn.getInputStream | ||
| while ( { | ||
| inStream.read(buffer) > 0 | ||
| }) { | ||
| //Skip content | ||
| } | ||
| } catch { | ||
| case e: IOException => | ||
|
|
||
| // ignore | ||
| } finally if (inStream != null) try inStream.close() | ||
| catch { | ||
| case e: IOException => | ||
|
|
||
| } | ||
| val errStream = conn.getErrorStream | ||
| if (errStream != null) try while ( { | ||
| errStream.read(buffer) > 0 | ||
| }) { | ||
| } | ||
| catch { | ||
| case e: IOException => | ||
|
|
||
| } finally try errStream.close() | ||
| catch { | ||
| case e: IOException => | ||
|
|
||
| } | ||
| } | ||
|
|
||
| private def disconnect(con: URLConnection): Unit = { | ||
| if (con.isInstanceOf[HttpURLConnection]) { | ||
| if (!("HEAD" == con.asInstanceOf[HttpURLConnection].getRequestMethod)) { // We must read the response body before disconnecting! | ||
| // Cfr. http://java.sun.com/j2se/1.5.0/docs/guide/net/http-keepalive.html | ||
| // [quote]Do not abandon a connection by ignoring the response body. Doing | ||
| // so may results in idle TCP connections.[/quote] | ||
| readResponseBody(con.asInstanceOf[HttpURLConnection]) | ||
| } | ||
| con.asInstanceOf[HttpURLConnection].disconnect() | ||
| } | ||
| else if (con != null) try con.getInputStream.close() | ||
| catch { | ||
| case e: IOException => | ||
|
|
||
| // ignored | ||
| } | ||
| } | ||
|
|
||
| @throws[IOException] | ||
| private def readTruncated(is: InputStream, maxLen: Int, contentType: String, contentEncoding: String) = { | ||
| val decodingStream = getDecodingInputStream(contentEncoding, is) | ||
| val charSet = BasicURLHandler.getCharSetFromContentType(contentType) | ||
| val os = new ByteArrayOutputStream(maxLen) | ||
| try { | ||
| var count = 0 | ||
| var b = decodingStream.read | ||
| while ( { | ||
| count < maxLen && b >= 0 | ||
| }) { | ||
| os.write(b) | ||
| count += 1 | ||
| b = decodingStream.read | ||
| } | ||
| new String(os.toByteArray, charSet) | ||
| } finally try is.close() | ||
| catch { | ||
| case e: IOException => | ||
|
|
||
| /* ignored */ | ||
| } | ||
| } | ||
|
|
||
| @throws[IOException] | ||
| private def checkStatusCode(url: URL, con: HttpURLConnection): Boolean = { | ||
| val status = con.getResponseCode | ||
| if (status == HttpStatus.SC_OK) return true | ||
| // IVY-1328: some servers return a 204 on a HEAD request | ||
| if ("HEAD" == con.getRequestMethod && (status == 204)) return true | ||
| Message.debug("HTTP response status: " + status + " url=" + url) | ||
| if (status == HttpStatus.SC_PROXY_AUTHENTICATION_REQUIRED) Message.warn("Your proxy requires authentication.") | ||
| else if (String.valueOf(status).startsWith("4")) Message.verbose("CLIENT ERROR: " + con.getResponseMessage + " url=" + url) | ||
| else if (String.valueOf(status).startsWith("5")) Message.error("SERVER ERROR: " + con.getResponseMessage + " url=" + url) | ||
| false | ||
| } | ||
|
|
||
| override def getURLInfo(url0: URL, timeout: Int): URLInfo = { | ||
| // Install the IvyAuthenticator | ||
| if ("http" == url0.getProtocol || "https" == url0.getProtocol) IvyAuthenticator.install() | ||
|
|
||
| var con: URLConnection = null | ||
|
|
||
| try { | ||
| val url = normalizeToURL(url0) | ||
| con = url.openConnection | ||
| con.setRequestProperty("User-Agent", "Apache Ivy/" + Ivy.getIvyVersion) | ||
|
|
||
| // Check host against gitlab host. If they match add the creds to the header | ||
| if (url.getHost.startsWith(gitlabHost)) { | ||
| con.setRequestProperty(credentials.key, credentials.value) | ||
| } | ||
|
|
||
| if (con.isInstanceOf[HttpURLConnection]) { | ||
| val httpCon = con.asInstanceOf[HttpURLConnection] | ||
| if (getRequestMethod == URLHandler.REQUEST_METHOD_HEAD) httpCon.setRequestMethod("HEAD") | ||
| if (checkStatusCode(url, httpCon)) { | ||
| val bodyCharset = BasicURLHandler.getCharSetFromContentType(con.getContentType) | ||
| return new SbtUrlInfo(true, httpCon.getContentLength, con.getLastModified, bodyCharset) | ||
| } | ||
| } | ||
| else { | ||
| val contentLength = con.getContentLength | ||
| if (contentLength <= 0) return UNAVAILABLE | ||
| else { // TODO: not HTTP... maybe we *don't* want to default to ISO-8559-1 here? | ||
| val bodyCharset = BasicURLHandler.getCharSetFromContentType(con.getContentType) | ||
| return new SbtUrlInfo(true, contentLength, con.getLastModified, bodyCharset) | ||
| } | ||
| } | ||
| } catch { | ||
| case e: UnknownHostException => | ||
| Message.warn("Host " + e.getMessage + " not found. url=" + url0) | ||
| Message.info("You probably access the destination server through " + "a proxy server that is not well configured.") | ||
| case e: IOException => | ||
| Message.error("Server access Error: " + e.getMessage + " url=" + url0) | ||
| } finally disconnect(con) | ||
| UNAVAILABLE | ||
| } | ||
|
|
||
| override def download(src0: URL, dest: File, l: CopyProgressListener): Unit = { | ||
| // Install the IvyAuthenticator | ||
| if ("http" == src0.getProtocol || "https" == src0.getProtocol) IvyAuthenticator.install() | ||
|
|
||
| var srcConn: URLConnection = null | ||
| try { | ||
| val src = normalizeToURL(src0) | ||
| srcConn = src.openConnection | ||
| srcConn.setRequestProperty("User-Agent", "Apache Ivy/" + Ivy.getIvyVersion) | ||
| srcConn.setRequestProperty("Accept-Encoding", "gzip,deflate") | ||
| srcConn.setRequestProperty("Accept", "application/octet-stream, application/json, application/xml, */*") | ||
|
|
||
| // Check host against gitlab host. If they match add the creds to the header | ||
| if (src.getHost.startsWith(gitlabHost)) { | ||
| srcConn.setRequestProperty(credentials.key, credentials.value) | ||
| } | ||
|
|
||
| if (srcConn.isInstanceOf[HttpURLConnection]) { | ||
| val httpCon = srcConn.asInstanceOf[HttpURLConnection] | ||
| val status = httpCon.getResponseCode | ||
| if (status == 302 || status == 301) { | ||
| var location = httpCon.getHeaderField("Location") | ||
| location = URLDecoder.decode(location, "UTF-8") | ||
| val next = new URL(location) | ||
| download(next, dest, l) | ||
| disconnect(srcConn) | ||
| return | ||
| } | ||
| else if (!checkStatusCode(src, httpCon)) throw new IOException("The HTTP response code for " + src + " did not indicate a success." + " See log for more detail.") | ||
| } | ||
| // do the download | ||
| val inStream = getDecodingInputStream(srcConn.getContentEncoding, srcConn.getInputStream) | ||
| FileUtil.copy(inStream, dest, l) | ||
| // check content length only if content was not encoded | ||
| if (srcConn.getContentEncoding == null) { | ||
| val contentLength = srcConn.getContentLength | ||
| if (contentLength != -1 && dest.length != contentLength) { | ||
| dest.delete | ||
| throw new IOException("Downloaded file size doesn't match expected Content Length for " + src + ". Please retry.") | ||
| } | ||
| } | ||
| // update modification date | ||
| val lastModified = srcConn.getLastModified | ||
| if (lastModified > 0) dest.setLastModified(lastModified) | ||
| } finally disconnect(srcConn) | ||
| } | ||
|
|
||
| override def upload(source: File, dest0: URL, l: CopyProgressListener): Unit = { | ||
| if (!("http" == dest0.getProtocol) && !("https" == dest0.getProtocol)) throw new UnsupportedOperationException("URL repository only support HTTP PUT at the moment") | ||
|
|
||
| // Install the IvyAuthenticator | ||
| IvyAuthenticator.install() | ||
| var conn: HttpURLConnection = null | ||
| val dest = normalizeToURL(dest0) | ||
| try { | ||
| conn = dest.openConnection.asInstanceOf[HttpURLConnection] | ||
| conn.setDoOutput(true) | ||
| conn.setRequestMethod("PUT") | ||
| conn.setRequestProperty("User-Agent", "Apache Ivy/" + Ivy.getIvyVersion) | ||
| conn.setRequestProperty("Accept", "application/octet-stream, application/json, application/xml, */*") | ||
| conn.setRequestProperty("Content-type", "application/octet-stream") | ||
| conn.setRequestProperty("Content-length", source.length().toString) | ||
|
|
||
| // Check host against gitlab host. If they match add the creds to the header | ||
| if (dest.getHost.startsWith(gitlabHost)) { | ||
| conn.setRequestProperty(credentials.key, credentials.value) | ||
| } | ||
|
|
||
| conn.setInstanceFollowRedirects(true) | ||
| Message.debug("Request Headers:" + getHeadersAsDebugString(conn.getRequestProperties)) | ||
| var in: FileInputStream = null | ||
| try { | ||
| in = new FileInputStream(source) | ||
| val os = conn.getOutputStream | ||
| FileUtil.copy(in, os, l) | ||
| } finally try in.close() catch { case e: IOException => Unit /* ignored */ } | ||
| // initiate the connection | ||
| val responseCode = conn.getResponseCode | ||
| var extra = "" | ||
| val errorStream = conn.getErrorStream | ||
| val responseStream = conn.getInputStream | ||
| if (errorStream != null) extra = "; Response Body: " + readTruncated(errorStream, ERROR_BODY_TRUNCATE_LEN, conn.getContentType, conn.getContentEncoding) | ||
| else if (responseStream != null) { | ||
| val decodingStream = getDecodingInputStream(conn.getContentEncoding, responseStream) | ||
| extra = "; Response Body: " + readTruncated(responseStream, ERROR_BODY_TRUNCATE_LEN, conn.getContentType, conn.getContentEncoding) | ||
| } | ||
| Message.debug("Response Headers:" + getHeadersAsDebugString(conn.getHeaderFields)) | ||
| validatePutStatusCode(dest, responseCode, conn.getResponseMessage + extra) | ||
| } catch { case e: IOException => Unit /* ignored */ } finally disconnect(conn) | ||
| } | ||
| } | ||
|
|
Oops, something went wrong.