Merge pull request #152 from owncloud/firewall_error_messages

Firewall error messages

src/com/owncloud/android/lib/common/operations/ErrorMessageParser.java

@@ -0,0 +1,138 @@
+/* ownCloud Android Library is available under MIT license
+ *   Copyright (C) 2017 ownCloud GmbH.
+ *
+ *   Permission is hereby granted, free of charge, to any person obtaining a copy
+ *   of this software and associated documentation files (the "Software"), to deal
+ *   in the Software without restriction, including without limitation the rights
+ *   to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *   copies of the Software, and to permit persons to whom the Software is
+ *   furnished to do so, subject to the following conditions:
+ *
+ *   The above copyright notice and this permission notice shall be included in
+ *   all copies or substantial portions of the Software.
+ *
+ *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ *   NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
+ *   BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
+ *   ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ *   CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ *   THE SOFTWARE.
+ *
+ */
+package com.owncloud.android.lib.common.operations;
+
+import android.util.Xml;
+
+import org.xmlpull.v1.XmlPullParser;
+import org.xmlpull.v1.XmlPullParserException;
+import org.xmlpull.v1.XmlPullParserFactory;
+
+import java.io.IOException;
+import java.io.InputStream;
+
+/**
+ * Parser for server exceptions
+ * @author davidgonzalez
+ */
+public class ErrorMessageParser {
+	// No namespaces
+	private static final String ns = null;
+
+	// Nodes for XML Parser
+	private static final String NODE_ERROR = "d:error";
+	private static final String NODE_MESSAGE = "s:message";
+
+	/**
+	 * Parse exception response
+	 * @param is
+	 * @return errorMessage for an exception
+	 * @throws XmlPullParserException
+	 * @throws IOException
+	 */
+	public String parseXMLResponse(InputStream is) throws XmlPullParserException,
+			IOException {
+		String errorMessage = "";
+
+		try {
+			// XMLPullParser
+			XmlPullParserFactory factory = XmlPullParserFactory.newInstance();
+			factory.setNamespaceAware(true);
+
+			XmlPullParser parser = Xml.newPullParser();
+			parser.setFeature(XmlPullParser.FEATURE_PROCESS_NAMESPACES, false);
+			parser.setInput(is, null);
+			parser.nextTag();
+			errorMessage = readError(parser);
+
+		} finally {
+			is.close();
+		}
+		return errorMessage;
+	}
+
+	/**
+	 * Parse OCS node
+	 * @param parser
+	 * @return reason for exception
+	 * @throws XmlPullParserException
+	 * @throws IOException
+	 */
+	private String readError (XmlPullParser parser) throws XmlPullParserException, IOException {
+		String errorMessage = "";
+		parser.require(XmlPullParser.START_TAG,  ns , NODE_ERROR);
+		while (parser.next() != XmlPullParser.END_TAG) {
+			if (parser.getEventType() != XmlPullParser.START_TAG) {
+				continue;
+			}
+			String name = parser.getName();
+			// read NODE_MESSAGE
+			if (name.equalsIgnoreCase(NODE_MESSAGE)) {
+				errorMessage = readText(parser);
+			} else {
+				skip(parser);
+			}
+		}
+		return errorMessage;
+	}
+
+	/**
+	 * Skip tags in parser procedure
+	 * @param parser
+	 * @throws XmlPullParserException
+	 * @throws IOException
+	 */
+	private void skip(XmlPullParser parser) throws XmlPullParserException, IOException {
+		if (parser.getEventType() != XmlPullParser.START_TAG) {
+			throw new IllegalStateException();
+		}
+		int depth = 1;
+		while (depth != 0) {
+			switch (parser.next()) {
+				case XmlPullParser.END_TAG:
+					depth--;
+					break;
+				case XmlPullParser.START_TAG:
+					depth++;
+					break;
+			}
+		}
+	}
+
+	/**
+	 * Read the text from a node
+	 * @param parser
+	 * @return Text of the node
+	 * @throws IOException
+	 * @throws XmlPullParserException
+	 */
+	private String readText(XmlPullParser parser) throws IOException, XmlPullParserException {
+		String result = "";
+		if (parser.next() == XmlPullParser.TEXT) {
+			result = parser.getText();
+			parser.nextTag();
+		}
+		return result;
+	}
+}

src/com/owncloud/android/lib/common/operations/InvalidCharacterExceptionParser.java

@@ -101,8 +101,6 @@ public class InvalidCharacterExceptionParser {
 		}
 		return exception.equalsIgnoreCase(EXCEPTION_STRING) ||
 				exception.equalsIgnoreCase(EXCEPTION_UPLOAD_STRING);
