Merge pull request #152 from owncloud/oauth_login
[pub/Android/ownCloud.git] / src / eu / alefzero / webdav / WebdavClient.java
index 4d97ceb..fdabebe 100644 (file)
-/* ownCloud Android client application\r
- *   Copyright (C) 2011  Bartek Przybylski\r
- *\r
- *   This program is free software: you can redistribute it and/or modify\r
- *   it under the terms of the GNU General Public License as published by\r
- *   the Free Software Foundation, either version 3 of the License, or\r
- *   (at your option) any later version.\r
- *\r
- *   This program is distributed in the hope that it will be useful,\r
- *   but WITHOUT ANY WARRANTY; without even the implied warranty of\r
- *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
- *   GNU General Public License for more details.\r
- *\r
- *   You should have received a copy of the GNU General Public License\r
- *   along with this program.  If not, see <http://www.gnu.org/licenses/>.\r
- *\r
- */\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.InputStreamReader;\r
-import java.io.OutputStreamWriter;\r
-\r
-import org.apache.http.HttpHost;\r
-import org.apache.http.HttpResponse;\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
-\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
-    \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
+/* ownCloud Android client application
+ *   Copyright (C) 2011  Bartek Przybylski
+ *   Copyright (C) 2012-2013 ownCloud Inc.
+ *
+ *   This program is free software: you can redistribute it and/or modify
+ *   it under the terms of the GNU General Public License version 2,
+ *   as published by the Free Software Foundation.
+ *
+ *   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 eu.alefzero.webdav;
+
+import java.io.BufferedInputStream;
+import java.io.File;
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.ArrayList;
+import java.util.List;
+
+import org.apache.commons.httpclient.Credentials;
+import org.apache.commons.httpclient.HostConfiguration;
+import org.apache.commons.httpclient.HttpClient;
+import org.apache.commons.httpclient.HttpConnectionManager;
+import org.apache.commons.httpclient.HttpException;
+import org.apache.commons.httpclient.HttpMethod;
+import org.apache.commons.httpclient.HttpMethodBase;
+import org.apache.commons.httpclient.HttpState;
+import org.apache.commons.httpclient.HttpVersion;
+import org.apache.commons.httpclient.UsernamePasswordCredentials;
+import org.apache.commons.httpclient.auth.AuthPolicy;
+import org.apache.commons.httpclient.auth.AuthScope;
+import org.apache.commons.httpclient.methods.GetMethod;
+import org.apache.commons.httpclient.methods.HeadMethod;
+import org.apache.commons.httpclient.methods.PutMethod;
+import org.apache.commons.httpclient.params.HttpMethodParams;
+import org.apache.http.HttpStatus;
+import org.apache.http.params.CoreProtocolPNames;
+import org.apache.jackrabbit.webdav.client.methods.DavMethod;
+import org.apache.jackrabbit.webdav.client.methods.DeleteMethod;
+
+import com.owncloud.android.Log_OC;
+
+import com.owncloud.android.network.BearerAuthScheme;
+import com.owncloud.android.network.BearerCredentials;
+
+import android.net.Uri;
+
+public class WebdavClient extends HttpClient {
+    private Uri mUri;
+    private Credentials mCredentials;
+    final private static String TAG = "WebdavClient";
+    private static final String USER_AGENT = "Android-ownCloud";
+    
+    private OnDatatransferProgressListener mDataTransferListener;
+    static private byte[] sExhaustBuffer = new byte[1024];
+    
+    /**
+     * Constructor
+     */
+    public WebdavClient(HttpConnectionManager connectionMgr) {
+        super(connectionMgr);
+        Log_OC.d(TAG, "Creating WebdavClient");
+        getParams().setParameter(HttpMethodParams.USER_AGENT, USER_AGENT);
+        getParams().setParameter(CoreProtocolPNames.PROTOCOL_VERSION, HttpVersion.HTTP_1_1);
+    }
+
+    public void setBearerCredentials(String accessToken) {
+        AuthPolicy.registerAuthScheme(BearerAuthScheme.AUTH_POLICY, BearerAuthScheme.class);
+        
+        List<String> authPrefs = new ArrayList<String>(1);
+        authPrefs.add(BearerAuthScheme.AUTH_POLICY);
+        getParams().setParameter(AuthPolicy.AUTH_SCHEME_PRIORITY, authPrefs);        
+        
+        mCredentials = new BearerCredentials(accessToken);
+        getState().setCredentials(AuthScope.ANY, mCredentials);
+    }
+
+    public void setBasicCredentials(String username, String password) {
+        List<String> authPrefs = new ArrayList<String>(1);
+        authPrefs.add(AuthPolicy.BASIC);
+        getParams().setParameter(AuthPolicy.AUTH_SCHEME_PRIORITY, authPrefs);        
+        
+        getParams().setAuthenticationPreemptive(true);
+        mCredentials = new UsernamePasswordCredentials(username, password);
+        getState().setCredentials(AuthScope.ANY, mCredentials);
+    }
+    
+    /**
+     * Check if a file exists in the OC server
+     * 
+     * TODO replace with ExistenceOperation
+     * 
+     * @return              'true' if the file exists; 'false' it doesn't exist
+     * @throws  Exception   When the existence could not be determined
+     */
+    public boolean existsFile(String path) throws IOException, HttpException {
+        HeadMethod head = new HeadMethod(mUri.toString() + WebdavUtils.encodePath(path));
+        try {
+            int status = executeMethod(head);
+            Log_OC.d(TAG, "HEAD to " + path + " finished with HTTP status " + status + ((status != HttpStatus.SC_OK)?"(FAIL)":""));
+            exhaustResponse(head.getResponseBodyAsStream());
+            return (status == HttpStatus.SC_OK);
+            
+        } finally {
+            head.releaseConnection();    // let the connection available for other methods
+        }
+    }
+    
+    /**
+     * Requests the received method with the received timeout (milliseconds).
+     * 
+     * Executes the method through the inherited HttpClient.executedMethod(method).
+     * 
+     * Sets the socket and connection timeouts only for the method received.
+     * 
+     * The timeouts are both in milliseconds; 0 means 'infinite'; < 0 means 'do not change the default'
+     * 
+     * @param method            HTTP method request.
+     * @param readTimeout       Timeout to set for data reception
+     * @param conntionTimout    Timeout to set for connection establishment
+     */
+    public int executeMethod(HttpMethodBase method, int readTimeout, int connectionTimeout) throws HttpException, IOException {
+        int oldSoTimeout = getParams().getSoTimeout();
+        int oldConnectionTimeout = getHttpConnectionManager().getParams().getConnectionTimeout();
+        try {
+            if (readTimeout >= 0) { 
+                method.getParams().setSoTimeout(readTimeout);   // this should be enough...
+                getParams().setSoTimeout(readTimeout);          // ... but this looks like necessary for HTTPS
+            }
+            if (connectionTimeout >= 0) {
+                getHttpConnectionManager().getParams().setConnectionTimeout(connectionTimeout);
+            }
+            return executeMethod(method);
+        } finally {
+            getParams().setSoTimeout(oldSoTimeout);
+            getHttpConnectionManager().getParams().setConnectionTimeout(oldConnectionTimeout);
+        }
+    }
+
+    /**
+     * Exhausts a not interesting HTTP response. Encouraged by HttpClient documentation.
+     * 
+     * @param responseBodyAsStream      InputStream with the HTTP response to exhaust.
+     */
+    public void exhaustResponse(InputStream responseBodyAsStream) {
+        if (responseBodyAsStream != null) {
+            try {
+                while (responseBodyAsStream.read(sExhaustBuffer) >= 0);
+                responseBodyAsStream.close();
+            
+            } catch (IOException io) {
+                Log_OC.e(TAG, "Unexpected exception while exhausting not interesting HTTP response; will be IGNORED", io);
+            }
+        }
+    }
+
+    /**
+     * Sets the connection and wait-for-data timeouts to be applied by default to the methods performed by this client.
+     */
+    public void setDefaultTimeouts(int defaultDataTimeout, int defaultConnectionTimeout) {
+            getParams().setSoTimeout(defaultDataTimeout);
+            getHttpConnectionManager().getParams().setConnectionTimeout(defaultConnectionTimeout);
+    }
+
+    /**
+     * Sets the base URI for the helper methods that receive paths as parameters, instead of full URLs
+     * @param uri
+     */
+    public void setBaseUri(Uri uri) {
+        mUri = uri;
+    }
+
+    public Uri getBaseUri() {
+        return mUri;
+    }
+
+    public final Credentials getCredentials() {\r
+        return mCredentials;\r
     }\r
-    return true;\r
-  }\r
-  \r
-  void getFileList(String dirPath) {\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
-    \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
-    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
-    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
-    mTargetHost = new HttpHost(mUri.getHost(), port, mUri.getScheme());\r
-    \r
-    mHttpClient = new DefaultHttpClient(cm, params);\r
-  }\r
-}\r
+}