PaymentRequest: Introduce PaymentMethodData.

chrome/android/java/src/org/chromium/chrome/browser/payments/PaymentRequestImpl.java

 // Copyright 2016 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 package org.chromium.chrome.browser.payments;
 
 import android.app.Activity;
 import android.graphics.Bitmap;
 import android.os.Handler;
 import android.text.TextUtils;
@@ skipping 12 matching lines @@
 import org.chromium.chrome.browser.preferences.PreferencesLauncher;
 import org.chromium.chrome.browser.preferences.autofill.AutofillCreditCardEditor;
 import org.chromium.chrome.browser.preferences.autofill.AutofillProfileEditor;
 import org.chromium.chrome.browser.profiles.Profile;
 import org.chromium.chrome.browser.util.UrlUtilities;
 import org.chromium.content.browser.ContentViewCore;
 import org.chromium.content_public.browser.WebContents;
 import org.chromium.mojo.system.MojoException;
 import org.chromium.mojom.payments.PaymentDetails;
 import org.chromium.mojom.payments.PaymentItem;
+import org.chromium.mojom.payments.PaymentMethodData;
 import org.chromium.mojom.payments.PaymentOptions;
 import org.chromium.mojom.payments.PaymentRequest;
 import org.chromium.mojom.payments.PaymentRequestClient;
 import org.chromium.mojom.payments.PaymentResponse;
 import org.chromium.mojom.payments.ShippingOption;
 import org.chromium.ui.base.WindowAndroid;
 import org.json.JSONException;
 import org.json.JSONObject;
 
 import java.util.ArrayList;
 import java.util.Arrays;
