-/* 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
+/* 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 as published by
+ * the Free Software Foundation, either version 2 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 eu.alefzero.webdav;
import java.io.BufferedInputStream;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
-import java.net.URLDecoder;\r
-import java.net.URLEncoder;\r
-
-import org.apache.commons.httpclient.Credentials;\r
-import org.apache.commons.httpclient.HttpClient;\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.commons.httpclient.protocol.Protocol;
-import org.apache.http.HttpStatus;\r
-import org.apache.jackrabbit.webdav.client.methods.MkColMethod;\r
-
-import eu.alefzero.owncloud.authenticator.EasySSLSocketFactory;
-
-import android.net.Uri;\r
+import java.io.InputStream;
+
+import org.apache.commons.httpclient.Credentials;
+import org.apache.commons.httpclient.HttpClient;
+import org.apache.commons.httpclient.HttpConnectionManager;
+import org.apache.commons.httpclient.HttpException;
+import org.apache.commons.httpclient.HttpMethodBase;
+import org.apache.commons.httpclient.HttpVersion;
+import org.apache.commons.httpclient.UsernamePasswordCredentials;
+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 org.apache.jackrabbit.webdav.client.methods.MkColMethod;
+
+import com.owncloud.android.Log_OC;
+
+import android.net.Uri;
import android.util.Log;
public class WebdavClient extends HttpClient {
- private Uri mUri;\r
- private Credentials mCredentials;
- final private static String TAG = "WebdavClient";\r
- private static final String USER_AGENT = "Android-ownCloud";
-
- public WebdavClient(Uri uri) {
- mUri = uri;\r
- getParams().setParameter(HttpMethodParams.USER_AGENT, USER_AGENT);
- }
-
- public void setCredentials(String username, String password) {\r
- getParams().setAuthenticationPreemptive(true);
- getState().setCredentials(AuthScope.ANY, getCredentials(username, password));
- }
-
- private Credentials getCredentials(String username, String password) {\r
- if (mCredentials == null)\r
- mCredentials = new UsernamePasswordCredentials(username, password); \r
- return mCredentials;\r
- }\r
-\r
- public void allowUnsignedCertificates() {
- // https\r
- Protocol.registerProtocol("https", new Protocol("https", new EasySSLSocketFactory(), 443));
- }
-
- public boolean downloadFile(String filepath, File targetPath) {
- //HttpGet get = new HttpGet(mUri.toString() + filepath.replace(" ", "%20"));\r
- \r
- Log.e("ASD", mUri.toString() + URLDecoder.decode(filepath) + "");\r
- GetMethod get = new GetMethod(mUri.toString() + URLEncoder.encode(filepath));\r
+ 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 setCredentials(String username, String password) {
+ getParams().setAuthenticationPreemptive(true);
+ getState().setCredentials(AuthScope.ANY,
+ getCredentials(username, password));
+ }
+
+ private Credentials getCredentials(String username, String password) {
+ if (mCredentials == null)
+ mCredentials = new UsernamePasswordCredentials(username, password);
+ return mCredentials;
+ }
+
+ /**
+ * Downloads a file in remoteFilepath to the local targetPath.
+ *
+ * @param remoteFilepath Path to the file in the remote server, URL DECODED.
+ * @param targetFile Local path to save the downloaded file.
+ * @return 'True' when the file is successfully downloaded.
+ */
+ public boolean downloadFile(String remoteFilePath, File targetFile) {
+ boolean ret = false;
+ GetMethod get = new GetMethod(mUri.toString() + WebdavUtils.encodePath(remoteFilePath));
+
+ try {
+ int status = executeMethod(get);
+ if (status == HttpStatus.SC_OK) {
+ targetFile.createNewFile();
+ BufferedInputStream bis = new BufferedInputStream(
+ get.getResponseBodyAsStream());
+ FileOutputStream fos = new FileOutputStream(targetFile);
+
+ byte[] bytes = new byte[4096];
+ int readResult;
+ while ((readResult = bis.read(bytes)) != -1) {
+ if (mDataTransferListener != null)
+ mDataTransferListener.onTransferProgress(readResult);
+ fos.write(bytes, 0, readResult);
+ }
+ fos.close();
+ ret = true;
+ } else {
+ exhaustResponse(get.getResponseBodyAsStream());
+ }
+ Log_OC.e(TAG, "Download of " + remoteFilePath + " to " + targetFile + " finished with HTTP status " + status + (!ret?"(FAIL)":""));
+
+ } catch (Exception e) {
+ logException(e, "dowloading " + remoteFilePath);
+
+ } finally {
+ if (!ret && targetFile.exists()) {
+ targetFile.delete();
+ }
+ get.releaseConnection(); // let the connection available for other methods
+ }
+ return ret;
+ }
+
+ /**
+ * Deletes a remote file via webdav
+ * @param remoteFilePath Remote file path of the file to delete, in URL DECODED format.
+ * @return
+ */
+ public boolean deleteFile(String remoteFilePath) {
+ boolean ret = false;
+ DavMethod delete = new DeleteMethod(mUri.toString() + WebdavUtils.encodePath(remoteFilePath));
+ try {
+ int status = executeMethod(delete);
+ ret = (status == HttpStatus.SC_OK || status == HttpStatus.SC_ACCEPTED || status == HttpStatus.SC_NO_CONTENT);
+ exhaustResponse(delete.getResponseBodyAsStream());
+
+ Log_OC.e(TAG, "DELETE of " + remoteFilePath + " finished with HTTP status " + status + (!ret?"(FAIL)":""));
+
+ } catch (Exception e) {
+ logException(e, "deleting " + remoteFilePath);
+
+ } finally {
+ delete.releaseConnection(); // let the connection available for other methods
+ }
+ return ret;
+ }
+
+
+ public void setDataTransferProgressListener(OnDatatransferProgressListener listener) {
+ mDataTransferListener = listener;
+ }
+
+ /**
+ * Creates or update a file in the remote server with the contents of a local file.
+ *
+ * @param localFile Path to the local file to upload.
+ * @param remoteTarget Remote path to the file to create or update, URL DECODED
+ * @param contentType MIME type of the file.
+ * @return Status HTTP code returned by the server.
+ * @throws IOException When a transport error that could not be recovered occurred while uploading the file to the server.
+ * @throws HttpException When a violation of the HTTP protocol occurred.
+ */
+ public int putFile(String localFile, String remoteTarget, String contentType) throws HttpException, IOException {
+ int status = -1;
+ PutMethod put = new PutMethod(mUri.toString() + WebdavUtils.encodePath(remoteTarget));
+
+ try {
+ File f = new File(localFile);
+ FileRequestEntity entity = new FileRequestEntity(f, contentType);
+ entity.addDatatransferProgressListener(mDataTransferListener);
+ put.setRequestEntity(entity);
+ status = executeMethod(put);
+
+ exhaustResponse(put.getResponseBodyAsStream());
+
+ } finally {
+ put.releaseConnection(); // let the connection available for other methods
+ }
+ return status;
+ }
+
+ /**
+ * Tries to log in to the current URI, with the current credentials
+ *
+ * @return A {@link HttpStatus}-Code of the result. SC_OK is good.
+ */
+ public int tryToLogin() {
+ int status = 0;
+ HeadMethod head = new HeadMethod(mUri.toString());
+ try {
+ status = executeMethod(head);
+ boolean result = status == HttpStatus.SC_OK;
+ Log_OC.d(TAG, "HEAD for " + mUri + " finished with HTTP status " + status + (!result?"(FAIL)":""));
+ exhaustResponse(head.getResponseBodyAsStream());
+
+ } catch (Exception e) {
+ logException(e, "trying to login at " + mUri.toString());
+
+ } finally {
+ head.releaseConnection();
+ }
+ return status;
+ }
+
+ /**
+ * Creates a remote directory with the received path.
+ *
+ * @param path Path of the directory to create, URL DECODED
+ * @return 'True' when the directory is successfully created
+ */
+ public boolean createDirectory(String path) {
+ boolean result = false;
+ int status = -1;
+ MkColMethod mkcol = new MkColMethod(mUri.toString() + WebdavUtils.encodePath(path));
+ try {
+ Log_OC.d(TAG, "Creating directory " + path);
+ status = executeMethod(mkcol);
+ Log_OC.d(TAG, "Status returned: " + status);
+ result = mkcol.succeeded();
+
+ Log_OC.d(TAG, "MKCOL to " + path + " finished with HTTP status " + status + (!result?"(FAIL)":""));
+ exhaustResponse(mkcol.getResponseBodyAsStream());
+
+ } catch (Exception e) {
+ logException(e, "creating directory " + path);
+
+ } finally {
+ mkcol.releaseConnection(); // let the connection available for other methods
+ }
+ return result;
+ }
-// get.setHeader("Host", mUri.getHost());
-// get.setHeader("User-Agent", "Android-ownCloud");
- try {\r
- Log.e("ASD", get.toString());
- int status = executeMethod(get);
- if (status != HttpStatus.SC_OK) {
- return false;
- }
- BufferedInputStream bis = new BufferedInputStream(get.getResponseBodyAsStream());
- FileOutputStream fos = new FileOutputStream(targetPath);
-
- byte[] bytes = new byte[512];
- int readResult;
- while ((readResult = bis.read(bytes)) != -1) fos.write(bytes, 0, readResult);
-
- } catch (IOException e) {
- e.printStackTrace();
- return false;
- }
- return true;
- }
-
- public boolean putFile(String localFile,
- String remoteTarget,
- String contentType) {
- boolean result = true;
-
- try {
- FileRequestEntity entity = new FileRequestEntity(new File(localFile), contentType);\r
- PutMethod put = new PutMethod(mUri.toString() + remoteTarget.substring(1));\r
- put.setRequestEntity(entity);\r
- int status = executeMethod(put);\r
- Log.d(TAG, "PUT method return with status "+status);
-
- Log.i(TAG, "Uploading, done");
- } catch (final Exception e) {
- Log.i(TAG, ""+e.getMessage());
- result = false;
+ /**
+ * Check if a file exists in the OC server
+ *
+ * @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);
+ }
+ }
+ }
+
+ /**
+ * Logs an exception triggered in a HTTP request.
+ *
+ * @param e Caught exception.
+ * @param doing Suffix to add at the end of the logged message.
+ */
+ private void logException(Exception e, String doing) {
+ if (e instanceof HttpException) {
+ Log_OC.e(TAG, "HTTP violation while " + doing, e);
+
+ } else if (e instanceof IOException) {
+ Log_OC.e(TAG, "Unrecovered transport exception while " + doing, e);
+
+ } else {
+ Log_OC.e(TAG, "Unexpected exception while " + doing, e);
+ }
}
+
- return result;
- }
- \r
- public int tryToLogin() {\r
- int r = 0; \r
- HeadMethod head = new HeadMethod(mUri.toString());\r
- try {\r
- r = executeMethod(head);\r
- } catch (Exception e) {\r
- Log.e(TAG, "Error: " + e.getMessage());\r
- }\r
- return r;\r
- }\r
-
- public boolean createDirectory(String path) {
- try {\r
- MkColMethod mkcol = new MkColMethod(mUri.toString() + "/" + path + "/");
- int status = executeMethod(mkcol);\r
- Log.d(TAG, "Status returned " + status);\r
- Log.d(TAG, "uri: " + mkcol.getURI().toString());
- Log.i(TAG, "Creating dir completed");
- } catch (final Exception e) {
- e.printStackTrace();
- return false;
- }
- return true;
- }
+ /**
+ * 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;
+ }
+
}
projects / pub / Android / ownCloud.git / blobdiff