-
-
 	}
 
 	/**

src/com/owncloud/android/lib/common/operations/RemoteOperationResult.java

@@ -1,22 +1,22 @@
 /* ownCloud Android Library is available under MIT license
  *   Copyright (C) 2016 ownCloud GmbH.
- *   
+ *
  *   Permission is hereby granted, free of charge, to any person obtaining a copy
  *   of this software and associated documentation files (the "Software"), to deal
  *   in the Software without restriction, including without limitation the rights
  *   to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  *   copies of the Software, and to permit persons to whom the Software is
  *   furnished to do so, subject to the following conditions:
- *   
+ *
  *   The above copyright notice and this permission notice shall be included in
  *   all copies or substantial portions of the Software.
- *   
+ *
- *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 
+ *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
- *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 
+ *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
- *   NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS 
+ *   NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
- *   BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN 
+ *   BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
- *   ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 
+ *   ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  *   CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  *   THE SOFTWARE.
  *
@@ -63,7 +63,9 @@ import javax.net.ssl.SSLException;
  */
 public class RemoteOperationResult implements Serializable {
 
-    /** Generated - should be refreshed every time the class changes!! */
+    /**
+     * Generated - should be refreshed every time the class changes!!
+     */
     private static final long serialVersionUID = 4968939884332372230L;
 
     private static final String TAG = RemoteOperationResult.class.getSimpleName();
@@ -105,6 +107,7 @@ public class RemoteOperationResult implements Serializable {
         LOCAL_STORAGE_NOT_REMOVED,
         FORBIDDEN,
         SHARE_FORBIDDEN,
+        SPECIFIC_FORBIDDEN,
         OK_REDIRECT_TO_NON_SECURE_CONNECTION,
         INVALID_MOVE_INTO_DESCENDANT,
         INVALID_COPY_INTO_DESCENDANT,
@@ -131,10 +134,10 @@ public class RemoteOperationResult implements Serializable {
 
     /**
      * Public constructor from result code.
-     *
+     * <p>
      * To be used when the caller takes the responsibility of interpreting the result of a {@link RemoteOperation}
      *
-     * @param code      {@link ResultCode} decided by the caller.
+     * @param code {@link ResultCode} decided by the caller.
      */
     public RemoteOperationResult(ResultCode code) {
         mCode = code;
@@ -146,12 +149,12 @@ public class RemoteOperationResult implements Serializable {
 
     /**
      * Public constructor from exception.
-     *
+     * <p>
      * To be used when an exception prevented the end of the {@link RemoteOperation}.
-     *
+     * <p>
      * Determines a {@link ResultCode} depending on the type of the exception.
      *
-     * @param e     Exception that interrupted the {@link RemoteOperation}
+     * @param e Exception that interrupted the {@link RemoteOperation}
      */
     public RemoteOperationResult(Exception e) {
         mException = e;
@@ -205,28 +208,28 @@ public class RemoteOperationResult implements Serializable {
 
     /**
      * Public constructor from separate elements of an HTTP or DAV response.
-     *
+     * <p>
      * To be used when the result needs to be interpreted from the response of an HTTP/DAV method.
-     *
+     * <p>
      * Determines a {@link ResultCode} from the already executed method received as a parameter. Generally,
      * will depend on the HTTP code and HTTP response headers received. In some cases will inspect also the
      * response body.
      *
-     * @param success       The operation was considered successful or not.
+     * @param success    The operation was considered successful or not.
-     * @param httpMethod    HTTP/DAV method already executed which response will be examined to interpret the
+     * @param httpMethod HTTP/DAV method already executed which response will be examined to interpret the
-     *                      result.
+     *                   result.
      */
     public RemoteOperationResult(boolean success, HttpMethod httpMethod) throws IOException {
         this(
-            success,
+                success,
-            httpMethod.getStatusCode(),
+                httpMethod.getStatusCode(),
-            httpMethod.getStatusText(),
+                httpMethod.getStatusText(),
-            httpMethod.getResponseHeaders()
+                httpMethod.getResponseHeaders()
         );
 
         if (mHttpCode == HttpStatus.SC_BAD_REQUEST) {   // 400
             String bodyResponse = httpMethod.getResponseBodyAsString();
-                // do not get for other HTTP codes!; could not be available
+            // do not get for other HTTP codes!; could not be available
 
             if (bodyResponse != null && bodyResponse.length() > 0) {
                 InputStream is = new ByteArrayInputStream(bodyResponse.getBytes());
@@ -242,23 +245,42 @@ public class RemoteOperationResult implements Serializable {
                 }
             }
         }
+
+        if (mHttpCode == HttpStatus.SC_FORBIDDEN) {
+            String bodyResponse = httpMethod.getResponseBodyAsString();
+
+            if (bodyResponse != null && bodyResponse.length() > 0) {
+                InputStream is = new ByteArrayInputStream(bodyResponse.getBytes());
+                ErrorMessageParser xmlParser = new ErrorMessageParser();
+                try {
+                    String errorMessage = xmlParser.parseXMLResponse(is);
+                    if (errorMessage != null && errorMessage != "") {
+                        mCode = ResultCode.SPECIFIC_FORBIDDEN;
+                        mHttpPhrase = errorMessage;
+                    }
+                } catch (Exception e) {
+                    Log_OC.w(TAG, "Error reading exception from server: " + e.getMessage());
+                    // mCode stays as set in this(success, httpCode, headers)
+                }
+            }
+        }
     }
 
     /**
      * Public constructor from separate elements of an HTTP or DAV response.
-     *
+     * <p>
      * To be used when the result needs to be interpreted from HTTP response elements that could come from
      * different requests (WARNING: black magic, try to avoid).
-     *
+     * <p>
      * If all the fields come from the same HTTP/DAV response, {@link #RemoteOperationResult(boolean, HttpMethod)}
      * should be used instead.
-     *
+     * <p>
      * Determines a {@link ResultCode} depending on the HTTP code and HTTP response headers received.
      *
-     * @param success       The operation was considered successful or not.
+     * @param success     The operation was considered successful or not.
-     * @param httpCode      HTTP status code returned by an HTTP/DAV method.
+     * @param httpCode    HTTP status code returned by an HTTP/DAV method.
-     * @param httpPhrase    HTTP status line phrase returned by an HTTP/DAV method
+     * @param httpPhrase  HTTP status line phrase returned by an HTTP/DAV method
-     * @param httpHeaders   HTTP response header returned by an HTTP/DAV method
+     * @param httpHeaders HTTP response header returned by an HTTP/DAV method
      */
     public RemoteOperationResult(boolean success, int httpCode, String httpPhrase, Header[] httpHeaders) {
         this(success, httpCode, httpPhrase);
@@ -283,12 +305,12 @@ public class RemoteOperationResult implements Serializable {
 
     /**
      * Private constructor for results built interpreting a HTTP or DAV response.
-     *
+     * <p>
      * Determines a {@link ResultCode} depending of the type of the exception.
      *
-     * @param success       Operation was successful or not.
+     * @param success    Operation was successful or not.
-     * @param httpCode      HTTP status code returned by the HTTP/DAV method.
+     * @param httpCode   HTTP status code returned by the HTTP/DAV method.
-     * @param httpPhrase    HTTP status line phrase returned by the HTTP/DAV method
+     * @param httpPhrase HTTP status line phrase returned by the HTTP/DAV method
      */
     private RemoteOperationResult(boolean success, int httpCode, String httpPhrase) {
         mSuccess = success;
@@ -324,8 +346,8 @@ public class RemoteOperationResult implements Serializable {
                 default:
                     mCode = ResultCode.UNHANDLED_HTTP_CODE;         // UNKNOWN ERROR
                     Log_OC.d(TAG,
-                        "RemoteOperationResult has processed UNHANDLED_HTTP_CODE: " +
+                            "RemoteOperationResult has processed UNHANDLED_HTTP_CODE: " +
-                        mHttpCode + " " + mHttpPhrase
+                                    mHttpCode + " " + mHttpPhrase
                     );
             }
         }

src/com/owncloud/android/lib/resources/files/DownloadRemoteFileOperation.java

@@ -57,6 +57,7 @@ import com.owncloud.android.lib.common.utils.Log_OC;
 public class DownloadRemoteFileOperation extends RemoteOperation {
 
     private static final String TAG = DownloadRemoteFileOperation.class.getSimpleName();
+    private static final int FORBIDDEN_ERROR = 403;
 
     private Set<OnDatatransferProgressListener> mDataTransferListeners = new HashSet<OnDatatransferProgressListener>();
     private final AtomicBoolean mCancellationRequested = new AtomicBoolean(false);
@@ -82,8 +83,7 @@ public class DownloadRemoteFileOperation extends RemoteOperation {
         /// perform the download
         try {
             tmpFile.getParentFile().mkdirs();
-            int status = downloadFile(client, tmpFile);
+            result = downloadFile(client, tmpFile);
-            result = new RemoteOperationResult(isSuccess(status), mGet);
             Log_OC.i(TAG, "Download of " + mRemotePath + " to " + getTmpPath() + ": " +
                 result.getLogMessage());
 
@@ -97,8 +97,10 @@ public class DownloadRemoteFileOperation extends RemoteOperation {
     }
 
 
-    protected int downloadFile(OwnCloudClient client, File targetFile) throws HttpException,
+    private RemoteOperationResult downloadFile(OwnCloudClient client, File targetFile) throws
         IOException, OperationCancelledException {
+
+        RemoteOperationResult result;
         int status = -1;
         boolean savedFile = false;
         mGet = new GetMethod(client.getWebdavUri() + WebdavUtils.encodePath(mRemotePath));
@@ -160,9 +162,12 @@ public class DownloadRemoteFileOperation extends RemoteOperation {
                     // TODO some kind of error control!
                 }
 
-            } else {
+            } else if (status != FORBIDDEN_ERROR){
                 client.exhaustResponse(mGet.getResponseBodyAsStream());
-            }
+
+            } // else, body read by RemoteOeprationResult constructor
+
+            result = new RemoteOperationResult(isSuccess(status), mGet);
 
         } finally {
             if (fos != null) fos.close();
@@ -171,7 +176,7 @@ public class DownloadRemoteFileOperation extends RemoteOperation {
             }
             mGet.releaseConnection();    // let the connection available for other methods
         }
-        return status;
+        return result;
     }
 
     private boolean isSuccess(int status) {