Cancellation of current download in details view - UI changes

[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 4d97ceb..f3aca3e 100644 (file)
--- a/src/eu/alefzero/webdav/WebdavClient.java
+++ b/src/eu/alefzero/webdav/WebdavClient.java
@@ -18,179 +18,323 @@
 package eu.alefzero.webdav;\r
 \r
 import java.io.BufferedInputStream;\r
 package eu.alefzero.webdav;\r
 \r
 import java.io.BufferedInputStream;\r

-import java.io.BufferedOutputStream;\r

 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.io.InputStreamReader;\r
-import java.io.OutputStreamWriter;\r
+import java.io.InputStream;\r

 \r
 \r

-import org.apache.http.HttpHost;\r
-import org.apache.http.HttpResponse;\r
+import org.apache.commons.httpclient.Credentials;\r
+import org.apache.commons.httpclient.HttpClient;\r
+import org.apache.commons.httpclient.HttpConnectionManager;\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.UsernamePasswordCredentials;\r
+import org.apache.commons.httpclient.auth.AuthScope;\r
+import org.apache.commons.httpclient.methods.GetMethod;\r
+import org.apache.commons.httpclient.methods.HeadMethod;\r
+import org.apache.commons.httpclient.methods.PutMethod;\r
+import org.apache.commons.httpclient.params.HttpMethodParams;\r

 import org.apache.http.HttpStatus;\r
 import org.apache.http.HttpStatus;\r

-import org.apache.http.HttpVersion;\r
-import org.apache.http.auth.AuthScope;\r
-import org.apache.http.auth.UsernamePasswordCredentials;\r
-import org.apache.http.client.methods.HttpGet;\r
-import org.apache.http.client.methods.HttpPut;\r
-import org.apache.http.conn.ClientConnectionManager;\r
-import org.apache.http.conn.params.ConnManagerPNames;\r
-import org.apache.http.conn.params.ConnPerRouteBean;\r
-import org.apache.http.conn.scheme.PlainSocketFactory;\r
-import org.apache.http.conn.scheme.Scheme;\r
-import org.apache.http.conn.scheme.SchemeRegistry;\r
-import org.apache.http.conn.ssl.SSLSocketFactory;\r
-import org.apache.http.entity.FileEntity;\r
-import org.apache.http.entity.mime.content.FileBody;\r
-import org.apache.http.impl.auth.BasicScheme;\r
-import org.apache.http.impl.client.DefaultHttpClient;\r
-import org.apache.http.impl.conn.tsccm.ThreadSafeClientConnManager;\r
-import org.apache.http.params.BasicHttpParams;\r
-import org.apache.http.params.HttpParams;\r
-import org.apache.http.params.HttpProtocolParams;\r
-import org.apache.http.protocol.BasicHttpContext;\r
-\r
-import eu.alefzero.owncloud.authenticator.EasySSLSocketFactory;\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

 \r
 import android.net.Uri;\r
 import android.util.Log;\r
 \r
 \r
 import android.net.Uri;\r
 import android.util.Log;\r
 \r

-/**\r
- * A basic WebDAV-Client\r
- * @author Bartek Przybylski\r
- *\r
- */\r
-public class WebdavClient {\r
-  private DefaultHttpClient mHttpClient;\r
-  private BasicHttpContext mHttpContext;\r
-  private HttpHost mTargetHost;\r
-  private SchemeRegistry mSchemeRegistry;\r
-  private Uri mUri;\r
-  final private static String TAG = "WebdavClient";\r
-  \r
-  public WebdavClient(Uri uri) {\r
-    mUri = uri;\r
-    mSchemeRegistry = new SchemeRegistry();\r
-    setupHttpClient();\r
-  }\r
-  \r
-  public void setCredentials(String username, String password) {\r
-    // determine default port for http or https\r
-    int targetPort = mTargetHost.getPort() == -1 ? \r
-                        ( mUri.getScheme().equals("https") ? 443 : 80)\r
-                        : mUri.getPort();\r
-\r
-    mHttpClient.getCredentialsProvider().setCredentials(\r
-        new AuthScope(mUri.getHost(), targetPort), \r
-        new UsernamePasswordCredentials(username, password));\r
-    BasicScheme basicAuth = new BasicScheme();\r
-    mHttpContext.setAttribute("preemptive-auth", basicAuth);\r
-  }\r
-  \r
-  public void allowUnsignedCertificates() {\r
-    // https\r
-    mSchemeRegistry.register(new Scheme("https", new EasySSLSocketFactory(), 443));\r
-  }\r
-  \r
-  public boolean downloadFile(String filepath, File targetPath) {\r
-    HttpGet get = new HttpGet(mUri.toString() + filepath.replace(" ", "%20"));\r
-    get.setHeader("Host", mUri.getHost());\r
-    get.setHeader("User-Agent", "Android-ownCloud");\r
+public class WebdavClient extends HttpClient {\r
+    private Uri mUri;\r
+    private Credentials mCredentials;\r
+    final private static String TAG = "WebdavClient";\r
+    private static final String USER_AGENT = "Android-ownCloud";\r

     \r
     \r

-    try {\r
-      HttpResponse response = mHttpClient.execute(mTargetHost, get, mHttpContext);\r
-      if (response.getStatusLine().getStatusCode() != HttpStatus.SC_OK) {\r
-        return false;\r
-      }\r
-      BufferedInputStream bis = new BufferedInputStream(response.getEntity().getContent());\r
-      FileOutputStream fos = new FileOutputStream(targetPath);\r
-      \r
-      byte[] bytes = new byte[512];\r
-      int readResult;\r
-      while ((readResult = bis.read(bytes)) != -1) fos.write(bytes, 0, readResult);\r
-      \r
-    } catch (IOException e) {\r
-      e.printStackTrace();\r
-      return false;\r
-    }\r
-    return true;\r
-  }\r
-  \r
-  void getFileList(String dirPath) {\r
+    private OnDatatransferProgressListener mDataTransferListener;\r
+    static private byte[] sExhaustBuffer = new byte[1024];\r

     \r
     \r

-  }\r
-  \r
-  public boolean putFile(String localFile,\r
-                  String remoteTarget,\r
-                  String contentType) {\r
-    boolean result = true;\r
-    HttpPut method = new HttpPut(mUri.toString() + remoteTarget.replace(" ", "%20"));\r
-    method.setHeader("Content-type", contentType);\r
-    method.setHeader("Host", mUri.getHost());\r
-    method.setHeader("User-Agent", "Android-ownCloud");\r
-\r
-    try {\r
-      FileBody fb = new FileBody(new File(localFile, contentType));\r
-      final FileEntity fileEntity = new FileEntity(new File(localFile), contentType);\r
-\r
-      method.setEntity(fileEntity);\r
-      Log.i(TAG, "executing:" + method.getRequestLine().toString());\r
-\r
-      mHttpClient.execute(mTargetHost, method, mHttpContext);\r
-      /*mHandler.post(new Runnable() {\r
-      public void run() {\r
-        Uploader.this.PartialupdateUpload(c.getString(c.getColumnIndex(Media.DATA)),\r
-                                                  c.getString(c.getColumnIndex(Media.DISPLAY_NAME)),\r
-                                                  mUploadPath + (mUploadPath.equals("/")?"":"/"),\r
-                                                  fileEntity.getContentType().getValue(),\r
-                                                  fileEntity.getContentLength()+"");\r
-      }\r
-    });\r
-    Log.i(TAG, "Uploading, done");\r
-*/\r
-      Log.i(TAG, "Uploading, done");\r
-    } catch (final Exception e) {\r
-      Log.i(TAG, ""+e.getMessage());\r
-      result = false;\r
+    /**\r
+     * Constructor\r
+     */\r
+    public WebdavClient(HttpConnectionManager connectionMgr) {\r
+        super(connectionMgr);\r
+        Log.d(TAG, "Creating WebdavClient");\r
+        getParams().setParameter(HttpMethodParams.USER_AGENT, USER_AGENT);\r
+        getParams().setParameter(CoreProtocolPNames.PROTOCOL_VERSION, HttpVersion.HTTP_1_1);\r
+    }\r
+\r
+    public void setCredentials(String username, String password) {\r
+        getParams().setAuthenticationPreemptive(true);\r
+        getState().setCredentials(AuthScope.ANY,\r
+                getCredentials(username, password));\r
+    }\r
+\r
+    private Credentials getCredentials(String username, String password) {\r
+        if (mCredentials == null)\r
+            mCredentials = new UsernamePasswordCredentials(username, password);\r
+        return mCredentials;\r

     }\r
     \r
     }\r
     \r

-    return result;\r
-  }\r
-  \r
-  public boolean createDirectory(String path) {\r
-    HttpMkCol method = new HttpMkCol(mUri.toString() + path + "/");\r
-    method.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
+        try {\r
+            int 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
+                fos.close();\r
+                ret = true;\r
+            } else {\r
+                exhaustResponse(get.getResponseBodyAsStream());\r
+            }\r
+            Log.e(TAG, "Download of " + remoteFilePath + " to " + targetFile + " finished with HTTP status " + status + (!ret?"(FAIL)":""));\r
+        } catch (Exception e) {\r
+            logException(e, "dowloading " + remoteFilePath);\r
+            \r
+        } finally {\r
+            if (!ret && targetFile.exists()) {\r
+                targetFile.delete();\r
+            }\r
+            get.releaseConnection();    // let the connection available for other methods\r
+        }\r
+        return ret;\r
+    }\r

     \r
     \r

-    try {\r
-      mHttpClient.execute(mTargetHost, method, mHttpContext);\r
-      Log.i(TAG, "Creating dir completed");\r
-    } catch (final Exception e) {\r
-      e.printStackTrace();\r
-      return false;\r
-    }\r
-    return true;\r
-  }\r
-  \r
-  private void setupHttpClient() {\r
-    // http scheme\r
-    mSchemeRegistry.register(new Scheme("http", PlainSocketFactory.getSocketFactory(), 80));\r
-    mSchemeRegistry.register(new Scheme("https", SSLSocketFactory.getSocketFactory(), 443));\r
+    /**\r
+     * Deletes a remote file via webdav\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
+        boolean ret = false;\r
+        DavMethod delete = new DeleteMethod(mUri.toString() + WebdavUtils.encodePath(remoteFilePath));\r
+        try {\r
+            int status = executeMethod(delete);\r
+            ret = (status == HttpStatus.SC_OK || status == HttpStatus.SC_ACCEPTED || status == HttpStatus.SC_NO_CONTENT);\r
+            exhaustResponse(delete.getResponseBodyAsStream());\r
+            \r
+            Log.e(TAG, "DELETE of " + remoteFilePath + " finished with HTTP status " + status +  (!ret?"(FAIL)":""));\r
+            \r
+        } catch (Exception e) {\r
+            logException(e, "deleting " + remoteFilePath);\r
+            \r
+        } finally {\r
+            delete.releaseConnection();    // let the connection available for other methods\r
+        }\r
+        return ret;\r
+    }\r
+\r
+    \r
+    public void setDataTransferProgressListener(OnDatatransferProgressListener listener) {\r
+        mDataTransferListener = listener;\r
+    }\r
+    \r
+    /**\r
+     * Creates or update a file in the remote server with the contents of a local file.\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                  Status HTTP code returned by the server.\r
+     * @throws IOException      When a transport error that could not be recovered occurred while uploading the file to the server.\r
+     * @throws HttpException    When a violation of the HTTP protocol occurred. \r
+     */\r
+    public int putFile(String localFile, String remoteTarget, String contentType) throws HttpException, IOException {\r
+        int status = -1;\r
+        PutMethod put = new PutMethod(mUri.toString() + WebdavUtils.encodePath(remoteTarget));\r
+        \r
+        try {\r
+            File f = new File(localFile);\r
+            FileRequestEntity entity = new FileRequestEntity(f, contentType);\r
+            entity.setOnDatatransferProgressListener(mDataTransferListener);\r
+            put.setRequestEntity(entity);\r
+            status = executeMethod(put);\r
+            \r
+            exhaustResponse(put.getResponseBodyAsStream());\r
+            \r
+        } finally {\r
+            put.releaseConnection();    // let the connection available for other methods\r
+        }\r
+        return status;\r
+    }\r
+    \r
+    /**\r
+     * Tries to log in to the current URI, with the current credentials\r
+     * \r
+     * @return A {@link HttpStatus}-Code of the result. SC_OK is good.\r
+     */\r
+    public int tryToLogin() {\r
+        int status = 0;\r
+        HeadMethod head = new HeadMethod(mUri.toString());\r
+        try {\r
+            status = executeMethod(head);\r
+            boolean result = status == HttpStatus.SC_OK;\r
+            Log.d(TAG, "HEAD for " + mUri + " finished with HTTP status " + status + (!result?"(FAIL)":""));\r
+            exhaustResponse(head.getResponseBodyAsStream());\r
+            \r
+        } catch (Exception e) {\r
+            logException(e, "trying to login at " + mUri.toString());\r
+            \r
+        } finally {\r
+            head.releaseConnection();\r
+        }\r
+        return status;\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
+        boolean result = false;\r
+        int status = -1;\r
+        MkColMethod mkcol = new MkColMethod(mUri.toString() + WebdavUtils.encodePath(path));\r
+        try {\r
+            Log.d(TAG, "Creating directory " + path);\r
+            status = executeMethod(mkcol);\r
+            Log.d(TAG, "Status returned: " + status);\r
+            result = mkcol.succeeded();\r
+            \r
+            Log.d(TAG, "MKCOL to " + path + " finished with HTTP status " + status + (!result?"(FAIL)":""));\r
+            exhaustResponse(mkcol.getResponseBodyAsStream());\r
+            \r
+        } catch (Exception e) {\r
+            logException(e, "creating directory " + path);\r
+            \r
+        } finally {\r
+            mkcol.releaseConnection();    // let the connection available for other methods\r
+        }\r
+        return result;\r
+    }\r

     \r
     \r

-    HttpParams params = new BasicHttpParams();\r
-    params.setParameter(ConnManagerPNames.MAX_TOTAL_CONNECTIONS, 30);\r
-    params.setParameter(ConnManagerPNames.MAX_CONNECTIONS_PER_ROUTE, new ConnPerRouteBean(30));\r
-    params.setParameter(HttpProtocolParams.USE_EXPECT_CONTINUE, false);\r
-    HttpProtocolParams.setVersion(params, HttpVersion.HTTP_1_1);\r
-\r
-    mHttpContext = new BasicHttpContext();\r
-    ClientConnectionManager cm = new ThreadSafeClientConnManager(params, mSchemeRegistry);\r
-\r
-    int port = mUri.getPort() == -1 ? \r
-                 mUri.getScheme().equals("https") ? 443 : 80\r
-               : mUri.getPort();\r

     \r
     \r

-    mTargetHost = new HttpHost(mUri.getHost(), port, mUri.getScheme());\r
+    /**\r
+     * Check if a file exists in the OC server\r
+     * \r
+     * @return              'true' if the file exists; 'false' it doesn't exist\r
+     * @throws  Exception   When the existence could not be determined\r
+     */\r
+    public boolean existsFile(String path) throws IOException, HttpException {\r
+        HeadMethod head = new HeadMethod(mUri.toString() + WebdavUtils.encodePath(path));\r
+        try {\r
+            int status = executeMethod(head);\r
+            Log.d(TAG, "HEAD to " + path + " finished with HTTP status " + status + ((status != HttpStatus.SC_OK)?"(FAIL)":""));\r
+            exhaustResponse(head.getResponseBodyAsStream());\r
+            return (status == HttpStatus.SC_OK);\r
+            \r
+        } finally {\r
+            head.releaseConnection();    // let the connection available for other methods\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 and connection timeouts only for the method received.\r
+     * \r
+     * The timeouts are both in milliseconds; 0 means 'infinite'; < 0 means 'do not change the default'\r
+     * \r
+     * @param method            HTTP method request.\r
+     * @param readTimeout       Timeout to set for data reception\r
+     * @param conntionTimout    Timeout to set for connection establishment\r
+     */\r
+    public int executeMethod(HttpMethodBase method, int readTimeout, int connectionTimeout) throws HttpException, IOException {\r
+        int oldSoTimeout = getParams().getSoTimeout();\r
+        int oldConnectionTimeout = getHttpConnectionManager().getParams().getConnectionTimeout();\r
+        try {\r
+            if (readTimeout >= 0) { \r
+                method.getParams().setSoTimeout(readTimeout);   // this should be enough...\r
+                getParams().setSoTimeout(readTimeout);          // ... but this looks like necessary for HTTPS\r
+            }\r
+            if (connectionTimeout >= 0) {\r
+                getHttpConnectionManager().getParams().setConnectionTimeout(connectionTimeout);\r
+            }\r
+            return executeMethod(method);\r
+        } finally {\r
+            getParams().setSoTimeout(oldSoTimeout);\r
+            getHttpConnectionManager().getParams().setConnectionTimeout(oldConnectionTimeout);\r
+        }\r
+    }\r
+\r
+    /**\r
+     * Exhausts a not interesting HTTP response. Encouraged by HttpClient documentation.\r
+     * \r
+     * @param responseBodyAsStream      InputStream with the HTTP response to exhaust.\r
+     */\r
+    public void exhaustResponse(InputStream responseBodyAsStream) {\r
+        if (responseBodyAsStream != null) {\r
+            try {\r
+                while (responseBodyAsStream.read(sExhaustBuffer) >= 0);\r
+                responseBodyAsStream.close();\r
+            \r
+            } catch (IOException io) {\r
+                Log.e(TAG, "Unexpected exception while exhausting not interesting HTTP response; will be IGNORED", io);\r
+            }\r
+        }\r
+    }\r
+\r
+\r
+    /**\r
+     * Logs an exception triggered in a HTTP request. \r
+     * \r
+     * @param e         Caught exception.\r
+     * @param doing     Suffix to add at the end of the logged message.\r
+     */\r
+    private void logException(Exception e, String doing) {\r
+        if (e instanceof HttpException) {\r
+            Log.e(TAG, "HTTP violation while " + doing, e);\r
+\r
+        } else if (e instanceof IOException) {\r
+            Log.e(TAG, "Unrecovered transport exception while " + doing, e);\r
+\r
+        } else {\r
+            Log.e(TAG, "Unexpected exception while " + doing, e);\r
+        }\r
+    }\r
+\r
+    \r
+    /**\r
+     * Sets the connection and wait-for-data timeouts to be applied by default to the methods performed by this client.\r
+     */\r
+    public void setDefaultTimeouts(int defaultDataTimeout, int defaultConnectionTimeout) {\r
+            getParams().setSoTimeout(defaultDataTimeout);\r
+            getHttpConnectionManager().getParams().setConnectionTimeout(defaultConnectionTimeout);\r
+    }\r
+\r
+    /**\r
+     * Sets the base URI for the helper methods that receive paths as parameters, instead of full URLs\r
+     * @param uri\r
+     */\r
+    public void setBaseUri(Uri uri) {\r
+        mUri = uri;\r
+    }\r
+\r
+    public Uri getBaseUri() {\r
+        return mUri;\r
+    }\r

     \r
     \r

-    mHttpClient = new DefaultHttpClient(cm, params);\r
-  }\r

 }\r
 }\r