Issue 4399 - Add WebView inheritor with ad blocking

libadblockplus-android-settings/src/org/adblockplus/libadblockplus/android/settings/AdblockWhitelistedDomainsSettingsFragment.java

+/*
+ * This file is part of Adblock Plus <https://adblockplus.org/>,
+ * Copyright (C) 2006-2016 Eyeo GmbH
+ *
+ * Adblock Plus is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 3 as
+ * published by the Free Software Foundation.
+ *
+ * Adblock Plus 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 Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package org.adblockplus.libadblockplus.android.settings;
+
+import android.app.Activity;
+import android.os.Bundle;
+import android.util.Log;
+import android.view.LayoutInflater;
+import android.view.View;
+import android.view.ViewGroup;
+import android.widget.BaseAdapter;
+import android.widget.EditText;
+import android.widget.ImageView;
+import android.widget.ListView;
+import android.widget.TextView;
+
+import org.adblockplus.libadblockplus.android.Utils;
+
+import java.util.LinkedList;
+import java.util.List;
+
+/**
+ * Whitelisted domains adblock fragment.
+ * Use the {@link AdblockWhitelistedDomainsSettingsFragment#newInstance} factory method to
+ * create an instance of this fragment.
+ */
+public class AdblockWhitelistedDomainsSettingsFragment
+  extends AdblockSettingsFragment<AdblockWhitelistedDomainsSettingsFragment.Listener>
+{
+  private static final String TAG = Utils.getTag(AdblockWhitelistedDomainsSettingsFragment.class);
+
+  /**
+   * Listener with additional `isValidDomain` method
+   */
+  public interface Listener extends AdblockSettingsFragment.Listener
+  {
+    boolean isValidDomain(AdblockWhitelistedDomainsSettingsFragment fragment,
+                          String domain, AdblockSettings settings);
+  }
+
+  public AdblockWhitelistedDomainsSettingsFragment()
+  {
+    // required empty public constructor
+  }
+
+  /**
+   * Use this factory method to create a new instance of
+   * this fragment using the provided parameters.
+   *
+   */
+  public static AdblockWhitelistedDomainsSettingsFragment newInstance()
+  {
+    return new AdblockWhitelistedDomainsSettingsFragment();
+  }
+
+  @Override
+  public void onAttach(Activity activity)
+  {
+    super.onAttach(activity);
+    listener = castOrThrow(activity, Listener.class);
+  }
+
+  private EditText domain;
+  private ImageView addDomainButton;
+  private ListView listView;
+  private Adapter adapter;
+
+  @Override
+  public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)
+  {
+    View rootView = inflater.inflate(
+      R.layout.fragment_adblock_whitelisted_domains_settings,
+      container,
+      false);
+
+    bindControls(rootView);
+
+    return rootView;
+  }
+
+  @Override
+  public void onResume()
+  {
+    super.onResume();
+    initControls();
+  }
+
+  private void bindControls(View rootView)
+  {
+    domain = (EditText) rootView.findViewById(R.id.fragment_adblock_wl_add_label);
+    addDomainButton = (ImageView) rootView.findViewById(R.id.fragment_adblock_wl_add_button);
+    listView = (ListView) rootView.findViewById(R.id.fragment_adblock_wl_listview);
+  }
+
+  // Holder for listview items
+  private class Holder {
+    TextView domain;
+    ImageView removeButton;
+
+    Holder(View rootView)
+    {
+      domain = (TextView) rootView.findViewById(R.id.fragment_adblock_wl_item_title);
+      removeButton = (ImageView) rootView.findViewById(R.id.fragment_adblock_wl_item_remove);
+    }
+  }
+
+  private View.OnClickListener removeDomainClickListener = new View.OnClickListener()
+  {
+    @Override
+    public void onClick(View v)
+    {
+      // update and save settings
+      int position = ((Integer) v.getTag()).intValue();
+      String removeDomain = settings.getWhitelistedDomains().get(position);
+      Log.w(TAG, "Removing domain: " + removeDomain);
+      settings.getWhitelistedDomains().remove(position);
+      provider.getAdblockSettingsStorage().save(settings);
+
+      // apply settings
+      provider.getAdblockEngine().setWhitelistedDomains(settings.getWhitelistedDomains());
+
+      // signal event
+      listener.onAdblockSettingsChanged(AdblockWhitelistedDomainsSettingsFragment.this);
+
+      // update UI
+      adapter.notifyDataSetChanged();
+    }
+  };
+
+  // Adapter
+  private class Adapter extends BaseAdapter
+  {
+    @Override
+    public int getCount()
+    {
+      return settings.getWhitelistedDomains() != null
+        ? settings.getWhitelistedDomains().size()
+        : 0;
+    }
+
+    @Override
+    public Object getItem(int position)
+    {
+      return settings.getWhitelistedDomains().get(position);
+    }
+
+    @Override
+    public long getItemId(int position)
+    {
+      return getItem(position).hashCode();
+    }
+
+    @Override
+    public View getView(int position, View convertView, ViewGroup parent)
+    {
+      if (convertView == null)
+      {
+        LayoutInflater inflater = LayoutInflater.from(getActivity());
+        convertView = inflater.inflate(R.layout.fragment_adblock_whitelisted_domain_item,
+          parent, false);
+        convertView.setTag(new Holder(convertView));
+      }
+
+      String domain = (String) getItem(position);
+
+      Holder holder = (Holder) convertView.getTag();
+      holder.domain.setText(domain);
+
+      holder.removeButton.setOnClickListener(removeDomainClickListener);
+      holder.removeButton.setTag(Integer.valueOf(position));
+
+      return convertView;
+    }
+  }
+
+  private void initControls()
+  {
+    addDomainButton.setOnClickListener(new View.OnClickListener()
+    {
+      @Override
+      public void onClick(View v)
+      {
+        String preparedDomain = prepareDomain(domain.getText().toString());
+
+        if (listener.isValidDomain(
+          AdblockWhitelistedDomainsSettingsFragment.this,
+          preparedDomain,
+          settings))
+        {
+          addDomain(preparedDomain);
+        }
+        else
+        {
+          Log.w(TAG, "Domain " + preparedDomain + " is not valid");
+        }
+      }
+    });
+
+    adapter = new Adapter();
+    listView.setAdapter(adapter);
+  }
+
+  private String prepareDomain(String domain)
+  {
+    return domain.trim();
+  }
+
+  public void addDomain(String newDomain)
+  {
+    Log.d(TAG, "New domain added: " + newDomain);
+
+    List<String> whitelistedDomains = settings.getWhitelistedDomains();
+    if (whitelistedDomains == null)
+    {
+      whitelistedDomains = new LinkedList<String>();

[diegocarloslima, 2016/11/29 17:47:44]

I wouldn't insist, but I would advise to use the diamond operator here: 'new
LinkedList<>()'

[anton, 2016/11/30 06:34:43]

Diamond operator is supported starting Java 7 and i'd prefer back compatibility
to beauty.
It's a matter of agreement what version of Java to be used.

+      settings.setWhitelistedDomains(whitelistedDomains);
+    }
+
+    // update and save settings
+    whitelistedDomains.add(newDomain);
+    provider.getAdblockSettingsStorage().save(settings);
+
+    // apply settings
+    provider.getAdblockEngine().setWhitelistedDomains(whitelistedDomains);
+
+    // signal event
+    listener.onAdblockSettingsChanged(AdblockWhitelistedDomainsSettingsFragment.this);
+
+    // update UI
+    adapter.notifyDataSetChanged();
+    domain.getText().clear();
+    domain.clearFocus();
+  }
+}