Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,12 @@ abstract class HttpBaseMethod constructor(url: URL) {
// Body
fun getResponseBodyAsString(): String = response.peekBody(Long.MAX_VALUE).string()

fun getResponseBodyPreviewAsString(): String =
getResponseBodyPreviewAsString(MAX_RESPONSE_BODY_PREVIEW_BYTES)

fun getResponseBodyPreviewAsString(maxBytes: Long): String =
response.peekBody(maxBytes).string()

open fun getResponseBodyAsStream(): InputStream? =
response.body?.byteStream()

Expand Down Expand Up @@ -180,4 +186,8 @@ abstract class HttpBaseMethod constructor(url: URL) {
//////////////////////////////
@Throws(Exception::class)
protected abstract fun onExecute(okHttpClient: OkHttpClient): Int

companion object {
const val MAX_RESPONSE_BODY_PREVIEW_BYTES = 64L * 1024L
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ public RemoteOperationResult(HttpBaseMethod httpMethod) throws IOException {
);

if (mHttpCode == HttpConstants.HTTP_BAD_REQUEST) { // 400
String bodyResponse = httpMethod.getResponseBodyAsString();
String bodyResponse = httpMethod.getResponseBodyPreviewAsString();

// do not get for other HTTP codes!; could not be available
if (bodyResponse.length() > 0) {
Expand All @@ -212,7 +212,7 @@ public RemoteOperationResult(HttpBaseMethod httpMethod) throws IOException {
mCode = ResultCode.INVALID_CHARACTER_DETECT_IN_SERVER;
} else {
parseErrorMessageAndSetCode(
httpMethod.getResponseBodyAsString(),
bodyResponse,
ResultCode.SPECIFIC_BAD_REQUEST
);
}
Expand All @@ -227,25 +227,25 @@ public RemoteOperationResult(HttpBaseMethod httpMethod) throws IOException {
switch (mHttpCode) {
case HttpConstants.HTTP_FORBIDDEN:
parseErrorMessageAndSetCode(
httpMethod.getResponseBodyAsString(),
httpMethod.getResponseBodyPreviewAsString(),
ResultCode.SPECIFIC_FORBIDDEN
);
break;
case HttpConstants.HTTP_UNSUPPORTED_MEDIA_TYPE:
parseErrorMessageAndSetCode(
httpMethod.getResponseBodyAsString(),
httpMethod.getResponseBodyPreviewAsString(),
ResultCode.SPECIFIC_UNSUPPORTED_MEDIA_TYPE
);
break;
case HttpConstants.HTTP_SERVICE_UNAVAILABLE:
parseErrorMessageAndSetCode(
httpMethod.getResponseBodyAsString(),
httpMethod.getResponseBodyPreviewAsString(),
ResultCode.SPECIFIC_SERVICE_UNAVAILABLE
);
break;
case HttpConstants.HTTP_METHOD_NOT_ALLOWED:
parseErrorMessageAndSetCode(
httpMethod.getResponseBodyAsString(),
httpMethod.getResponseBodyPreviewAsString(),
ResultCode.SPECIFIC_METHOD_NOT_ALLOWED
);
break;
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
/* openCloud Android Library is available under MIT license
* Copyright (C) 2026 openCloud GmbH.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*
*/
package eu.opencloud.android.lib.common.http.methods

import eu.opencloud.android.lib.common.http.HttpConstants
import eu.opencloud.android.lib.common.operations.RemoteOperationResult
import okhttp3.MediaType.Companion.toMediaType
import okhttp3.OkHttpClient
import okhttp3.Protocol
import okhttp3.Response
import okhttp3.ResponseBody
import okhttp3.ResponseBody.Companion.toResponseBody
import okio.Buffer
import okio.BufferedSource
import okio.Source
import okio.Timeout
import okio.buffer
import org.junit.Assert.assertEquals
import org.junit.Test
import java.io.IOException
import java.net.URL

class HttpBaseMethodTest {

@Test
fun responseBodyPreviewIsTruncatedButFullBodyReadsRemainUnchanged() {
val fullBody = "a".repeat(HttpBaseMethod.MAX_RESPONSE_BODY_PREVIEW_BYTES.toInt() + 10)
val method = TestHttpMethod(fullBody.toResponseBody("text/plain".toMediaType()))

assertEquals(
HttpBaseMethod.MAX_RESPONSE_BODY_PREVIEW_BYTES.toInt(),
method.getResponseBodyPreviewAsString().length
)
assertEquals(fullBody.length, method.getResponseBodyAsString().length)
}

@Test
fun remoteOperationResultUsesBoundedPreviewForErrorBodies() {
val preview = "x".repeat(HttpBaseMethod.MAX_RESPONSE_BODY_PREVIEW_BYTES.toInt())
val method = TestHttpMethod(
responseBody = FailingAfterPreviewResponseBody(preview),
statusCode = HttpConstants.HTTP_FORBIDDEN,
)

val result = RemoteOperationResult<Any>(method)

assertEquals(RemoteOperationResult.ResultCode.FORBIDDEN, result.code)
}

private class TestHttpMethod(
responseBody: ResponseBody,
statusCode: Int = HttpConstants.HTTP_FORBIDDEN,
) : HttpBaseMethod(URL("https://example.test")) {
override var response: Response = Response.Builder()
.request(request)
.protocol(Protocol.HTTP_1_1)
.code(statusCode)
.message("Forbidden")
.body(responseBody)
.build()

override fun onExecute(okHttpClient: OkHttpClient): Int = response.code
}

private class FailingAfterPreviewResponseBody(preview: String) : ResponseBody() {
private val previewBytes = preview.toByteArray()

override fun contentType() = "text/plain".toMediaType()

override fun contentLength() = Long.MAX_VALUE

override fun source(): BufferedSource = object : Source {
private var offset = 0

override fun read(sink: Buffer, byteCount: Long): Long {
if (offset < previewBytes.size) {
val count = minOf(byteCount, (previewBytes.size - offset).toLong()).toInt()
sink.write(previewBytes, offset, count)
offset += count
return count.toLong()
}

throw IOException("Full response body should not be read")
}

override fun timeout(): Timeout = Timeout.NONE

override fun close() = Unit
}.buffer()
}
}
Loading