Merge pull request #12 from wordpress-mobile/issue/9-http-auth-support2

aforcier · aforcier · commit 7946f32d9e47 · 2016-03-13T20:48:36.000-04:00
Fix #9: add http auth to XMLRPC requests
diff --git a/WordPressStores/build.gradle b/WordPressStores/build.gradle
@@ -15,7 +15,6 @@ apply plugin: 'com.neenbedankt.android-apt'
 
 repositories {
     jcenter()
-
 }
 
 android {
diff --git a/WordPressStores/src/main/java/org/wordpress/android/stores/module/ReleaseNetworkModule.java b/WordPressStores/src/main/java/org/wordpress/android/stores/module/ReleaseNetworkModule.java
@@ -8,6 +8,7 @@
 import com.squareup.okhttp.OkUrlFactory;
 
 import org.wordpress.android.stores.Dispatcher;
+import org.wordpress.android.stores.network.HTTPAuthManager;
 import org.wordpress.android.stores.network.OkHttpStack;
 import org.wordpress.android.stores.network.UserAgent;
 import org.wordpress.android.stores.network.rest.wpcom.account.AccountRestClient;
@@ -65,8 +66,8 @@ public SiteRestClient provideSiteRestClient(Dispatcher dispatcher, RequestQueue
     @Singleton
     @Provides
     public SiteXMLRPCClient provideSiteXMLRPCClient(Dispatcher dispatcher, RequestQueue requestQueue, AccessToken token,
-                                                    UserAgent userAgent) {
-        return new SiteXMLRPCClient(dispatcher, requestQueue, token, userAgent);
+                                                    UserAgent userAgent, HTTPAuthManager httpAuthManager) {
+        return new SiteXMLRPCClient(dispatcher, requestQueue, token, userAgent, httpAuthManager);
     }
 
     @Singleton
@@ -81,4 +82,10 @@ public AccountRestClient provideAccountRestClient(Dispatcher dispatcher, Request
     public AccessToken provideAccountToken(Context appContext) {
         return new AccessToken(appContext);
     }
+
+    @Singleton
+    @Provides
+    public HTTPAuthManager provideHTTPAuthManager() {
+        return new HTTPAuthManager();
+    }
 }
diff --git a/WordPressStores/src/main/java/org/wordpress/android/stores/network/AuthError.java b/WordPressStores/src/main/java/org/wordpress/android/stores/network/AuthError.java
@@ -7,4 +7,5 @@ public enum AuthError implements Payload {
     NOT_AUTHENTICATED,
     INCORRECT_USERNAME_OR_PASSWORD,
     UNAUTHORIZED,
+    HTTP_AUTH_ERROR,
 }
diff --git a/WordPressStores/src/main/java/org/wordpress/android/stores/network/BaseRequest.java b/WordPressStores/src/main/java/org/wordpress/android/stores/network/BaseRequest.java
@@ -1,5 +1,7 @@
 package org.wordpress.android.stores.network;
 
+import android.util.Base64;
+
 import com.android.volley.Response.ErrorListener;
 
 import java.util.HashMap;
@@ -25,6 +27,15 @@ public Map<String, String> getHeaders() {
         return mHeaders;
     }
 
+    public void setHTTPAuthHeaderOnMatchingURL(HTTPAuthManager httpAuthManager) {
+        HTTPAuthModel httpAuthModel = httpAuthManager.getHTTPAuthModel(getUrl());
+        if (httpAuthModel != null) {
+            String creds = String.format("%s:%s", httpAuthModel.getUsername(), httpAuthModel.getPassword());
+            String auth = "Basic " + Base64.encodeToString(creds.getBytes(), Base64.NO_WRAP);
+            mHeaders.put("Authorization", auth);
+        }
+    }
+
     public void setOnAuthFailedListener(OnAuthFailedListener onAuthFailedListener) {
         mOnAuthFailedListener = onAuthFailedListener;
     }
diff --git a/WordPressStores/src/main/java/org/wordpress/android/stores/network/HTTPAuthManager.java b/WordPressStores/src/main/java/org/wordpress/android/stores/network/HTTPAuthManager.java
@@ -0,0 +1,53 @@
+package org.wordpress.android.stores.network;
+
+import android.support.annotation.NonNull;
+import android.support.annotation.Nullable;
+
+import com.wellsql.generated.HTTPAuthModelTable;
+import com.yarolegovich.wellsql.WellSql;
+
+import org.wordpress.android.stores.persistence.HTTPAuthSqlUtils;
+
+import java.net.URI;
+import java.util.List;
+
+public class HTTPAuthManager {
+    public HTTPAuthManager() {}
+
+    private String normalizeURL(String url) {
+        try {
+            URI uri = URI.create(url);
+            return uri.normalize().toString();
+        } catch (IllegalArgumentException e) {
+            return url;
+        }
+    }
+
+    /**
+     * Get an HTTPAuthModel containing username and password for the url parameter
+     * TODO: Use an in memory model (or caching) - because this SQL query is executed every time a request is sent
+     *
+     * @param url to test
+     * @return null if url is not matching any known HTTP auth credentials
+     */
+    public @Nullable HTTPAuthModel getHTTPAuthModel(String url) {
+        List<HTTPAuthModel> authModels = WellSql.selectUnique(HTTPAuthModel.class).where()
+                .equals(HTTPAuthModelTable.ROOT_URL, normalizeURL(url))
+                .endWhere().getAsModel();
+        if (authModels.isEmpty()) {
+            return null;
+        }
+        return authModels.get(0);
+    }
+
+    public void addHTTPAuthCredentials(@NonNull String username, @NonNull String password,
+                                       @NonNull String url, @Nullable String realm) {
+        HTTPAuthModel httpAuthModel = new HTTPAuthModel();
+        httpAuthModel.setUsername(username);
+        httpAuthModel.setPassword(password);
+        httpAuthModel.setRootUrl(normalizeURL(url));
+        httpAuthModel.setRealm(realm);
+        // Replace old username / password / realm - URL used as key
+        HTTPAuthSqlUtils.insertOrUpdateModel(httpAuthModel);
+    }
+}
diff --git a/WordPressStores/src/main/java/org/wordpress/android/stores/network/HTTPAuthModel.java b/WordPressStores/src/main/java/org/wordpress/android/stores/network/HTTPAuthModel.java
@@ -0,0 +1,63 @@
+package org.wordpress.android.stores.network;
+
+import com.yarolegovich.wellsql.core.Identifiable;
+import com.yarolegovich.wellsql.core.annotation.Column;
+import com.yarolegovich.wellsql.core.annotation.PrimaryKey;
+import com.yarolegovich.wellsql.core.annotation.RawConstraints;
+import com.yarolegovich.wellsql.core.annotation.Table;
+
+@Table
+@RawConstraints({"UNIQUE (ROOT_URL)"})
+public class HTTPAuthModel implements Identifiable {
+    @PrimaryKey
+    @Column private int mId;
+    @Column private String mRootUrl;
+    @Column private String mRealm;
+    @Column private String mUsername;
+    @Column private String mPassword;
+
+    @Override
+    public int getId() {
+        return mId;
+    }
+
+    @Override
+    public void setId(int id) {
+        mId = id;
+    }
+
+    public HTTPAuthModel() {
+    }
+
+    public String getRealm() {
+        return mRealm;
+    }
+
+    public void setRealm(String realm) {
+        mRealm = realm;
+    }
+
+    public String getUsername() {
+        return mUsername;
+    }
+
+    public void setUsername(String username) {
+        mUsername = username;
+    }
+
+    public String getPassword() {
+        return mPassword;
+    }
+
+    public void setPassword(String password) {
+        mPassword = password;
+    }
+
+    public String getRootUrl() {
+        return mRootUrl;
+    }
+
+    public void setRootUrl(String rootUrl) {
+        mRootUrl = rootUrl;
+    }
+}
diff --git a/WordPressStores/src/main/java/org/wordpress/android/stores/network/xmlrpc/BaseXMLRPCClient.java b/WordPressStores/src/main/java/org/wordpress/android/stores/network/xmlrpc/BaseXMLRPCClient.java
@@ -8,6 +8,7 @@
 import org.wordpress.android.stores.model.SiteModel;
 import org.wordpress.android.stores.network.AuthError;
 import org.wordpress.android.stores.network.BaseRequest.OnAuthFailedListener;
+import org.wordpress.android.stores.network.HTTPAuthManager;
 import org.wordpress.android.stores.network.UserAgent;
 import org.wordpress.android.stores.network.rest.wpcom.auth.AccessToken;
 
@@ -18,13 +19,15 @@ public class BaseXMLRPCClient {
     protected final Dispatcher mDispatcher;
     private UserAgent mUserAgent;
     protected OnAuthFailedListener mOnAuthFailedListener;
+    private HTTPAuthManager mHTTPAuthManager;
 
     public BaseXMLRPCClient(Dispatcher dispatcher, RequestQueue requestQueue, AccessToken accessToken,
-                            UserAgent userAgent) {
+                            UserAgent userAgent, HTTPAuthManager httpAuthManager) {
         mRequestQueue = requestQueue;
         mDispatcher = dispatcher;
         mAccessToken = accessToken;
         mUserAgent = userAgent;
+        mHTTPAuthManager = httpAuthManager;
         mOnAuthFailedListener = new OnAuthFailedListener() {
             @Override
             public void onAuthFailed(AuthError authError) {
@@ -40,6 +43,7 @@ public Request add(XMLRPCRequest request) {
     private XMLRPCRequest setRequestAuthParams(XMLRPCRequest request) {
         request.setOnAuthFailedListener(mOnAuthFailedListener);
         request.setUserAgent(mUserAgent.getUserAgent());
+        request.setHTTPAuthHeaderOnMatchingURL(mHTTPAuthManager);
         return request;
     }
 }
diff --git a/WordPressStores/src/main/java/org/wordpress/android/stores/network/xmlrpc/XMLRPCRequest.java b/WordPressStores/src/main/java/org/wordpress/android/stores/network/xmlrpc/XMLRPCRequest.java
@@ -107,5 +107,9 @@ public void deliverError(VolleyError error) {
                 return;
             }
         }
+        if (error instanceof AuthFailureError) {
+            mOnAuthFailedListener.onAuthFailed(AuthError.HTTP_AUTH_ERROR);
+            return;
+        }
     }
 }
diff --git a/WordPressStores/src/main/java/org/wordpress/android/stores/network/xmlrpc/site/SiteXMLRPCClient.java b/WordPressStores/src/main/java/org/wordpress/android/stores/network/xmlrpc/site/SiteXMLRPCClient.java
@@ -9,6 +9,7 @@
 import org.wordpress.android.stores.action.SiteAction;
 import org.wordpress.android.stores.model.SiteModel;
 import org.wordpress.android.stores.model.SitesModel;
+import org.wordpress.android.stores.network.HTTPAuthManager;
 import org.wordpress.android.stores.network.UserAgent;
 import org.wordpress.android.stores.network.rest.wpcom.auth.AccessToken;
 import org.wordpress.android.stores.network.xmlrpc.BaseXMLRPCClient;
@@ -25,8 +26,8 @@
 
 public class SiteXMLRPCClient extends BaseXMLRPCClient {
     public SiteXMLRPCClient(Dispatcher dispatcher, RequestQueue requestQueue, AccessToken accessToken,
-                            UserAgent userAgent) {
-        super(dispatcher, requestQueue, accessToken, userAgent);
+                            UserAgent userAgent, HTTPAuthManager httpAuthManager) {
+        super(dispatcher, requestQueue, accessToken, userAgent, httpAuthManager);
     }
 
     public void pullSites(final String xmlrpcUrl, final String username, final String password) {
diff --git a/WordPressStores/src/main/java/org/wordpress/android/stores/persistence/HTTPAuthSqlUtils.java b/WordPressStores/src/main/java/org/wordpress/android/stores/persistence/HTTPAuthSqlUtils.java
@@ -0,0 +1,37 @@
+package org.wordpress.android.stores.persistence;
+
+import android.content.ContentValues;
+
+import com.wellsql.generated.HTTPAuthModelTable;
+import com.yarolegovich.wellsql.WellSql;
+import com.yarolegovich.wellsql.mapper.InsertMapper;
+
+import org.wordpress.android.stores.network.HTTPAuthModel;
+
+import java.util.List;
+
+public class HTTPAuthSqlUtils {
+    public static void insertOrUpdateModel(HTTPAuthModel model) {
+        List<HTTPAuthModel> modelResult = WellSql.select(HTTPAuthModel.class)
+                .where().equals(HTTPAuthModelTable.ROOT_URL, model.getRootUrl()).endWhere()
+                .getAsModel();
+        if (modelResult.isEmpty()) {
+            // insert
+            WellSql.insert(model).asSingleTransaction(true).execute();
+        } else {
+            // update
+            int oldId = modelResult.get(0).getId();
+            WellSql.update(HTTPAuthModel.class).whereId(oldId)
+                   .put(model, new InsertMapper<HTTPAuthModel>() {
+                       @Override
+                       public ContentValues toCv(HTTPAuthModel item) {
+                           ContentValues cv = new ContentValues();
+                           cv.put(HTTPAuthModelTable.USERNAME, item.getUsername());
+                           cv.put(HTTPAuthModelTable.PASSWORD, item.getPassword());
+                           cv.put(HTTPAuthModelTable.REALM, item.getRealm());
+                           return cv;
+                       }
+                   }).execute();
+        }
+    }
+}
diff --git a/WordPressStores/src/main/java/org/wordpress/android/stores/persistence/WellSqlConfig.java b/WordPressStores/src/main/java/org/wordpress/android/stores/persistence/WellSqlConfig.java
@@ -11,6 +11,7 @@
 
 import org.wordpress.android.stores.model.AccountModel;
 import org.wordpress.android.stores.model.SiteModel;
+import org.wordpress.android.stores.network.HTTPAuthModel;
 
 import java.util.Map;
 
@@ -21,7 +22,8 @@ public WellSqlConfig(Context context) {
 
     private static Class[] TABLES = {
             AccountModel.class,
-            SiteModel.class
+            SiteModel.class,
+            HTTPAuthModel.class
     };
 
     @Override
diff --git a/example/src/androidTest/java/org/wordpress/android/stores/TestUtils.java b/example/src/androidTest/java/org/wordpress/android/stores/TestUtils.java
@@ -4,7 +4,7 @@
 import org.wordpress.android.util.AppLog.T;
 
 public class TestUtils {
-    public static int DEFAULT_TIMEOUT = 60000;
+    public static int DEFAULT_TIMEOUT_MS = 30000;
 
     public static void waitFor(long milliseconds) {
         try {
@@ -15,7 +15,7 @@ public static void waitFor(long milliseconds) {
     }
 
     public static void waitForNetworkCall() {
-        waitFor(DEFAULT_TIMEOUT);
+        waitFor(DEFAULT_TIMEOUT_MS);
     }
 }
 
diff --git a/example/src/androidTest/java/org/wordpress/android/stores/module/MockedNetworkModule.java b/example/src/androidTest/java/org/wordpress/android/stores/module/MockedNetworkModule.java
@@ -10,6 +10,7 @@
 import org.mockito.invocation.InvocationOnMock;
 import org.mockito.stubbing.Answer;
 import org.wordpress.android.stores.Dispatcher;
+import org.wordpress.android.stores.network.HTTPAuthManager;
 import org.wordpress.android.stores.network.OkHttpStack;
 import org.wordpress.android.stores.network.UserAgent;
 import org.wordpress.android.stores.network.rest.wpcom.account.AccountRestClient;
@@ -104,8 +105,8 @@ public SiteRestClient provideSiteRestClient(Dispatcher dispatcher, RequestQueue
     @Singleton
     @Provides
     public SiteXMLRPCClient provideSiteXMLRPCClient(Dispatcher dispatcher, RequestQueue requestQueue, AccessToken token,
-                                                    UserAgent userAgent) {
-        return new SiteXMLRPCClient(dispatcher, requestQueue, token, userAgent);
+                                                    UserAgent userAgent, HTTPAuthManager httpAuthManager) {
+        return new SiteXMLRPCClient(dispatcher, requestQueue, token, userAgent, httpAuthManager);
     }
 
     @Singleton
@@ -120,4 +121,10 @@ public AccountRestClient provideAccountRestClient(Dispatcher dispatcher, Request
     public AccessToken provideAccountToken(Context appContext) {
         return new AccessToken(appContext);
     }
+
+    @Singleton
+    @Provides
+    public HTTPAuthManager provideHTTPAuthManager() {
+        return new HTTPAuthManager();
+    }
 }
diff --git a/example/src/androidTest/java/org/wordpress/android/stores/release/ReleaseStack_AccountTest.java b/example/src/androidTest/java/org/wordpress/android/stores/release/ReleaseStack_AccountTest.java
@@ -46,13 +46,13 @@ public void testWPCOMAuthenticationOK() throws InterruptedException {
         mDispatcher.dispatch(AuthenticationAction.AUTHENTICATE, payload);
         mCountDownLatch = new CountDownLatch(1);
         // Wait for a network response / onChanged event
-        assertEquals(true, mCountDownLatch.await(TestUtils.DEFAULT_TIMEOUT, TimeUnit.MILLISECONDS));
+        assertEquals(true, mCountDownLatch.await(TestUtils.DEFAULT_TIMEOUT_MS, TimeUnit.MILLISECONDS));
 
         // Get user infos
         mDispatcher.dispatch(AccountAction.FETCH);
         mCountDownLatch = new CountDownLatch(1);
         // Wait for a network response / onChanged event
-        assertEquals(true, mCountDownLatch.await(TestUtils.DEFAULT_TIMEOUT, TimeUnit.MILLISECONDS));
+        assertEquals(true, mCountDownLatch.await(TestUtils.DEFAULT_TIMEOUT_MS, TimeUnit.MILLISECONDS));
     }
 
     @Subscribe
diff --git a/example/src/androidTest/java/org/wordpress/android/stores/release/ReleaseStack_SiteTest.java b/example/src/androidTest/java/org/wordpress/android/stores/release/ReleaseStack_SiteTest.java
diff --git a/example/src/main/java/org/wordpress/android/stores/example/MainExampleActivity.java b/example/src/main/java/org/wordpress/android/stores/example/MainExampleActivity.java
diff --git a/example/src/main/java/org/wordpress/android/stores/example/SignInDialog.java b/example/src/main/java/org/wordpress/android/stores/example/SignInDialog.java
diff --git a/example/src/main/res/layout/signin_dialog.xml b/example/src/main/res/layout/signin_dialog.xml

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,6 @@ apply plugin: 'com.neenbedankt.android-apt'`
`15`	`15`
`16`	`16`	`repositories {`
`17`	`17`	`jcenter()`
`18`		`-`
`19`	`18`	`}`
`20`	`19`
`21`	`20`	`android {`
Original file line number	Diff line number	Diff line change
`@@ -7,4 +7,5 @@ public enum AuthError implements Payload {`
`7`	`7`	`NOT_AUTHENTICATED,`
`8`	`8`	`INCORRECT_USERNAME_OR_PASSWORD,`
`9`	`9`	`UNAUTHORIZED,`
	`10`	`+ HTTP_AUTH_ERROR,`
`10`	`11`	`}`
Original file line number	Diff line number	Diff line change
`@@ -107,5 +107,9 @@ public void deliverError(VolleyError error) {`
`107`	`107`	`return;`
`108`	`108`	`}`
`109`	`109`	`}`
	`110`	`+ if (error instanceof AuthFailureError) {`
	`111`	`+ mOnAuthFailedListener.onAuthFailed(AuthError.HTTP_AUTH_ERROR);`
	`112`	`+ return;`
	`113`	`+ }`
`110`	`114`	`}`
`111`	`115`	`}`