Migrate remote upload operation to kotlin

2025-06-07 16:06:08 +00:00 · 2022-01-18 08:28:59 +01:00 · 2022-01-18 08:28:59 +01:00 · c6584d69fd
commit c6584d69fd
parent 4c39990edb
1 changed files with 135 additions and 0 deletions
--- a/owncloudComLibrary/src/main/java/com/owncloud/android/lib/resources/files/UploadFileFromFileSystemOperation.kt
+++ b/owncloudComLibrary/src/main/java/com/owncloud/android/lib/resources/files/UploadFileFromFileSystemOperation.kt
@ -0,0 +1,135 @@
+/* ownCloud Android Library is available under MIT license
+ *   Copyright (C) 2022 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
+ *   NONINFINGEMENT. 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.files
+
+import com.owncloud.android.lib.common.OwnCloudClient
+import com.owncloud.android.lib.common.http.HttpConstants
+import com.owncloud.android.lib.common.http.methods.webdav.PutMethod
+import com.owncloud.android.lib.common.network.FileRequestBody
+import com.owncloud.android.lib.common.network.OnDatatransferProgressListener
+import com.owncloud.android.lib.common.network.WebdavUtils
+import com.owncloud.android.lib.common.operations.OperationCancelledException
+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
+import okhttp3.MediaType
+import okhttp3.MediaType.Companion.toMediaTypeOrNull
+import timber.log.Timber
+import java.io.File
+import java.net.URL
+import java.util.HashSet
+import java.util.concurrent.atomic.AtomicBoolean
+
+/**
+ * Remote operation performing the upload of a remote file to the ownCloud server.
+ *
+ * @author David A. Velasco
+ * @author masensio
+ * @author David González Verdugo
+ * @author Abel García de Prada
+ */
+open class UploadFileFromFileSystemOperation(
+    val localPath: String,
+    val remotePath: String,
+    val mimeType: String,
+    val lastModifiedTimestamp: String,
+    val requiredEtag: String,
+) : RemoteOperation<Unit>() {
+
+    protected val cancellationRequested = AtomicBoolean(false)
+    protected var putMethod: PutMethod? = null
+    protected val dataTransferListener: MutableSet<OnDatatransferProgressListener> = HashSet()
+    protected var fileRequestBody: FileRequestBody? = null
+
+    override fun run(client: OwnCloudClient): RemoteOperationResult<Unit> {
+        var result: RemoteOperationResult<Unit>
+        try {
+            if (cancellationRequested.get()) {
+                // the operation was cancelled before getting it's turn to be executed in the queue of uploads
+                result = RemoteOperationResult<Unit>(OperationCancelledException())
+                Timber.i("Upload of $localPath to $remotePath has been cancelled")
+            } else {
+                // perform the upload
+                result = uploadFile(client)
+                Timber.i("Upload of $localPath to $remotePath: ${result.logMessage}")
+            }
+        } catch (e: Exception) {
+            if (putMethod?.isAborted == true) {
+                result = RemoteOperationResult<Unit>(OperationCancelledException())
+                Timber.e(result.exception, "Upload of $localPath to $remotePath has been aborted with this message: ${result.logMessage}")
+            } else {
+                result = RemoteOperationResult<Unit>(e)
+                Timber.e(result.exception, "Upload of $localPath to $remotePath has failed with this message: ${result.logMessage}")
+            }
+        }
+        return result
+    }
+
+    @Throws(Exception::class)
+    protected open fun uploadFile(client: OwnCloudClient): RemoteOperationResult<Unit> {
+        val fileToUpload = File(localPath)
+        val mediaType: MediaType? = mimeType.toMediaTypeOrNull()
+
+        fileRequestBody = FileRequestBody(fileToUpload, mediaType).also {
+            synchronized(dataTransferListener) { it.addDatatransferProgressListeners(dataTransferListener) }
+        }
+
+        putMethod = PutMethod(URL(client.userFilesWebDavUri.toString() + WebdavUtils.encodePath(remotePath)), fileRequestBody!!).apply {
+            setRetryOnConnectionFailure(false)
+            if (requiredEtag.isNotBlank()) {
+                addRequestHeader(HttpConstants.IF_MATCH_HEADER, requiredEtag)
+            }
+            addRequestHeader(HttpConstants.OC_TOTAL_LENGTH_HEADER, fileToUpload.length().toString())
+            addRequestHeader(HttpConstants.OC_X_OC_MTIME_HEADER, lastModifiedTimestamp)
+        }
+
+        val status = client.executeHttpMethod(putMethod)
+        return if (isSuccess(status)) {
+            RemoteOperationResult<Unit>(ResultCode.OK)
+        } else { // synchronization failed
+            RemoteOperationResult<Unit>(putMethod)
+        }
+    }
+
+    fun addDataTransferProgressListener(listener: OnDatatransferProgressListener) {
+        synchronized(dataTransferListener) { dataTransferListener.add(listener) }
+        fileRequestBody?.addDatatransferProgressListener(listener)
+    }
+
+    fun removeDataTransferProgressListener(listener: OnDatatransferProgressListener) {
+        synchronized(dataTransferListener) { dataTransferListener.remove(listener) }
+        fileRequestBody?.removeDatatransferProgressListener(listener)
+    }
+
+    fun cancel() {
+        synchronized(cancellationRequested) {
+            cancellationRequested.set(true)
+            putMethod?.abort()
+        }
+    }
+
+    fun isSuccess(status: Int): Boolean {
+        return status == HttpConstants.HTTP_OK || status == HttpConstants.HTTP_CREATED || status == HttpConstants.HTTP_NO_CONTENT
+    }
+}