mirror of
https://github.com/owncloud/android-library.git
synced 2025-06-07 16:06:08 +00:00
Migrate DownloadRemoteFileOperation to kotlin
This commit is contained in:
agarcia
Abel García de Prada
parent
405da9a729
commit
389c0a0fc6
@ -1,221 +0,0 @@
|
||||
/* ownCloud Android Library is available under MIT license
|
||||
* Copyright (C) 2016 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.files;
|
||||
|
||||
import com.owncloud.android.lib.common.OwnCloudClient;
|
||||
import com.owncloud.android.lib.common.http.HttpConstants;
|
||||
import com.owncloud.android.lib.common.http.methods.nonwebdav.GetMethod;
|
||||
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 timber.log.Timber;
|
||||
|
||||
import java.io.BufferedInputStream;
|
||||
import java.io.File;
|
||||
import java.io.FileOutputStream;
|
||||
import java.net.URL;
|
||||
import java.util.Date;
|
||||
import java.util.HashSet;
|
||||
import java.util.Iterator;
|
||||
import java.util.Set;
|
||||
import java.util.concurrent.atomic.AtomicBoolean;
|
||||
|
||||
/**
|
||||
* Remote operation performing the download of a remote file in the ownCloud server.
|
||||
*
|
||||
* @author David A. Velasco
|
||||
* @author masensio
|
||||
*/
|
||||
|
||||
public class DownloadRemoteFileOperation extends RemoteOperation {
|
||||
|
||||
private static final int FORBIDDEN_ERROR = 403;
|
||||
private static final int SERVICE_UNAVAILABLE_ERROR = 503;
|
||||
private final AtomicBoolean mCancellationRequested = new AtomicBoolean(false);
|
||||
private Set<OnDatatransferProgressListener> mDataTransferListeners = new HashSet<>();
|
||||
private long mModificationTimestamp = 0;
|
||||
private String mEtag = "";
|
||||
private GetMethod mGet;
|
||||
|
||||
private String mRemotePath;
|
||||
private String mLocalFolderPath;
|
||||
|
||||
public DownloadRemoteFileOperation(String remotePath, String localFolderPath) {
|
||||
mRemotePath = remotePath;
|
||||
mLocalFolderPath = localFolderPath;
|
||||
}
|
||||
|
||||
@Override
|
||||
protected RemoteOperationResult run(OwnCloudClient client) {
|
||||
RemoteOperationResult result;
|
||||
|
||||
/// download will be performed to a temporal file, then moved to the final location
|
||||
File tmpFile = new File(getTmpPath());
|
||||
|
||||
/// perform the download
|
||||
try {
|
||||
tmpFile.getParentFile().mkdirs();
|
||||
result = downloadFile(client, tmpFile);
|
||||
Timber.i("Download of " + mRemotePath + " to " + getTmpPath() + ": " + result.getLogMessage());
|
||||
|
||||
} catch (Exception e) {
|
||||
result = new RemoteOperationResult<>(e);
|
||||
Timber.e(e, "Download of " + mRemotePath + " to " + getTmpPath() + ": " + result.getLogMessage());
|
||||
}
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
private RemoteOperationResult downloadFile(OwnCloudClient client, File targetFile) throws
|
||||
Exception {
|
||||
|
||||
RemoteOperationResult result;
|
||||
int status;
|
||||
boolean savedFile = false;
|
||||
mGet = new GetMethod(new URL(client.getUserFilesWebDavUri() + WebdavUtils.encodePath(mRemotePath)));
|
||||
Iterator<OnDatatransferProgressListener> it;
|
||||
|
||||
FileOutputStream fos = null;
|
||||
BufferedInputStream bis = null;
|
||||
try {
|
||||
status = client.executeHttpMethod(mGet);
|
||||
if (isSuccess(status)) {
|
||||
targetFile.createNewFile();
|
||||
bis = new BufferedInputStream(mGet.getResponseBodyAsStream());
|
||||
fos = new FileOutputStream(targetFile);
|
||||
long transferred = 0;
|
||||
|
||||
String contentLength = mGet.getResponseHeader(HttpConstants.CONTENT_LENGTH_HEADER);
|
||||
long totalToTransfer =
|
||||
(contentLength != null
|
||||
&& contentLength.length() > 0)
|
||||
? Long.parseLong(contentLength)
|
||||
: 0;
|
||||
|
||||
byte[] bytes = new byte[4096];
|
||||
int readResult;
|
||||
while ((readResult = bis.read(bytes)) != -1) {
|
||||
synchronized (mCancellationRequested) {
|
||||
if (mCancellationRequested.get()) {
|
||||
mGet.abort();
|
||||
throw new OperationCancelledException();
|
||||
}
|
||||
}
|
||||
fos.write(bytes, 0, readResult);
|
||||
transferred += readResult;
|
||||
synchronized (mDataTransferListeners) {
|
||||
it = mDataTransferListeners.iterator();
|
||||
while (it.hasNext()) {
|
||||
it.next().onTransferProgress(readResult, transferred, totalToTransfer,
|
||||
targetFile.getName());
|
||||
}
|
||||
}
|
||||
}
|
||||
if (transferred == totalToTransfer) { // Check if the file is completed
|
||||
savedFile = true;
|
||||
final String modificationTime =
|
||||
mGet.getResponseHeaders().get("Last-Modified") != null
|
||||
? mGet.getResponseHeaders().get("Last-Modified")
|
||||
: mGet.getResponseHeader("last-modified");
|
||||
|
||||
if (modificationTime != null) {
|
||||
final Date d = WebdavUtils.parseResponseDate(modificationTime);
|
||||
mModificationTimestamp = (d != null) ? d.getTime() : 0;
|
||||
} else {
|
||||
Timber.e("Could not read modification time from response downloading %s", mRemotePath);
|
||||
}
|
||||
|
||||
mEtag = WebdavUtils.getEtagFromResponse(mGet);
|
||||
|
||||
// Get rid of extra quotas
|
||||
mEtag = mEtag.replace("\"", "");
|
||||
|
||||
if (mEtag.length() == 0) {
|
||||
Timber.e("Could not read eTag from response downloading %s", mRemotePath);
|
||||
}
|
||||
|
||||
} else {
|
||||
Timber.e("Content-Length not equal to transferred bytes.");
|
||||
Timber.d("totalToTransfer = %d, transferred = %d", totalToTransfer, transferred);
|
||||
client.exhaustResponse(mGet.getResponseBodyAsStream());
|
||||
// TODO some kind of error control!
|
||||
}
|
||||
|
||||
} else if (status != FORBIDDEN_ERROR && status != SERVICE_UNAVAILABLE_ERROR) {
|
||||
client.exhaustResponse(mGet.getResponseBodyAsStream());
|
||||
|
||||
} // else, body read by RemoteOperationResult constructor
|
||||
|
||||
result = isSuccess(status)
|
||||
? new RemoteOperationResult<>(RemoteOperationResult.ResultCode.OK)
|
||||
: new RemoteOperationResult<>(mGet);
|
||||
} finally {
|
||||
if (fos != null) {
|
||||
fos.close();
|
||||
}
|
||||
if (bis != null) {
|
||||
bis.close();
|
||||
}
|
||||
if (!savedFile && targetFile.exists()) {
|
||||
targetFile.delete();
|
||||
}
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
private boolean isSuccess(int status) {
|
||||
return (status == HttpConstants.HTTP_OK);
|
||||
}
|
||||
|
||||
private String getTmpPath() {
|
||||
return mLocalFolderPath + mRemotePath;
|
||||
}
|
||||
|
||||
public void addDatatransferProgressListener(OnDatatransferProgressListener listener) {
|
||||
synchronized (mDataTransferListeners) {
|
||||
mDataTransferListeners.add(listener);
|
||||
}
|
||||
}
|
||||
|
||||
public void removeDatatransferProgressListener(OnDatatransferProgressListener listener) {
|
||||
synchronized (mDataTransferListeners) {
|
||||
mDataTransferListeners.remove(listener);
|
||||
}
|
||||
}
|
||||
|
||||
public void cancel() {
|
||||
mCancellationRequested.set(true); // atomic set; there is no need of synchronizing it
|
||||
}
|
||||
|
||||
public long getModificationTimestamp() {
|
||||
return mModificationTimestamp;
|
||||
}
|
||||
|
||||
public String getEtag() {
|
||||
return mEtag;
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,189 @@
|
||||
/* ownCloud Android Library is available under MIT license
|
||||
* 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.files
|
||||
|
||||
import com.owncloud.android.lib.common.OwnCloudClient
|
||||
import com.owncloud.android.lib.common.http.HttpConstants
|
||||
import com.owncloud.android.lib.common.http.methods.nonwebdav.GetMethod
|
||||
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 timber.log.Timber
|
||||
import java.io.BufferedInputStream
|
||||
import java.io.File
|
||||
import java.io.FileOutputStream
|
||||
import java.net.URL
|
||||
import java.util.HashSet
|
||||
import java.util.concurrent.atomic.AtomicBoolean
|
||||
|
||||
/**
|
||||
* Remote operation performing the download of a remote file in the ownCloud server.
|
||||
*
|
||||
* @author David A. Velasco
|
||||
* @author masensio
|
||||
*/
|
||||
class DownloadRemoteFileOperation(
|
||||
private val remotePath: String,
|
||||
localFolderPath: String
|
||||
) : RemoteOperation<Any>() {
|
||||
|
||||
private val mCancellationRequested = AtomicBoolean(false)
|
||||
private val mDataTransferListeners: MutableSet<OnDatatransferProgressListener> = HashSet()
|
||||
var modificationTimestamp: Long = 0
|
||||
private set
|
||||
|
||||
var etag: String = ""
|
||||
private set
|
||||
|
||||
override fun run(client: OwnCloudClient): RemoteOperationResult<Any> {
|
||||
var result: RemoteOperationResult<Any>
|
||||
|
||||
/// download will be performed to a temporal file, then moved to the final location
|
||||
val tmpFile = File(tmpPath)
|
||||
|
||||
/// perform the download
|
||||
try {
|
||||
tmpFile.mkdirs()
|
||||
result = downloadFile(client, tmpFile)
|
||||
Timber.i("Download of $remotePath to $tmpPath: ${result.logMessage}")
|
||||
} catch (e: Exception) {
|
||||
result = RemoteOperationResult(e)
|
||||
Timber.e(e, "Download of $remotePath to $tmpPath: ${result.logMessage}")
|
||||
}
|
||||
return result
|
||||
}
|
||||
|
||||
@Throws(Exception::class)
|
||||
private fun downloadFile(client: OwnCloudClient, targetFile: File): RemoteOperationResult<Any> {
|
||||
val result: RemoteOperationResult<Any>
|
||||
var it: Iterator<OnDatatransferProgressListener>
|
||||
var fos: FileOutputStream? = null
|
||||
var bis: BufferedInputStream? = null
|
||||
var savedFile = false
|
||||
|
||||
val getMethod = GetMethod(URL(client.userFilesWebDavUri.toString() + WebdavUtils.encodePath(remotePath)))
|
||||
|
||||
try {
|
||||
val status = client.executeHttpMethod(getMethod)
|
||||
|
||||
if (isSuccess(status)) {
|
||||
targetFile.createNewFile()
|
||||
bis = BufferedInputStream(getMethod.getResponseBodyAsStream())
|
||||
fos = FileOutputStream(targetFile)
|
||||
var transferred: Long = 0
|
||||
val contentLength = getMethod.getResponseHeader(HttpConstants.CONTENT_LENGTH_HEADER)
|
||||
val totalToTransfer =
|
||||
if (contentLength != null && contentLength.isNotEmpty()) contentLength.toLong() else 0
|
||||
val bytes = ByteArray(4096)
|
||||
var readResult: Int
|
||||
while (bis.read(bytes).also { readResult = it } != -1) {
|
||||
synchronized(mCancellationRequested) {
|
||||
if (mCancellationRequested.get()) {
|
||||
getMethod.abort()
|
||||
throw OperationCancelledException()
|
||||
}
|
||||
}
|
||||
fos.write(bytes, 0, readResult)
|
||||
transferred += readResult.toLong()
|
||||
synchronized(mDataTransferListeners) {
|
||||
it = mDataTransferListeners.iterator()
|
||||
while (it.hasNext()) {
|
||||
it.next().onTransferProgress(
|
||||
readResult.toLong(), transferred, totalToTransfer,
|
||||
targetFile.name
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (transferred == totalToTransfer) { // Check if the file is completed
|
||||
savedFile = true
|
||||
val modificationTime =
|
||||
getMethod.getResponseHeaders()?.get("Last-Modified")
|
||||
?: getMethod.getResponseHeader("last-modified")
|
||||
|
||||
if (modificationTime != null) {
|
||||
val modificationDate = WebdavUtils.parseResponseDate(modificationTime)
|
||||
modificationTimestamp = modificationDate?.time ?: 0
|
||||
} else {
|
||||
Timber.e("Could not read modification time from response downloading %s", remotePath)
|
||||
}
|
||||
etag = WebdavUtils.getEtagFromResponse(getMethod)
|
||||
|
||||
// Get rid of extra quotas
|
||||
etag = etag.replace("\"", "")
|
||||
if (etag.isEmpty()) {
|
||||
Timber.e("Could not read eTag from response downloading %s", remotePath)
|
||||
}
|
||||
} else {
|
||||
Timber.e("Content-Length not equal to transferred bytes.")
|
||||
Timber.d("totalToTransfer = $totalToTransfer, transferred = $transferred")
|
||||
client.exhaustResponse(getMethod.getResponseBodyAsStream())
|
||||
// TODO some kind of error control!
|
||||
}
|
||||
|
||||
} else if (status != FORBIDDEN_ERROR && status != SERVICE_UNAVAILABLE_ERROR) {
|
||||
client.exhaustResponse(getMethod.getResponseBodyAsStream())
|
||||
} // else, body read by RemoteOperationResult constructor
|
||||
|
||||
result =
|
||||
if (isSuccess(status)) {
|
||||
RemoteOperationResult<Any>(RemoteOperationResult.ResultCode.OK)
|
||||
} else {
|
||||
RemoteOperationResult<Any>(getMethod)
|
||||
}
|
||||
} finally {
|
||||
fos?.close()
|
||||
bis?.close()
|
||||
if (!savedFile && targetFile.exists()) {
|
||||
targetFile.delete()
|
||||
}
|
||||
}
|
||||
return result
|
||||
}
|
||||
|
||||
private fun isSuccess(status: Int) = status == HttpConstants.HTTP_OK
|
||||
|
||||
private val tmpPath: String = localFolderPath + remotePath
|
||||
|
||||
fun addDatatransferProgressListener(listener: OnDatatransferProgressListener) {
|
||||
synchronized(mDataTransferListeners) { mDataTransferListeners.add(listener) }
|
||||
}
|
||||
|
||||
fun removeDatatransferProgressListener(listener: OnDatatransferProgressListener?) {
|
||||
synchronized(mDataTransferListeners) { mDataTransferListeners.remove(listener) }
|
||||
}
|
||||
|
||||
fun cancel() {
|
||||
mCancellationRequested.set(true) // atomic set; there is no need of synchronizing it
|
||||
}
|
||||
|
||||
companion object {
|
||||
private const val FORBIDDEN_ERROR = 403
|
||||
private const val SERVICE_UNAVAILABLE_ERROR = 503
|
||||
}
|
||||
|
||||
}
|
||||
Loading…
x
Reference in New Issue
Block a user