From dfc984f715b443efca23615ae0dd763037bddc0f Mon Sep 17 00:00:00 2001
From: rsudev <rasch@munin-soft.de>
Date: Fri, 4 Oct 2013 08:31:29 +0200
Subject: Implements part of #3267, Detect and report time-skew that prevents
 okapi access

Reports back issues on the main screen, but not yet during the authorization process
---
 .../cgeo/geocaching/connector/oc/OkapiError.java   | 87 ++++++++++++++++++++++
 1 file changed, 87 insertions(+)
 create mode 100644 main/src/cgeo/geocaching/connector/oc/OkapiError.java

(limited to 'main/src/cgeo/geocaching/connector/oc/OkapiError.java')

diff --git a/main/src/cgeo/geocaching/connector/oc/OkapiError.java b/main/src/cgeo/geocaching/connector/oc/OkapiError.java
new file mode 100644
index 0000000..7faf2c7
--- /dev/null
+++ b/main/src/cgeo/geocaching/connector/oc/OkapiError.java
@@ -0,0 +1,87 @@
+package cgeo.geocaching.connector.oc;
+
+import cgeo.geocaching.utils.Log;
+
+import org.apache.commons.lang3.StringUtils;
+import org.eclipse.jdt.annotation.NonNull;
+import org.eclipse.jdt.annotation.Nullable;
+import org.json.JSONException;
+import org.json.JSONObject;
+
+/**
+ * Handles the JSON error response from OKAPI
+ */
+public class OkapiError {
+
+    /**
+     * List of detected errors OKAPI might return
+     */
+    public enum OkapiErrors {
+        NO_ERROR,
+        UNSPECIFIED,
+        INVALID_TIMESTAMP,
+        INVALID_TOKEN;
+    }
+
+    @NonNull private final OkapiErrors state;
+    @NonNull private final String message;
+
+    public OkapiError(@Nullable JSONObject data) {
+
+        // A null-response is by definition an error (some exception occurred somewhere in the flow)
+        if (data == null) {
+            state = OkapiErrors.UNSPECIFIED;
+            message = StringUtils.EMPTY;
+            return;
+        }
+        // Second possibility: we get an error object as return (@see http://opencaching.pl/okapi/introduction.html#errors)
+        if (data.has("error")) {
+            String localmessage = null;
+            OkapiErrors localstate = OkapiErrors.UNSPECIFIED;
+            try {
+                JSONObject error = data.getJSONObject("error");
+                // Check reason_stack element to look for the specific oauth problems we want to report back
+                if (error.has("reason_stack")) {
+                    String reason = error.getString("reason_stack");
+                    if (StringUtils.contains(reason, "invalid_oauth_request")) {
+                        if (StringUtils.contains(reason, "invalid_timestamp")) {
+                            localstate = OkapiErrors.INVALID_TIMESTAMP;
+                        } else if (StringUtils.contains(reason, "invalid_token")) {
+                            localstate = OkapiErrors.INVALID_TOKEN;
+                        }
+                    }
+                }
+                // Check if we can extract a message as well
+                if (error.has("developer_message")) {
+                    localmessage = error.getString("developer_message");
+                    assert localmessage != null; // by virtue of defaultString
+                }
+            } catch (JSONException ex) {
+                Log.d("OkapiError: Failed to parse JSON", ex);
+                localstate = OkapiErrors.UNSPECIFIED;
+            }
+            state = localstate;
+            message = StringUtils.defaultString(localmessage);
+            return;
+        }
+
+        // Third possibility: some other response, everything is fine!
+        state = OkapiErrors.NO_ERROR;
+        message = StringUtils.EMPTY;
+    }
+
+    public boolean isError() {
+        return state != OkapiErrors.NO_ERROR;
+    }
+
+    @NonNull
+    public OkapiErrors getResult() {
+        return state;
+    }
+
+    @NonNull
+    public String getMessage() {
+        return message;
+    }
+
+}
-- 
cgit v1.1