-import java.util.HashSet;
-import java.util.Iterator;
+import java.util.HashMap;
 import java.util.List;
 import java.util.Locale;
 import java.util.Set;
 import java.util.regex.Pattern;
 
 /**
  * Android implementation of the PaymentRequest service defined in
  * third_party/WebKit/public/platform/modules/payments/payment_request.mojom.
  */
 public class PaymentRequestImpl implements PaymentRequest, PaymentRequestUI.Client,
         PaymentApp.InstrumentsCallback, PaymentInstrument.DetailsCallback {
 
     /**
      * The size for the favicon in density-independent pixels.
      */
     private static final int FAVICON_SIZE_DP = 24;
 
     private static final String TAG = "cr_PaymentRequest";
 
     private final Handler mHandler = new Handler();
 
     private Activity mContext;
     private String mMerchantName;
     private String mOrigin;
     private Bitmap mFavicon;
     private List<PaymentApp> mApps;
     private PaymentRequestClient mClient;
-    private Set<String> mSupportedMethods;
 
     /**
      * The raw total amount being charged, as it was received from the website. This data is passed
      * to the payment app.
      */
     private PaymentItem mRawTotal;
 
     /**
      * The raw items in the shopping cart, as they were received from the website. This data is
      * passed to the payment app.
@@ skipping 12 matching lines @@
      * due to user selecting a shipping address.
      */
     private List<ShippingOption> mRawShippingOptions;
 
     /**
      * The UI model for the shipping options. Includes the label and sublabel for each shipping
      * option. Also keeps track of the selected shipping option. This data is passed to the UI.
      */
     private SectionInformation mUiShippingOptions;
 
-    private JSONObject mData;
+    private HashMap<String, JSONObject> mMethodData;
     private SectionInformation mShippingAddressesSection;
     private List<PaymentApp> mPendingApps;
     private List<PaymentInstrument> mPendingInstruments;
     private SectionInformation mPaymentMethodsSection;
     private PaymentRequestUI mUI;
     private Callback<PaymentInformation> mPaymentInformationCallback;
     private Pattern mRegionCodePattern;
     private boolean mMerchantNeedsShippingAddress;
 
     /**
@@ skipping 51 matching lines @@
 
         if (mContext == null) {
             disconnectFromClientWithDebugMessage("Web contents don't have associated activity");
         }
     }
 
     /**
      * Called by the merchant website to show the payment request to the user.
      */
     @Override
-    public void show(String[] supportedMethods, PaymentDetails details, PaymentOptions options,
-            String stringifiedData) {
+    public void show(PaymentMethodData[] methodData, PaymentDetails details,
+            PaymentOptions options) {
         if (mClient == null) return;
 
-        if (mSupportedMethods != null) {
+        if (mMethodData != null) {
             disconnectFromClientWithDebugMessage("PaymentRequest.show() called more than once.");
             return;
         }
 
-        mSupportedMethods = getValidatedSupportedMethods(supportedMethods);
-        if (mSupportedMethods == null) {
-            disconnectFromClientWithDebugMessage("Invalid payment methods");
+        mMethodData = getValidatedMethodData(methodData);
+        if (mMethodData == null) {
+            disconnectFromClientWithDebugMessage("Invalid payment methods or data");
             return;
         }
 
         if (!parseAndValidateDetailsOrDisconnectFromClient(details)) return;
 
         // If the merchant requests shipping and does not provide shipping options here, then the
         // merchant needs the shipping address to calculate shipping price and availability.
         boolean requestShipping = options != null && options.requestShipping;
         mMerchantNeedsShippingAddress = requestShipping && mUiShippingOptions.isEmpty();
 
-        mData = getValidatedData(mSupportedMethods, stringifiedData);
-        if (mData == null) {
-            disconnectFromClientWithDebugMessage("Invalid payment method specific data");
-            return;
-        }
-
         List<AutofillAddress> addresses = new ArrayList<>();
         List<AutofillProfile> profiles = PersonalDataManager.getInstance().getProfilesToSuggest();
         for (int i = 0; i < profiles.size(); i++) {
             AutofillProfile profile = profiles.get(i);
             if (profile.getCountryCode() != null
                     && mRegionCodePattern.matcher(profile.getCountryCode()).matches()
                     && profile.getStreetAddress() != null && profile.getRegion() != null
                     && profile.getLocality() != null && profile.getDependentLocality() != null
                     && profile.getPostalCode() != null && profile.getSortingCode() != null
                     && profile.getCompanyName() != null && profile.getFullName() != null) {
                 addresses.add(new AutofillAddress(profile));
             }
         }
 
         int selectedIndex = SectionInformation.NO_SELECTION;
         if (!addresses.isEmpty() && mUiShippingOptions.getSelectedItem() != null) {
             selectedIndex = 0;
         }
         mShippingAddressesSection = new SectionInformation(
                 PaymentRequestUI.TYPE_SHIPPING_ADDRESSES, selectedIndex, addresses);
 
         mPendingApps = new ArrayList<>(mApps);
         mPendingInstruments = new ArrayList<>();
         boolean isGettingInstruments = false;
 
         for (int i = 0; i < mApps.size(); i++) {
             PaymentApp app = mApps.get(i);
             Set<String> appMethods = app.getSupportedMethodNames();
-            appMethods.retainAll(mSupportedMethods);
+            appMethods.retainAll(mMethodData.keySet());
             if (appMethods.isEmpty()) {
                 mPendingApps.remove(app);
             } else {
                 isGettingInstruments = true;
                 app.getInstruments(mRawTotal, mRawLineItems, this);
             }
         }
 
         if (!isGettingInstruments) {
             mPaymentMethodsSection = new SectionInformation(PaymentRequestUI.TYPE_PAYMENT_METHODS);
         }
 
         mUI = PaymentRequestUI.show(mContext, this, requestShipping, mMerchantName, mOrigin);
         if (mFavicon != null) mUI.setTitleBitmap(mFavicon);
         mFavicon = null;
     }
 
-    private HashSet<String> getValidatedSupportedMethods(String[] methods) {
-        // Payment methods are required.
-        if (methods == null || methods.length == 0) return null;
+    private HashMap<String, JSONObject> getValidatedMethodData(PaymentMethodData[] methodData) {
+        // Payment methodData are required.
+        if (methodData == null || methodData.length == 0) return null;
+        HashMap<String, JSONObject> result = new HashMap<>();
+        for (int i = 0; i < methodData.length; i++) {
+            JSONObject data = null;
+            if (!TextUtils.isEmpty(methodData[i].data)) {
+                try {
+                    data = new JSONObject(methodData[i].data);
+                } catch (JSONException e) {
+                    // Payment method specific data should be a JSON object.

[please use gerrit instead, 2016/06/09 02:44:13]

Looks like your rebase has removed that very useful comment about rejecting all
data if any of it is invalid. This patch is getting large and unwieldy. It would
be nice to commit it sooner rather than later.

+                    return null;
+                }
+            }
 
-        HashSet<String> result = new HashSet<>();
-        for (int i = 0; i < methods.length; i++) {
-            // Payment methods should be non-empty.
-            if (TextUtils.isEmpty(methods[i])) return null;
-            result.add(methods[i]);
+            String[] methods = methodData[i].supportedMethods;
+
+            // Payment methods are required.
+            if (methods == null || methods.length == 0) return null;
+
+            for (int j = 0; j < methods.length; j++) {
+                // Payment methods should be non-empty.
+                if (TextUtils.isEmpty(methods[j])) return null;
+                result.put(methods[j], data);
+            }
         }
-
         return result;
     }
 
     /**
      * Called by merchant to update the shipping options and line items after the user has selected
      * their shipping address or shipping option.
      */
     @Override
     public void updateWith(PaymentDetails details) {
         if (mClient == null) return;
@@ skipping 181 matching lines @@
         for (int i = 0; i < options.length; i++) {
             ShippingOption option = options[i];
             result.add(new PaymentOption(option.id, option.label,
                     formatter.format(option.amount.value), PaymentOption.NO_ICON));
         }
 
         return new SectionInformation(PaymentRequestUI.TYPE_SHIPPING_OPTIONS,
                 result.size() == 1 ? 0 : SectionInformation.NO_SELECTION, result);
     }
 
-    private JSONObject getValidatedData(Set<String> supportedMethods, String stringifiedData) {
-        if (TextUtils.isEmpty(stringifiedData)) return new JSONObject();
-
-        JSONObject result;
-        try {
-            result = new JSONObject(stringifiedData);
-        } catch (JSONException e) {
-            // Payment method specific data should be a JSON object.
-            return null;
-        }
-
-        Iterator<String> it = result.keys();
-        while (it.hasNext()) {
-            String name = it.next();
-            // Each key should be one of the supported payment methods.
-            if (!supportedMethods.contains(name)) return null;
-            // Each value should be a JSON object.
-            if (result.optJSONObject(name) == null) return null;
-        }
-
-        return result;
-    }
-
     /**
      * Called to retrieve the data to show in the initial PaymentRequest UI.
      */
     @Override
     public void getDefaultPaymentInformation(Callback<PaymentInformation> callback) {
         mPaymentInformationCallback = callback;
 
         if (mPaymentMethodsSection == null) return;
 
         mHandler.post(new Runnable() {
@@ skipping 70 matching lines @@
                     mContext, AutofillCreditCardEditor.class.getName());
         }
     }
 
     @Override
     public void onPayClicked(PaymentOption selectedShippingAddress,
             PaymentOption selectedShippingOption, PaymentOption selectedPaymentMethod) {
         assert selectedPaymentMethod instanceof PaymentInstrument;
         PaymentInstrument instrument = (PaymentInstrument) selectedPaymentMethod;
         instrument.getDetails(mMerchantName, mOrigin, mRawTotal, mRawLineItems,
-                mData.optJSONObject(instrument.getMethodName()), this);
+                mMethodData.get(instrument.getMethodName()), this);
     }
 
     @Override
     public void onDismiss() {
         disconnectFromClientWithDebugMessage("Dialog dismissed");
         closeUI(false);
     }
 
     @Override
     public boolean merchantNeedsShippingAddress() {
@@ skipping 38 matching lines @@
     /**
      * Called after retrieving the list of payment instruments in an app.
      */
     @Override
     public void onInstrumentsReady(PaymentApp app, List<PaymentInstrument> instruments) {
         mPendingApps.remove(app);
 
         if (instruments != null) {
             for (int i = 0; i < instruments.size(); i++) {
                 PaymentInstrument instrument = instruments.get(i);
-                if (mSupportedMethods.contains(instrument.getMethodName())) {
+                if (mMethodData.containsKey(instrument.getMethodName())) {
                     mPendingInstruments.add(instrument);
                 } else {
                     instrument.dismiss();
                 }
             }
         }
 
         if (mPendingApps.isEmpty()) {
             mPaymentMethodsSection = new SectionInformation(
                     PaymentRequestUI.TYPE_PAYMENT_METHODS, 0, mPendingInstruments);
@@ skipping 67 matching lines @@
             }
             mPaymentMethodsSection = null;
         }
     }
 
     private void closeClient() {
         if (mClient != null) mClient.close();
         mClient = null;
     }
 }