Adding cancellation to uploads (WIP)

[pub/Android/ownCloud.git] / src / com / owncloud / android / operations / RemoteOperationResult.java

diff --git a/src/com/owncloud/android/operations/RemoteOperationResult.java b/src/com/owncloud/android/operations/RemoteOperationResult.java
index 03afda5..0618b86 100644 (file)
--- a/src/com/owncloud/android/operations/RemoteOperationResult.java
+++ b/src/com/owncloud/android/operations/RemoteOperationResult.java
@@ -1,5 +1,24 @@
+/* ownCloud Android client application
+ *   Copyright (C) 2012 Bartek Przybylski
+ *
+ *   This program is free software: you can redistribute it and/or modify
+ *   it under the terms of the GNU General Public License as published by
+ *   the Free Software Foundation, either version 3 of the License, or
+ *   (at your option) any later version.
+ *
+ *   This program is distributed in the hope that it will be useful,
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *   GNU General Public License for more details.
+ *
+ *   You should have received a copy of the GNU General Public License
+ *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+

 package com.owncloud.android.operations;
 
 package com.owncloud.android.operations;
 

+import java.io.IOException;

 import java.net.MalformedURLException;
 import java.net.SocketException;
 import java.net.SocketTimeoutException;
 import java.net.MalformedURLException;
 import java.net.SocketException;
 import java.net.SocketTimeoutException;


@@ -8,16 +27,22 @@ import java.net.UnknownHostException;
 import javax.net.ssl.SSLException;
 
 import org.apache.commons.httpclient.ConnectTimeoutException;
 import javax.net.ssl.SSLException;
 
 import org.apache.commons.httpclient.ConnectTimeoutException;

+import org.apache.commons.httpclient.HttpException;

 import org.apache.commons.httpclient.HttpStatus;
 
 import org.apache.commons.httpclient.HttpStatus;
 

-import android.util.Log;
-

 import com.owncloud.android.network.CertificateCombinedException;
 
 
 import com.owncloud.android.network.CertificateCombinedException;
 
 

+/**
+ * The result of a remote operation required to an ownCloud server.
+ * 
+ * Provides a common classification of remote operation results for all the application. 
+ * 
+ * @author David A. Velasco
+ */

 public class RemoteOperationResult {
     
 public class RemoteOperationResult {
     

-    public enum ResultCode {    // TODO leave alone our own errors
+    public enum ResultCode { 

         OK,
         OK_SSL,
         OK_NO_SSL,
         OK,
         OK_SSL,
         OK_NO_SSL,


@@ -31,11 +56,12 @@ public class RemoteOperationResult {
         HOST_NOT_AVAILABLE, 
         NO_NETWORK_CONNECTION, 
         SSL_ERROR,
         HOST_NOT_AVAILABLE, 
         NO_NETWORK_CONNECTION, 
         SSL_ERROR,

-        BAD_OC_VERSION, 
+        SSL_RECOVERABLE_PEER_UNVERIFIED,
+        BAD_OC_VERSION,
+        STORAGE_ERROR_MOVING_FROM_TMP,
+        CANCELLED

     }
 
     }
 

-    private static final String TAG = null;
-    

     private boolean mSuccess = false;
     private int mHttpCode = -1;
     private Exception mException = null;
     private boolean mSuccess = false;
     private int mHttpCode = -1;
     private Exception mException = null;


@@ -70,42 +96,40 @@ public class RemoteOperationResult {
     public RemoteOperationResult(Exception e) {
         mException = e; 
         
     public RemoteOperationResult(Exception e) {
         mException = e; 
         

-        if (e instanceof SocketException) {  
+        if (e instanceof OperationCancelledException) {
+            mCode = ResultCode.CANCELLED;
+            
+        } else if (e instanceof SocketException) {  

             mCode = ResultCode.WRONG_CONNECTION;
             mCode = ResultCode.WRONG_CONNECTION;

-            Log.e(TAG, "Socket exception", e);

         
         } else if (e instanceof SocketTimeoutException) {
             mCode = ResultCode.TIMEOUT;
         
         } else if (e instanceof SocketTimeoutException) {
             mCode = ResultCode.TIMEOUT;

-            Log.e(TAG, "Socket timeout exception", e);

         
         } else if (e instanceof ConnectTimeoutException) {
             mCode = ResultCode.TIMEOUT;
         
         } else if (e instanceof ConnectTimeoutException) {
             mCode = ResultCode.TIMEOUT;

-            Log.e(TAG, "Connect timeout exception", e);

             
         } else if (e instanceof MalformedURLException) {
             mCode = ResultCode.INCORRECT_ADDRESS;
             
         } else if (e instanceof MalformedURLException) {
             mCode = ResultCode.INCORRECT_ADDRESS;

-            Log.e(TAG, "Malformed URL exception", e);

         
         } else if (e instanceof UnknownHostException) {
             mCode = ResultCode.HOST_NOT_AVAILABLE;
         
         } else if (e instanceof UnknownHostException) {
             mCode = ResultCode.HOST_NOT_AVAILABLE;

-            Log.e(TAG, "Unknown host exception", e);

         
         

-        } else if (e instanceof SSLException) {
-            mCode = ResultCode.SSL_ERROR;
-            Log.e(TAG, "SSL exception", e);
+        } else if (e instanceof SSLException || e instanceof RuntimeException) {
+            CertificateCombinedException se = getCertificateCombinedException(e);
+            if (se != null) {
+                mException = se;
+                if (se.isRecoverable()) { 
+                    mCode = ResultCode.SSL_RECOVERABLE_PEER_UNVERIFIED;
+                }
+                
+            } else { 
+                mCode = ResultCode.SSL_ERROR;
+            }

             
         } else {
             mCode = ResultCode.UNKNOWN_ERROR;
             
         } else {
             mCode = ResultCode.UNKNOWN_ERROR;

-            Log.e(TAG, "Unknown exception", e);

         }
         }

-            
-        /*  }   catch (HttpException e) { // other specific exceptions from org.apache.commons.httpclient
-                Log.e(TAG, "HTTP exception while trying connection", e);
-            }   catch (IOException e) {   // UnkownsServiceException, and any other transport exceptions that could occur
-                Log.e(TAG, "I/O exception while trying connection", e);
-            }   catch (Exception e) {
-                Log.e(TAG, "Unexpected exception while trying connection", e);
-        */
+        

     }
     
     
     }
     
     


@@ -113,6 +137,10 @@ public class RemoteOperationResult {
         return mSuccess;
     }
     
         return mSuccess;
     }
     

+    public boolean isCancelled() {
+        return mCode == ResultCode.CANCELLED;
+    }
+    

     public int getHttpCode() {
         return mHttpCode;
     }
     public int getHttpCode() {
         return mHttpCode;
     }


@@ -126,27 +154,80 @@ public class RemoteOperationResult {
     }
 
     public boolean isSslRecoverableException() {
     }
 
     public boolean isSslRecoverableException() {

-        return (getSslRecoverableException() != null);
+        return mCode == ResultCode.SSL_RECOVERABLE_PEER_UNVERIFIED;

     }
     
     }
     

-    public CertificateCombinedException getSslRecoverableException() {
+    private CertificateCombinedException getCertificateCombinedException(Exception e) {

         CertificateCombinedException result = null;
         CertificateCombinedException result = null;

-        if (mCode == ResultCode.SSL_ERROR) {
-            if (mException instanceof CertificateCombinedException)
-                result = (CertificateCombinedException)mException;
-            Throwable cause = mException.getCause();
-            Throwable previousCause = null;
-            while (cause != null && cause != previousCause && !(cause instanceof CertificateCombinedException)) {
-                previousCause = cause;
-                cause = cause.getCause();
+        if (e instanceof CertificateCombinedException) {
+            return (CertificateCombinedException)e;
+        }
+        Throwable cause = mException.getCause();
+        Throwable previousCause = null;
+        while (cause != null && cause != previousCause && !(cause instanceof CertificateCombinedException)) {
+            previousCause = cause;
+            cause = cause.getCause();
+        }
+        if (cause != null && cause instanceof CertificateCombinedException) {
+            result = (CertificateCombinedException)cause; 
+        }
+        return result;
+    }
+    
+    
+    public String getLogMessage() {
+        
+        if (mException != null) {
+            if (mException instanceof OperationCancelledException) {
+                return "Operation cancelled by the caller";
+                
+            } else if (mException instanceof SocketException) {  
+                return "Socket exception";
+        
+            } else if (mException instanceof SocketTimeoutException) {
+                return "Socket timeout exception";
+        
+            } else if (mException instanceof ConnectTimeoutException) {
+                return "Connect timeout exception";
+            
+            } else if (mException instanceof MalformedURLException) {
+                return "Malformed URL exception";
+        
+            } else if (mException instanceof UnknownHostException) {
+                return "Unknown host exception";
+        
+            } else if (mException instanceof SSLException) {
+                if (mCode == ResultCode.SSL_RECOVERABLE_PEER_UNVERIFIED)
+                    return "SSL recoverable exception";
+                else
+                    return "SSL exception";
+
+            } else if (mException instanceof HttpException) {
+                return "HTTP violation";
+
+            } else if (mException instanceof IOException) {
+                return "Unrecovered transport exception";
+
+            } else {
+                return "Unexpected exception";

             }
             }

-            if (cause != null && cause instanceof CertificateCombinedException)
-                result = (CertificateCombinedException)cause; 

         }
         }

-        if (result != null && result.isRecoverable())
-            return result;
-        else
-            return null;
+        
+        if (mCode == ResultCode.INSTANCE_NOT_CONFIGURED) {
+            return "The ownCloud server is not configured!";
+            
+        } else if (mCode == ResultCode.NO_NETWORK_CONNECTION) {
+            return "No network connection";
+            
+        } else if (mCode == ResultCode.BAD_OC_VERSION) {
+            return "No valid ownCloud version was found at the server";
+            
+        } else if (mCode == ResultCode.STORAGE_ERROR_MOVING_FROM_TMP) {
+            return "Error while moving file from temporal to final directory";
+        }
+        
+        return "Operation finished with HTTP status code " + mHttpCode + " (" + (isSuccess()?"success":"fail") + ")";
+

     }
 
 }
     }
 
 }