From 48ee2639511ff506ab898417be31fb46a401bc54 Mon Sep 17 00:00:00 2001 From: abelgardep Date: Thu, 16 Jan 2020 17:08:54 +0100 Subject: [PATCH] First attempt to use Moshi to parse capabilities --- .../resources/response/CapabilityResponse.kt | 172 +++++++++++++ .../status/GetRemoteCapabilitiesOperation.kt | 237 ++++-------------- 2 files changed, 216 insertions(+), 193 deletions(-) create mode 100644 owncloudComLibrary/src/main/java/com/owncloud/android/lib/resources/response/CapabilityResponse.kt diff --git a/owncloudComLibrary/src/main/java/com/owncloud/android/lib/resources/response/CapabilityResponse.kt b/owncloudComLibrary/src/main/java/com/owncloud/android/lib/resources/response/CapabilityResponse.kt new file mode 100644 index 00000000..374cf96e --- /dev/null +++ b/owncloudComLibrary/src/main/java/com/owncloud/android/lib/resources/response/CapabilityResponse.kt @@ -0,0 +1,172 @@ +/* ownCloud Android Library is available under MIT license + * @author Abel García de Prada + * Copyright (C) 2020 ownCloud 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 com.owncloud.android.lib.resources.response + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +@JsonClass(generateAdapter = true) +data class CapabilityResponse( + @Json(name = NODE_SERVER_VERSION) + val serverVersion: ServerVersion, + @Json(name = NODE_CAPABILITIES) + val capabilities: Capabilities +) + +@JsonClass(generateAdapter = true) +data class Capabilities( + @Json(name = NODE_CORE) + val coreCapabilities: CoreCapabilities, + @Json(name = NODE_FILES_SHARING) + val fileSharingCapabilities: FileSharingCapabilities, + @Json(name = NODE_FILES) + val filesCapabilities: FilesCapabilities +) + +@JsonClass(generateAdapter = true) +data class CoreCapabilities( + @Json(name = PROPERTY_CORE_POLLINTERVAL) + val pollInterval: Int +) + +@JsonClass(generateAdapter = true) +data class FileSharingCapabilities( + @Json(name = PROPERTY_FILES_SHARING_API_ENABLED) + val fileSharingApiEnabled: Boolean, + @Json(name = PROPERTY_FILES_SHARING_SEARCH_MIN_LENGTH) + val fileSharingSearchMinLength: Int, + @Json(name = NODE_FILES_SHARING_PUBLIC) + val fileSharingPublic: FileSharingPublic, + @Json(name = PROPERTY_FILES_SHARING_RESHARING) + val fileSharingReSharing: Boolean, + @Json(name = NODE_FEDERATION) + val fileSharingFederation: FileSharingFederation +) + +@JsonClass(generateAdapter = true) +data class FileSharingPublic( + val enabled: Boolean, + @Json(name = PROPERTY_FILES_SHARING_PUBLIC_UPLOAD) + val fileSharingPublicUpload: Boolean, + @Json(name = PROPERTY_FILES_SHARING_PUBLIC_UPLOAD_ONLY) + val fileSharingPublicUploadOnly: Boolean, + @Json(name = PROPERTY_FILES_SHARING_PUBLIC_MULTIPLE) + val fileSharingPublicMultiple: Boolean, + @Json(name = NODE_PASSWORD) + val fileSharingPublicPassword: FileSharingPublicPassword, + @Json(name = NODE_EXPIRE_DATE) + val fileSharingPublicExpireDate: FileSharingPublicExpireDate +) + +@JsonClass(generateAdapter = true) +data class FileSharingPublicPassword( + val enforced: Boolean, + @Json(name = NODE_FILES_SHARING_PUBLIC_PASSWORD_ENFORCED) + val enforcedFor: FileSharingPublicPasswordEnforced +) + +@JsonClass(generateAdapter = true) +data class FileSharingPublicPasswordEnforced( + @Json(name = PROPERTY_FILES_SHARING_PUBLIC_PASSWORD_ENFORCED_READ_ONLY) + val enforcedReadOnly: Boolean, + @Json(name = PROPERTY_FILES_SHARING_PUBLIC_PASSWORD_ENFORCED_READ_WRITE) + val enforcedReadWrite: Boolean, + @Json(name = PROPERTY_FILES_SHARING_PUBLIC_PASSWORD_ENFORCED_UPLOAD_ONLY) + val enforcedUploadOnly: Boolean +) + +@JsonClass(generateAdapter = true) +data class FileSharingPublicExpireDate( + val enabled: Boolean, + val days: Int?, + val enforced: Boolean? +) + +@JsonClass(generateAdapter = true) +data class FileSharingFederation( + val incoming: Boolean, + val outgoing: Boolean +) + +@JsonClass(generateAdapter = true) +data class FilesCapabilities( + @Json(name = PROPERTY_FILES_BIGFILECHUNKING) + val filesBigFileChunking: Boolean, + @Json(name = PROPERTY_FILES_UNDELETE) + val filesUnDelete: Boolean, + @Json(name = PROPERTY_FILES_VERSIONING) + val filesVersioning: Boolean +) + +@JsonClass(generateAdapter = true) +data class ServerVersion( + @Json(name = PROPERTY_VERSION_MAJOR) + var versionMayor: Int = 0, + @Json(name = PROPERTY_VERSION_MINOR) + var versionMinor: Int = 0, + @Json(name = PROPERTY_VERSION_MICRO) + var versionMicro: Int = 0, + @Json(name = PROPERTY_VERSION_STRING) + var versionString: String = "", + @Json(name = PROPERTY_VERSION_EDITION) + var versionEdition: String = "" +) + +private const val NODE_SERVER_VERSION = "version" +private const val PROPERTY_VERSION_MAJOR = "major" +private const val PROPERTY_VERSION_MINOR = "minor" +private const val PROPERTY_VERSION_MICRO = "micro" +private const val PROPERTY_VERSION_STRING = "string" +private const val PROPERTY_VERSION_EDITION = "edition" + +private const val NODE_CAPABILITIES = "capabilities" + +private const val NODE_CORE = "core" +private const val PROPERTY_CORE_POLLINTERVAL = "pollinterval" + +private const val NODE_FILES_SHARING = "files_sharing" +private const val PROPERTY_FILES_SHARING_API_ENABLED = "api_enabled" +private const val PROPERTY_FILES_SHARING_SEARCH_MIN_LENGTH = "search_min_length" +private const val PROPERTY_FILES_SHARING_RESHARING = "resharing" + +private const val NODE_FILES_SHARING_PUBLIC = "public" +private const val PROPERTY_FILES_SHARING_PUBLIC_UPLOAD = "upload" +private const val PROPERTY_FILES_SHARING_PUBLIC_UPLOAD_ONLY = "supports_upload_only" +private const val PROPERTY_FILES_SHARING_PUBLIC_MULTIPLE = "multiple" + +private const val NODE_FEDERATION = "federation" + +private const val NODE_PASSWORD = "password" +private const val NODE_FILES_SHARING_PUBLIC_PASSWORD_ENFORCED = "enforced_for" +private const val PROPERTY_FILES_SHARING_PUBLIC_PASSWORD_ENFORCED_READ_ONLY = "read_only" +private const val PROPERTY_FILES_SHARING_PUBLIC_PASSWORD_ENFORCED_READ_WRITE = "read_write" +private const val PROPERTY_FILES_SHARING_PUBLIC_PASSWORD_ENFORCED_UPLOAD_ONLY = "upload_only" + +private const val NODE_EXPIRE_DATE = "expire_date" + +private const val NODE_FILES = "files" +private const val PROPERTY_FILES_BIGFILECHUNKING = "bigfilechunking" +private const val PROPERTY_FILES_UNDELETE = "undelete" +private const val PROPERTY_FILES_VERSIONING = "versioning" diff --git a/owncloudComLibrary/src/main/java/com/owncloud/android/lib/resources/status/GetRemoteCapabilitiesOperation.kt b/owncloudComLibrary/src/main/java/com/owncloud/android/lib/resources/status/GetRemoteCapabilitiesOperation.kt index 0d53ce97..c7dfa452 100644 --- a/owncloudComLibrary/src/main/java/com/owncloud/android/lib/resources/status/GetRemoteCapabilitiesOperation.kt +++ b/owncloudComLibrary/src/main/java/com/owncloud/android/lib/resources/status/GetRemoteCapabilitiesOperation.kt @@ -2,6 +2,8 @@ * @author masensio * @author Semih Serhat Karakaya * @author David González Verdugo + * @author Abel García de Prada + * * Copyright (C) 2020 ownCloud GmbH. * * Permission is hereby granted, free of charge, to any person obtaining a copy @@ -33,10 +35,13 @@ import com.owncloud.android.lib.common.http.methods.nonwebdav.GetMethod import com.owncloud.android.lib.common.operations.RemoteOperation import com.owncloud.android.lib.common.operations.RemoteOperationResult import com.owncloud.android.lib.common.operations.RemoteOperationResult.ResultCode.OK +import com.owncloud.android.lib.resources.response.CapabilityResponse +import com.owncloud.android.lib.resources.status.RemoteCapability.CapabilityBooleanType.Companion.fromBooleanValue +import com.squareup.moshi.JsonAdapter +import com.squareup.moshi.Moshi import org.json.JSONObject -import java.net.URL -import com.owncloud.android.lib.resources.status.RemoteCapability.CapabilityBooleanType import timber.log.Timber +import java.net.URL /** * Get the Capabilities from the server @@ -69,13 +74,7 @@ class GetRemoteCapabilitiesOperation : RemoteOperation() { if (!isSuccess(status)) { result = RemoteOperationResult(getMethod) - Timber.e("Failed response while getting capabilities from the server ") - if (response != null) { - Timber.e("*** status code: $status; response message: $response") - } else { - Timber.e("*** status code: $status") - } - + Timber.e("Failed response while getting capabilities from the server status code: $status; response message: $response") return result } @@ -93,154 +92,16 @@ class GetRemoteCapabilitiesOperation : RemoteOperation() { val message = respMeta.getString(PROPERTY_MESSAGE) if (statusProp) { - val capability = RemoteCapability() - // Add Version - if (respData.has(NODE_VERSION)) { - val respVersion = respData.getJSONObject(NODE_VERSION) - capability.versionMayor = respVersion.getInt(PROPERTY_MAJOR) - capability.versionMinor = respVersion.getInt(PROPERTY_MINOR) - capability.versionMicro = respVersion.getInt(PROPERTY_MICRO) - capability.versionString = respVersion.getString(PROPERTY_STRING) - capability.versionEdition = respVersion.getString(PROPERTY_EDITION) - Timber.d("*** Added $NODE_VERSION") - } + val moshi: Moshi = Moshi.Builder().build() + val adapter: JsonAdapter = moshi.adapter(CapabilityResponse::class.java) + val capabilityResponse: CapabilityResponse? = adapter.fromJson(respData.toString()) - // Capabilities Object - if (respData.has(NODE_CAPABILITIES)) { - val respCapabilities = respData.getJSONObject(NODE_CAPABILITIES) - - // Add Core: pollinterval - if (respCapabilities.has(NODE_CORE)) { - val respCore = respCapabilities.getJSONObject(NODE_CORE) - capability.corePollinterval = respCore.getInt(PROPERTY_POLLINTERVAL) - Timber.d("*** Added $NODE_CORE") - } - - // Add files_sharing: public, user, resharing - if (respCapabilities.has(NODE_FILES_SHARING)) { - val respFilesSharing = respCapabilities.getJSONObject(NODE_FILES_SHARING) - if (respFilesSharing.has(PROPERTY_API_ENABLED)) { - capability.filesSharingApiEnabled = CapabilityBooleanType.fromBooleanValue( - respFilesSharing.getBoolean(PROPERTY_API_ENABLED) - ) - } - - if (respFilesSharing.has(NODE_PUBLIC)) { - val respPublic = respFilesSharing.getJSONObject(NODE_PUBLIC) - capability.filesSharingPublicEnabled = CapabilityBooleanType.fromBooleanValue( - respPublic.getBoolean(PROPERTY_ENABLED) - ) - - if (respPublic.has(NODE_PASSWORD)) { - val respPassword = respPublic.getJSONObject(NODE_PASSWORD) - capability.filesSharingPublicPasswordEnforced = - CapabilityBooleanType.fromBooleanValue( - respPublic.getJSONObject(NODE_PASSWORD).getBoolean(PROPERTY_ENFORCED) - ) - - if (respPassword.has(NODE_ENFORCED_FOR)) { - capability.filesSharingPublicPasswordEnforcedReadOnly = - CapabilityBooleanType.fromBooleanValue( - respPassword.getJSONObject(NODE_ENFORCED_FOR).getBoolean( - PROPERTY_ENFORCED_READ_ONLY - ) - ) - - capability.filesSharingPublicPasswordEnforcedReadWrite = - CapabilityBooleanType.fromBooleanValue( - respPassword.getJSONObject(NODE_ENFORCED_FOR).getBoolean( - PROPERTY_ENFORCED_READ_WRITE - ) - ) - - capability.filesSharingPublicPasswordEnforcedUploadOnly = - CapabilityBooleanType.fromBooleanValue( - respPassword.getJSONObject(NODE_ENFORCED_FOR).getBoolean( - PROPERTY_ENFORCED_UPLOAD_ONLY - ) - ) - } - } - if (respPublic.has(NODE_EXPIRE_DATE)) { - val respExpireDate = respPublic.getJSONObject(NODE_EXPIRE_DATE) - capability.filesSharingPublicExpireDateEnabled = - CapabilityBooleanType.fromBooleanValue( - respExpireDate.getBoolean(PROPERTY_ENABLED) - ) - if (respExpireDate.has(PROPERTY_DAYS)) { - capability.filesSharingPublicExpireDateDays = - respExpireDate.getInt(PROPERTY_DAYS) - } - if (respExpireDate.has(PROPERTY_ENFORCED)) { - capability.filesSharingPublicExpireDateEnforced = - CapabilityBooleanType.fromBooleanValue( - respExpireDate.getBoolean(PROPERTY_ENFORCED) - ) - } - } - if (respPublic.has(PROPERTY_UPLOAD)) { - capability.filesSharingPublicUpload = CapabilityBooleanType.fromBooleanValue( - respPublic.getBoolean(PROPERTY_UPLOAD) - ) - } - if (respPublic.has(PROPERTY_UPLOAD_ONLY)) { - capability.filesSharingPublicSupportsUploadOnly = - CapabilityBooleanType.fromBooleanValue( - respPublic.getBoolean(PROPERTY_UPLOAD_ONLY) - ) - } - if (respPublic.has(PROPERTY_MULTIPLE)) { - capability.filesSharingPublicMultiple = CapabilityBooleanType.fromBooleanValue( - respPublic.getBoolean(PROPERTY_MULTIPLE) - ) - } - } - - if (respFilesSharing.has(NODE_USER)) { - val respUser = respFilesSharing.getJSONObject(NODE_USER) - capability.filesSharingUserSendMail = CapabilityBooleanType.fromBooleanValue( - respUser.getBoolean(PROPERTY_SEND_MAIL) - ) - } - - capability.filesSharingResharing = CapabilityBooleanType.fromBooleanValue( - respFilesSharing.getBoolean(PROPERTY_RESHARING) - ) - if (respFilesSharing.has(NODE_FEDERATION)) { - val respFederation = respFilesSharing.getJSONObject(NODE_FEDERATION) - capability.filesSharingFederationOutgoing = - CapabilityBooleanType.fromBooleanValue(respFederation.getBoolean(PROPERTY_OUTGOING)) - capability.filesSharingFederationIncoming = CapabilityBooleanType.fromBooleanValue( - respFederation.getBoolean(PROPERTY_INCOMING) - ) - } - Timber.d("*** Added $NODE_FILES_SHARING") - } - - if (respCapabilities.has(NODE_FILES)) { - val respFiles = respCapabilities.getJSONObject(NODE_FILES) - // Add files - capability.filesBigFileChunking = CapabilityBooleanType.fromBooleanValue( - respFiles.getBoolean(PROPERTY_BIGFILECHUNKING) - ) - if (respFiles.has(PROPERTY_UNDELETE)) { - capability.filesUndelete = CapabilityBooleanType.fromBooleanValue( - respFiles.getBoolean(PROPERTY_UNDELETE) - ) - } - if (respFiles.has(PROPERTY_VERSIONING)) { - capability.filesVersioning = CapabilityBooleanType.fromBooleanValue( - respFiles.getBoolean(PROPERTY_VERSIONING) - ) - } - Timber.d("*** Added $NODE_FILES") - } - } + val remoteCapability = capabilityResponse?.let { mapToModel(it) } ?: RemoteCapability() // Result result = RemoteOperationResult(OK) - result.data = capability + result.data = remoteCapability - Timber.d("*** Get Capabilities completed ") + Timber.d("*** Get Capabilities completed $remoteCapability") } else { result = RemoteOperationResult(statuscode, message, null) Timber.e("Failed response while getting capabilities from the server ") @@ -259,6 +120,36 @@ class GetRemoteCapabilitiesOperation : RemoteOperation() { return status == HttpConstants.HTTP_OK } + private fun mapToModel(capabilityResponse: CapabilityResponse): RemoteCapability = + with(capabilityResponse) { + RemoteCapability( + versionMayor = serverVersion.versionMayor, + versionMinor = serverVersion.versionMinor, + versionMicro = serverVersion.versionMicro, + versionString = serverVersion.versionString, + versionEdition = serverVersion.versionEdition, + corePollinterval = capabilities.coreCapabilities.pollInterval, + filesSharingApiEnabled = fromBooleanValue(capabilities.fileSharingCapabilities.fileSharingApiEnabled), + filesSharingResharing = fromBooleanValue(capabilities.fileSharingCapabilities.fileSharingReSharing), + filesSharingPublicEnabled = fromBooleanValue(capabilities.fileSharingCapabilities.fileSharingPublic.enabled), + filesSharingPublicUpload = fromBooleanValue(capabilities.fileSharingCapabilities.fileSharingPublic.fileSharingPublicUpload), + filesSharingPublicSupportsUploadOnly = fromBooleanValue(capabilities.fileSharingCapabilities.fileSharingPublic.fileSharingPublicUploadOnly), + filesSharingPublicMultiple = fromBooleanValue(capabilities.fileSharingCapabilities.fileSharingPublic.fileSharingPublicMultiple), + filesSharingPublicPasswordEnforced = fromBooleanValue(capabilities.fileSharingCapabilities.fileSharingPublic.fileSharingPublicPassword.enforced), + filesSharingPublicPasswordEnforcedReadOnly = fromBooleanValue(capabilities.fileSharingCapabilities.fileSharingPublic.fileSharingPublicPassword.enforcedFor.enforcedReadOnly), + filesSharingPublicPasswordEnforcedReadWrite = fromBooleanValue(capabilities.fileSharingCapabilities.fileSharingPublic.fileSharingPublicPassword.enforcedFor.enforcedReadWrite), + filesSharingPublicPasswordEnforcedUploadOnly = fromBooleanValue(capabilities.fileSharingCapabilities.fileSharingPublic.fileSharingPublicPassword.enforcedFor.enforcedUploadOnly), + filesSharingPublicExpireDateEnabled = fromBooleanValue(capabilities.fileSharingCapabilities.fileSharingPublic.fileSharingPublicExpireDate.enabled), + filesSharingPublicExpireDateDays = capabilities.fileSharingCapabilities.fileSharingPublic.fileSharingPublicExpireDate.days ?: 0, + filesSharingPublicExpireDateEnforced = fromBooleanValue(capabilities.fileSharingCapabilities.fileSharingPublic.fileSharingPublicExpireDate.enforced?:false), + filesBigFileChunking = fromBooleanValue(capabilities.filesCapabilities.filesBigFileChunking), + filesUndelete = fromBooleanValue(capabilities.filesCapabilities.filesUnDelete), + filesVersioning = fromBooleanValue(capabilities.filesCapabilities.filesVersioning), + filesSharingFederationIncoming = fromBooleanValue(capabilities.fileSharingCapabilities.fileSharingFederation.incoming), + filesSharingFederationOutgoing = fromBooleanValue(capabilities.fileSharingCapabilities.fileSharingFederation.outgoing) + ) + } + companion object { // OCS Routes @@ -276,50 +167,10 @@ class GetRemoteCapabilitiesOperation : RemoteOperation() { private const val NODE_META = "meta" private const val NODE_DATA = "data" - private const val NODE_VERSION = "version" - - private const val NODE_CAPABILITIES = "capabilities" - private const val NODE_CORE = "core" - - private const val NODE_FILES_SHARING = "files_sharing" - private const val NODE_PUBLIC = "public" - private const val NODE_PASSWORD = "password" - private const val NODE_ENFORCED_FOR = "enforced_for" - private const val NODE_EXPIRE_DATE = "expire_date" - private const val NODE_USER = "user" - private const val NODE_FEDERATION = "federation" - private const val NODE_FILES = "files" private const val PROPERTY_STATUS = "status" private const val PROPERTY_STATUS_OK = "ok" private const val PROPERTY_STATUSCODE = "statuscode" private const val PROPERTY_MESSAGE = "message" - - private const val PROPERTY_POLLINTERVAL = "pollinterval" - - private const val PROPERTY_MAJOR = "major" - private const val PROPERTY_MINOR = "minor" - private const val PROPERTY_MICRO = "micro" - private const val PROPERTY_STRING = "string" - private const val PROPERTY_EDITION = "edition" - - private const val PROPERTY_API_ENABLED = "api_enabled" - private const val PROPERTY_ENABLED = "enabled" - private const val PROPERTY_ENFORCED = "enforced" - private const val PROPERTY_ENFORCED_READ_ONLY = "read_only" - private const val PROPERTY_ENFORCED_READ_WRITE = "read_write" - private const val PROPERTY_ENFORCED_UPLOAD_ONLY = "upload_only" - private const val PROPERTY_DAYS = "days" - private const val PROPERTY_SEND_MAIL = "send_mail" - private const val PROPERTY_UPLOAD = "upload" - private const val PROPERTY_UPLOAD_ONLY = "supports_upload_only" - private const val PROPERTY_MULTIPLE = "multiple" - private const val PROPERTY_RESHARING = "resharing" - private const val PROPERTY_OUTGOING = "outgoing" - private const val PROPERTY_INCOMING = "incoming" - - private const val PROPERTY_BIGFILECHUNKING = "bigfilechunking" - private const val PROPERTY_UNDELETE = "undelete" - private const val PROPERTY_VERSIONING = "versioning" } }