Better failure handling in files renaming and removal

[pub/Android/ownCloud.git] / src / eu / alefzero / webdav / WebdavClient.java

diff --git a/src/eu/alefzero/webdav/WebdavClient.java b/src/eu/alefzero/webdav/WebdavClient.java
index fd1ec50..1135daf 100644 (file)
--- a/src/eu/alefzero/webdav/WebdavClient.java
+++ b/src/eu/alefzero/webdav/WebdavClient.java
@@ -21,10 +21,13 @@ import java.io.BufferedInputStream;
 import java.io.File;\r
 import java.io.FileOutputStream;\r
 import java.io.IOException;\r
 import java.io.File;\r
 import java.io.FileOutputStream;\r
 import java.io.IOException;\r

-import java.util.HashMap;\r

 \r
 import org.apache.commons.httpclient.Credentials;\r
 import org.apache.commons.httpclient.HttpClient;\r
 \r
 import org.apache.commons.httpclient.Credentials;\r
 import org.apache.commons.httpclient.HttpClient;\r

+import org.apache.commons.httpclient.HttpException;\r
+import org.apache.commons.httpclient.HttpMethodBase;\r
+import org.apache.commons.httpclient.HttpVersion;\r
+import org.apache.commons.httpclient.MultiThreadedHttpConnectionManager;\r

 import org.apache.commons.httpclient.UsernamePasswordCredentials;\r
 import org.apache.commons.httpclient.auth.AuthScope;\r
 import org.apache.commons.httpclient.methods.GetMethod;\r
 import org.apache.commons.httpclient.UsernamePasswordCredentials;\r
 import org.apache.commons.httpclient.auth.AuthScope;\r
 import org.apache.commons.httpclient.methods.GetMethod;\r


@@ -33,6 +36,7 @@ import org.apache.commons.httpclient.methods.PutMethod;
 import org.apache.commons.httpclient.params.HttpMethodParams;\r
 import org.apache.commons.httpclient.protocol.Protocol;\r
 import org.apache.http.HttpStatus;\r
 import org.apache.commons.httpclient.params.HttpMethodParams;\r
 import org.apache.commons.httpclient.protocol.Protocol;\r
 import org.apache.http.HttpStatus;\r

+import org.apache.http.params.CoreProtocolPNames;\r

 import org.apache.jackrabbit.webdav.client.methods.DavMethod;\r
 import org.apache.jackrabbit.webdav.client.methods.DeleteMethod;\r
 import org.apache.jackrabbit.webdav.client.methods.MkColMethod;\r
 import org.apache.jackrabbit.webdav.client.methods.DavMethod;\r
 import org.apache.jackrabbit.webdav.client.methods.DeleteMethod;\r
 import org.apache.jackrabbit.webdav.client.methods.MkColMethod;\r


@@ -53,8 +57,24 @@ public class WebdavClient extends HttpClient {
     private Credentials mCredentials;\r
     final private static String TAG = "WebdavClient";\r
     private static final String USER_AGENT = "Android-ownCloud";\r
     private Credentials mCredentials;\r
     final private static String TAG = "WebdavClient";\r
     private static final String USER_AGENT = "Android-ownCloud";\r

+    \r
+    /** Default timeout for waiting data from the server: 10 seconds */\r
+    public static final int DEFAULT_DATA_TIMEOUT = 10000;\r
+    \r
+    /** Default timeout for establishing a connection: infinite */\r
+    public static final int DEFAULT_CONNECTION_TIMEOUT = 0;\r
+    \r

     private OnDatatransferProgressListener mDataTransferListener;\r
     private OnDatatransferProgressListener mDataTransferListener;\r

-    private static HashMap<String, WebdavClient> clients = new HashMap<String, WebdavClient>();\r
+    static private MultiThreadedHttpConnectionManager mConnManager = null;\r
+    \r
+    static public MultiThreadedHttpConnectionManager getMultiThreadedConnManager() {\r
+        if (mConnManager == null) {\r
+            mConnManager = new MultiThreadedHttpConnectionManager();\r
+            mConnManager.setMaxConnectionsPerHost(5);\r
+            mConnManager.setMaxTotalConnections(5);\r
+        }\r
+        return mConnManager;\r
+    }\r

     \r
     /**\r
      * Creates a WebdavClient setup for the current account\r
     \r
     /**\r
      * Creates a WebdavClient setup for the current account\r


@@ -62,21 +82,30 @@ public class WebdavClient extends HttpClient {
      * @param context The application context\r
      * @return\r
      */\r
      * @param context The application context\r
      * @return\r
      */\r

-    public WebdavClient (Account account, Context context){\r
+    public WebdavClient (Account account, Context context) {\r
+        setDefaultTimeouts();\r
+        \r

         OwnCloudVersion ownCloudVersion = new OwnCloudVersion(AccountManager.get(context).getUserData(account,\r
                 AccountAuthenticator.KEY_OC_VERSION));\r
         String baseUrl = AccountManager.get(context).getUserData(account, AccountAuthenticator.KEY_OC_BASE_URL);\r
         String webDavPath = AccountUtils.getWebdavPath(ownCloudVersion);        \r
         OwnCloudVersion ownCloudVersion = new OwnCloudVersion(AccountManager.get(context).getUserData(account,\r
                 AccountAuthenticator.KEY_OC_VERSION));\r
         String baseUrl = AccountManager.get(context).getUserData(account, AccountAuthenticator.KEY_OC_BASE_URL);\r
         String webDavPath = AccountUtils.getWebdavPath(ownCloudVersion);        \r

-        String username = account.name.substring(0, account.name.indexOf('@'));\r
+        String username = account.name.substring(0, account.name.lastIndexOf('@'));\r

         String password = AccountManager.get(context).getPassword(account);\r
         \r
         mUri = Uri.parse(baseUrl + webDavPath);\r
         String password = AccountManager.get(context).getPassword(account);\r
         \r
         mUri = Uri.parse(baseUrl + webDavPath);\r

-        getParams().setParameter(HttpMethodParams.USER_AGENT, USER_AGENT);\r
+        Log.e("ASD", ""+username);\r

         setCredentials(username, password);\r
         setCredentials(username, password);\r

-        allowSelfsignedCertificates();\r

     }\r
     \r
     }\r
     \r

-    public WebdavClient(){}\r
+    public WebdavClient() {\r
+        super(getMultiThreadedConnManager());\r
+        \r
+        setDefaultTimeouts();\r
+        \r
+        getParams().setParameter(HttpMethodParams.USER_AGENT, USER_AGENT);\r
+        getParams().setParameter(CoreProtocolPNames.PROTOCOL_VERSION, HttpVersion.HTTP_1_1);\r
+        allowSelfsignedCertificates();\r
+    }\r

 \r
     public void setCredentials(String username, String password) {\r
         getParams().setAuthenticationPreemptive(true);\r
 \r
     public void setCredentials(String username, String password) {\r
         getParams().setAuthenticationPreemptive(true);\r


@@ -89,6 +118,14 @@ public class WebdavClient extends HttpClient {
             mCredentials = new UsernamePasswordCredentials(username, password);\r
         return mCredentials;\r
     }\r
             mCredentials = new UsernamePasswordCredentials(username, password);\r
         return mCredentials;\r
     }\r

+    \r
+    /**\r
+     * Sets the connection and wait-for-data timeouts to be applied by default.\r
+     */\r
+    private void setDefaultTimeouts() {\r
+        getParams().setSoTimeout(DEFAULT_DATA_TIMEOUT);\r
+        getHttpConnectionManager().getParams().setConnectionTimeout(DEFAULT_CONNECTION_TIMEOUT);\r
+    }\r

 \r
     public void allowSelfsignedCertificates() {\r
         // https\r
 \r
     public void allowSelfsignedCertificates() {\r
         // https\r


@@ -96,47 +133,65 @@ public class WebdavClient extends HttpClient {
                 new EasySSLSocketFactory(), 443));\r
     }\r
 \r
                 new EasySSLSocketFactory(), 443));\r
     }\r
 \r

-    public boolean downloadFile(String remoteFilepath, File targetPath) {\r
-        GetMethod get = new GetMethod(mUri.toString() + remoteFilepath);\r
-        HttpMethodParams params = get.getParams();\r
-        params.setSoTimeout(0); // that means "infinite timeout"; it's the default value, but let's make it explicit\r
-        get.setParams(params);\r
-\r
-        // get.setHeader("Host", mUri.getHost());\r
-        // get.setHeader("User-Agent", "Android-ownCloud");\r
+    /**\r
+     * Downloads a file in remoteFilepath to the local targetPath.\r
+     * \r
+     * @param remoteFilepath    Path to the file in the remote server, URL DECODED. \r
+     * @param targetFile        Local path to save the downloaded file.\r
+     * @return                  'True' when the file is successfully downloaded.\r
+     */\r
+    public boolean downloadFile(String remoteFilepath, File targetFile) {\r
+        boolean ret = false;\r
+        GetMethod get = new GetMethod(mUri.toString() + WebdavUtils.encodePath(remoteFilepath));\r

 \r
 \r

+        int status = -1;\r

         try {\r
         try {\r

-            int status = executeMethod(get);\r
-            Log.e(TAG, "status return: " + status);\r
-            if (status != HttpStatus.SC_OK) {\r
-                return false;\r
-            }\r
-            BufferedInputStream bis = new BufferedInputStream(\r
-                    get.getResponseBodyAsStream());\r
-            FileOutputStream fos = new FileOutputStream(targetPath);\r
-\r
-            byte[] bytes = new byte[4096];\r
-            int readResult;\r
-            while ((readResult = bis.read(bytes)) != -1) {\r
-                if (mDataTransferListener != null)\r
-                    mDataTransferListener.transferProgress(readResult);\r
-                fos.write(bytes, 0, readResult);\r
+            status = executeMethod(get);\r
+            if (status == HttpStatus.SC_OK) {\r
+                targetFile.createNewFile();\r
+                BufferedInputStream bis = new BufferedInputStream(\r
+                        get.getResponseBodyAsStream());\r
+                FileOutputStream fos = new FileOutputStream(targetFile);\r
+\r
+                byte[] bytes = new byte[4096];\r
+                int readResult;\r
+                while ((readResult = bis.read(bytes)) != -1) {\r
+                    if (mDataTransferListener != null)\r
+                        mDataTransferListener.transferProgress(readResult);\r
+                    fos.write(bytes, 0, readResult);\r
+                }\r
+                ret = true;\r

             }\r
             }\r

+            \r
+        } catch (HttpException e) {\r
+            Log.e(TAG, "HTTP exception downloading " + remoteFilepath, e);\r

 \r
         } catch (IOException e) {\r
 \r
         } catch (IOException e) {\r

-            e.printStackTrace();\r
-            return false;\r
+            Log.e(TAG, "I/O exception downloading " + remoteFilepath, e);\r
+\r
+        } catch (Exception e) {\r
+            Log.e(TAG, "Unexpected exception downloading " + remoteFilepath, e);\r
+            \r
+        } finally {\r
+            if (!ret) {\r
+                if (status >= 0) {\r
+                    Log.e(TAG, "Download of " + remoteFilepath + " to " + targetFile + " failed with HTTP status " + status);\r
+                }\r
+                if (targetFile.exists()) {\r
+                    targetFile.delete();\r
+                }\r
+            }\r

         }\r
         }\r

-        return true;\r
+        return ret;\r

     }\r
     \r
     /**\r
      * Deletes a remote file via webdav\r
     }\r
     \r
     /**\r
      * Deletes a remote file via webdav\r

-     * @param remoteFilePath\r
+     * @param remoteFilePath       Remote file path of the file to delete, in URL DECODED format.\r

      * @return\r
      */\r
     public boolean deleteFile(String remoteFilePath){\r
      * @return\r
      */\r
     public boolean deleteFile(String remoteFilePath){\r

-        DavMethod delete = new DeleteMethod(mUri.toString() + remoteFilePath);\r
+        DavMethod delete = new DeleteMethod(mUri.toString() + WebdavUtils.encodePath(remoteFilePath));\r

         try {\r
             executeMethod(delete);\r
         }  catch (Throwable e) {\r
         try {\r
             executeMethod(delete);\r
         }  catch (Throwable e) {\r


@@ -150,31 +205,43 @@ public class WebdavClient extends HttpClient {
         mDataTransferListener = listener;\r
     }\r
     \r
         mDataTransferListener = listener;\r
     }\r
     \r

-    public boolean putFile(String localFile, String remoteTarget,\r
-            String contentType) {\r
-        boolean result = true;\r
+    /**\r
+     * Creates or update a file in the remote server with the contents of a local file.\r
+     * \r
+     * \r
+     * @param localFile         Path to the local file to upload.\r
+     * @param remoteTarget      Remote path to the file to create or update, URL DECODED\r
+     * @param contentType       MIME type of the file.\r
+     * @return                  'True' then the upload was successfully completed\r
+     */\r
+    public boolean putFile(String localFile, String remoteTarget, String contentType) {\r
+        boolean result = false;\r
+        int status = -1;\r

 \r
         try {\r
 \r
         try {\r

-            Log.e("ASD", contentType + "");\r

             File f = new File(localFile);\r
             FileRequestEntity entity = new FileRequestEntity(f, contentType);\r
             entity.setOnDatatransferProgressListener(mDataTransferListener);\r
             File f = new File(localFile);\r
             FileRequestEntity entity = new FileRequestEntity(f, contentType);\r
             entity.setOnDatatransferProgressListener(mDataTransferListener);\r

-            Log.e("ASD", f.exists() + " " + entity.getContentLength());\r
-            PutMethod put = new PutMethod(mUri.toString() + remoteTarget);\r
-            HttpMethodParams params = put.getParams();\r
-            params.setSoTimeout(0); // that means "infinite timeout"; it's the default value, but let's make it explicit\r
-            put.setParams(params);\r
+            PutMethod put = new PutMethod(mUri.toString() + WebdavUtils.encodePath(remoteTarget));\r

             put.setRequestEntity(entity);\r
             put.setRequestEntity(entity);\r

-            Log.d(TAG, "" + put.getURI().toString());\r
-            int status = executeMethod(put);\r
-            Log.d(TAG, "PUT method return with status " + status);\r
-\r
-            Log.i(TAG, "Uploading, done");\r
-        } catch (final Exception e) {\r
-            Log.i(TAG, "" + e.getMessage());\r
-            result = false;\r
-        }\r
+            status = executeMethod(put);\r
+            \r
+            result = (status == HttpStatus.SC_OK || status == HttpStatus.SC_CREATED || status == HttpStatus.SC_NO_CONTENT);\r
+            \r
+            Log.d(TAG, "PUT response for " + remoteTarget + " finished with HTTP status " + status);\r
+            \r
+        } catch (HttpException e) {\r
+            Log.e(TAG, "HTTP exception uploading " + localFile + " to " + remoteTarget, e);\r

 \r
 \r

+        } catch (IOException e) {\r
+            Log.e(TAG, "I/O exception uploading " + localFile + " to " + remoteTarget, e);\r
+\r
+        } catch (Exception e) {\r
+            Log.e(TAG, "Unexpected exception uploading " + localFile + " to " + remoteTarget, e);\r
+        }\r
+        \r
+        if (!result && status >= 0) Log.e(TAG, "Upload of " + localFile + " to " + remoteTarget + " FAILED with HTTP status " + status);\r
+        \r

         return result;\r
     }\r
 \r
         return result;\r
     }\r
 \r


@@ -192,23 +259,89 @@ public class WebdavClient extends HttpClient {
         HeadMethod head = new HeadMethod(uri.toString());\r
         try {\r
             returnCode = client.executeMethod(head);\r
         HeadMethod head = new HeadMethod(uri.toString());\r
         try {\r
             returnCode = client.executeMethod(head);\r

+        } catch (HttpException e) {\r
+            Log.e(TAG, "HTTP exception trying to login at " + uri.getEncodedPath(), e);\r
+        } catch (IOException e) {\r
+            Log.e(TAG, "I/O exception trying to login at " + uri.getEncodedPath(), e);\r

         } catch (Exception e) {\r
         } catch (Exception e) {\r

-            Log.e(TAG, "Error: " + e.getMessage());\r
+            Log.e(TAG, "Unexpected exception trying to login at " + uri.getEncodedPath(), e);\r

         }\r
         return returnCode;\r
     }\r
 \r
         }\r
         return returnCode;\r
     }\r
 \r

+    /**\r
+     * Creates a remote directory with the received path.\r
+     * \r
+     * @param path      Path of the directory to create, URL DECODED\r
+     * @return          'True' when the directory is successfully created\r
+     */\r

     public boolean createDirectory(String path) {\r
     public boolean createDirectory(String path) {\r

+        boolean result = false;\r
+        int status = -1;\r
+        try {\r
+            MkColMethod mkcol = new MkColMethod(mUri.toString() + WebdavUtils.encodePath(path));\r
+            Log.d(TAG, "Creating directory " + path);\r
+            status = executeMethod(mkcol);\r
+            Log.d(TAG, "Status returned: " + status);\r
+            result = mkcol.succeeded();\r
+            \r
+        } catch (HttpException e) {\r
+            Log.e(TAG, "HTTP exception creating directory " + path, e);\r
+\r
+        } catch (IOException e) {\r
+            Log.e(TAG, "I/O exception creating directory " + path, e);\r
+\r
+        } catch (Exception e) {\r
+            Log.e(TAG, "Unexpected exception creating directory " + path, e);\r
+            \r
+        }\r
+        if (!result && status >= 0) {\r
+            Log.e(TAG, "Creation of directory " + path + " failed with HTTP status " + status);\r
+        }\r
+        return result;\r
+    }\r
+    \r
+    \r
+    /**\r
+     * Check if a file exists in the OC server\r
+     * \r
+     * @return      'Boolean.TRUE' if the file exists; 'Boolean.FALSE' it doesn't exist; NULL if couldn't be checked\r
+     */\r
+    public Boolean existsFile(String path) {\r

         try {\r
         try {\r

-            MkColMethod mkcol = new MkColMethod(mUri.toString() + path);\r
-            int status = executeMethod(mkcol);\r
-            Log.d(TAG, "Status returned " + status);\r
-            Log.d(TAG, "uri: " + mkcol.getURI().toString());\r
-            Log.i(TAG, "Creating dir completed");\r
-        } catch (final Exception e) {\r
+            HeadMethod head = new HeadMethod(mUri.toString() + WebdavUtils.encodePath(path));\r
+            int status = executeMethod(head);\r
+            return (status == HttpStatus.SC_OK);\r
+        } catch (Exception e) {\r

             e.printStackTrace();\r
             e.printStackTrace();\r

-            return false;\r
+            return null;\r
+        }\r
+    }\r
+\r
+\r
+    /**\r
+     * Requests the received method with the received timeout (milliseconds).\r
+     * \r
+     * Executes the method through the inherited HttpClient.executedMethod(method).\r
+     * \r
+     * Sets the socket timeout for the HttpMethodBase method received.\r
+     * \r
+     * @param method    HTTP method request.\r
+     * @param timeout   Timeout to set, in milliseconds; <= 0 means infinite.\r
+     */\r
+    public int executeMethod(HttpMethodBase method, int readTimeout) throws HttpException, IOException {\r
+        int oldSoTimeout = getParams().getSoTimeout();\r
+        try {\r
+            if (readTimeout < 0) { \r
+                readTimeout = 0;\r
+            }\r
+            HttpMethodParams params = method.getParams();\r
+            params.setSoTimeout(readTimeout);       \r
+            method.setParams(params);               // this should be enough...\r
+            getParams().setSoTimeout(readTimeout);  // ... but this is necessary for HTTPS\r
+            return executeMethod(method);\r
+        } finally {\r
+            getParams().setSoTimeout(oldSoTimeout);\r

         }\r
         }\r

-        return true;\r

     }\r
 }\r
     }\r
 }\r