From 300f2e95a4cecebb80c2c55418745df5c0c2fb6c Mon Sep 17 00:00:00 2001
From: Patrick Scott <phanna@android.com>
Date: Mon, 22 Mar 2010 10:20:45 -0400
Subject: [PATCH] Add on-demand setting for plugins.

Deprecate the old apis for enabling plugins in favor of the multi-state plugin
flag. Add the assets for WebView to display the plugin placeholder for on-demand
plugins.

Bug: 2411524
Change-Id: I5a35cc6d0afced1489f54d4dcb8bb92d36de52d8
---
 api/current.xml                           |  61 +++++++++++++++++++++-
 core/java/android/webkit/WebSettings.java |  45 ++++++++++++++--
 core/res/assets/webkit/togglePlugin.png   | Bin 0 -> 1009 bytes
 core/res/assets/webkit/togglePluginBg.png | Bin 0 -> 151 bytes
 4 files changed, 100 insertions(+), 6 deletions(-)
 create mode 100644 core/res/assets/webkit/togglePlugin.png
 create mode 100644 core/res/assets/webkit/togglePluginBg.png

diff --git a/api/current.xml b/api/current.xml
index 4af2a43f2de78..868f6fc51b2f1 100644
--- a/api/current.xml
+++ b/api/current.xml
@@ -193673,6 +193673,17 @@
  visibility="public"
 >
 </method>
+<method name="getPluginState"
+ return="android.webkit.WebSettings.PluginState"
+ abstract="false"
+ native="false"
+ synchronized="true"
+ static="false"
+ final="false"
+ deprecated="not deprecated"
+ visibility="public"
+>
+</method>
 <method name="getPluginsEnabled"
  return="boolean"
  abstract="false"
@@ -193680,7 +193691,7 @@
  synchronized="true"
  static="false"
  final="false"
- deprecated="not deprecated"
+ deprecated="deprecated"
  visibility="public"
 >
 </method>
@@ -194206,7 +194217,7 @@
 <parameter name="flag" type="boolean">
 </parameter>
 </method>
-<method name="setPluginsEnabled"
+<method name="setPluginState"
  return="void"
  abstract="false"
  native="false"
@@ -194216,6 +194227,19 @@
  deprecated="not deprecated"
  visibility="public"
 >
+<parameter name="state" type="android.webkit.WebSettings.PluginState">
+</parameter>
+</method>
+<method name="setPluginsEnabled"
+ return="void"
+ abstract="false"
+ native="false"
+ synchronized="true"
+ static="false"
+ final="false"
+ deprecated="deprecated"
+ visibility="public"
+>
 <parameter name="flag" type="boolean">
 </parameter>
 </method>
@@ -194525,6 +194549,39 @@
 >
 </method>
 </class>
+<class name="WebSettings.PluginState"
+ extends="java.lang.Enum"
+ abstract="false"
+ static="true"
+ final="true"
+ deprecated="not deprecated"
+ visibility="public"
+>
+<method name="valueOf"
+ return="android.webkit.WebSettings.PluginState"
+ abstract="false"
+ native="false"
+ synchronized="false"
+ static="true"
+ final="false"
+ deprecated="not deprecated"
+ visibility="public"
+>
+<parameter name="name" type="java.lang.String">
+</parameter>
+</method>
+<method name="values"
+ return="android.webkit.WebSettings.PluginState[]"
+ abstract="false"
+ native="false"
+ synchronized="false"
+ static="true"
+ final="true"
+ deprecated="not deprecated"
+ visibility="public"
+>
+</method>
+</class>
 <class name="WebSettings.RenderPriority"
  extends="java.lang.Enum"
  abstract="false"
diff --git a/core/java/android/webkit/WebSettings.java b/core/java/android/webkit/WebSettings.java
index d1da5ea5d4e6e..1b801d4d13807 100644
--- a/core/java/android/webkit/WebSettings.java
+++ b/core/java/android/webkit/WebSettings.java
@@ -120,6 +120,21 @@ public class WebSettings {
         LOW
     }
 
+    /**
+     * The plugin state effects how plugins are treated on a page. ON means
+     * that any object will be loaded even if a plugin does not exist to handle
+     * the content. ON_DEMAND means that if there is a plugin installed that
+     * can handle the content, a placeholder is shown until the user clicks on
+     * the placeholder. Once clicked, the plugin will be enabled on the page.
+     * OFF means that all plugins will be turned off and any fallback content
+     * will be used.
+     */
+    public enum PluginState {
+        ON,
+        ON_DEMAND,
+        OFF
+    }
+
     // WebView associated with this WebSettings.
     private WebView mWebView;
     // BrowserFrame used to access the native frame pointer.
@@ -157,7 +172,7 @@ public class WebSettings {
     private boolean         mBlockNetworkImage = false;
     private boolean         mBlockNetworkLoads;
     private boolean         mJavaScriptEnabled = false;
-    private boolean         mPluginsEnabled = false;
+    private PluginState     mPluginState = PluginState.OFF;
     private boolean         mJavaScriptCanOpenWindowsAutomatically = false;
     private boolean         mUseDoubleTree = false;
     private boolean         mUseWideViewport = false;
@@ -1011,10 +1026,23 @@ public class WebSettings {
     /**
      * Tell the WebView to enable plugins.
      * @param flag True if the WebView should load plugins.
+     * @deprecated This method has been deprecated in favor of
+     *             {@link #setPluginState}
      */
     public synchronized void setPluginsEnabled(boolean flag) {
-        if (mPluginsEnabled != flag) {
-            mPluginsEnabled = flag;
+        setPluginState(PluginState.ON);
+    }
+
+    /**
+     * Tell the WebView to enable, disable, or have plugins on demand. On
+     * demand mode means that if a plugin exists that can handle the embedded
+     * content, a placeholder icon will be shown instead of the plugin. When
+     * the placeholder is clicked, the plugin will be enabled.
+     * @param state One of the PluginState values.
+     */
+    public synchronized void setPluginState(PluginState state) {
+        if (mPluginState != state) {
+            mPluginState = state;
             postSync();
         }
     }
@@ -1176,9 +1204,18 @@ public class WebSettings {
     /**
      * Return true if plugins are enabled.
      * @return True if plugins are enabled.
+     * @deprecated This method has been replaced by {@link #getPluginState}
      */
     public synchronized boolean getPluginsEnabled() {
-        return mPluginsEnabled;
+        return mPluginState == PluginState.ON;
+    }
+
+    /**
+     * Return the current plugin state.
+     * @return A value corresponding to the enum PluginState.
+     */
+    public synchronized PluginState getPluginState() {
+        return mPluginState;
     }
 
     /**
diff --git a/core/res/assets/webkit/togglePlugin.png b/core/res/assets/webkit/togglePlugin.png
new file mode 100644
index 0000000000000000000000000000000000000000..008333c66e6017b50ee828f131d2d504935d5186
GIT binary patch
literal 1009
zcmV<N0}lL&P)<h;3K|Lk000e1NJLTq001Ze001Zm1^@s6jQ+T70000PbVXQnQ*UN;
zcVTj606}DLVr3vnZDD6+Qe|Oed2z{QJOBU#lSxEDRCwC#n8|JvK@f)j?ir64k`M>N
zA|en75D1h@SaRaT0p-X8@EBb3792qwa^ZqlL=ZxeKoAyzkXR2a5lAF4SYG1T@jBz_
zp=-#1F&@VgTQfnTrLrY=yX)(!uIlar{<rQLbG|1hCwELtOk9sfqvQ2@9hPPJ3PSp7
zwHg)|7oW|{%$%K?no82o>S}*<baZsOR4R=nlSvedMF=7MwG?Bv<n#IQcsxEWe>x?l
z>;MkSj<H-WhfF4eN~Pkv1qn`7Rg}wRNF$9Ala#Lx;D7`Kxt0d_4d=MnFbrFNp-`}y
z=)(b2sM9n}TY_w)pA1DzjezzFXy5t0_nKQXgWBA&5da&vSXY1x$v3Ff(_q|1nQ38g
z(_U;J+8+#HbZ8kPBRaHjYr<;9M0Oz|=iKKhSXu%)9bN#3hQl~;lp`E-0W6#Nq=z7u
zL@*ZALd=GXL>1RDA&sLddI0F87%yq2lYB{Iyv*6-D7HEpBSeo}?A?N$jqx%kjdiu4
z*C6rLg8#%G-0&`5Uyv~WT<loUn~T}TaIs!5qJ-DbB0o=!_^^g8BLm<(=BkWyCdbr}
z&OApht=sO_D-467<KRr~t&0_|;qd4%cJAf!_6z&`?H>$54Y^y8`nHcm5bIN**Mxm}
znEwc5K5+<3csq;Nj$(%N+%6nBo=1P2*^p~BvS8nUY76PiBrG|{Rtajh4U$Gc-f9oJ
zNhz=5(bY{bYToXQq;DlB@Z?6n{IAtkN3)B0s~dGYSx#w~y%v%0ht45sK~HW*QCe2l
zoWBbf|8C#r!gzVlz_HT;irU`Sw2+5aHKgY?(&AqpeE&3tzRg7(I$=Rkn2RzC?;bHE
z<btFI|1S$K?uOA9uVD8<<*#eM5Eeeawead*tRu_0<w4%+ve2m*I&l9=1j||Tk7JKA
z$l{#9;~Qa5^EK|nmVoOKT}I`d%c_jhpO7T^B@?sP6+2?P1?<VQvyf$Ya1A(fPT1DF
zeTidbiFds3Iy&mQeYh`tP;l#F-3H8O)OEqNJxO};aR2_r*)i*%!_~#QuG<oHWx+KM
zrc$Y2<ec+B;HYRsr9UcUHUpa3Y<8Y8wmT?5G7fo=%5R2Y%sa``0W2gEi3_n<?7TGZ
zwt$OAscN-)ftVU=)RgWIOF1cJ4;2jp;?t?BD&;wyrc?rE4aM~6YT0$bDINw9BdeB6
fOR13Oe+V!D6j&78grNRE00000NkvXXu0mjfgR|L2

literal 0
HcmV?d00001

diff --git a/core/res/assets/webkit/togglePluginBg.png b/core/res/assets/webkit/togglePluginBg.png
new file mode 100644
index 0000000000000000000000000000000000000000..2c65acbfa4aa7af69aef3ca966bfc339f0d780e5
GIT binary patch
literal 151
zcmeAS@N?(olHy`uVBq!ia0vp^tRT$61|)m))t&+=$r9IylHmNblJdl&R0hYC{G?O`
z&)mfH)S%SFl*+=BsWw1GmYyz-Ar-fDdKiTm99Wp1Cd$1}o?AL=VwO@4yYUZ`sDSc(
whE-mgC)3T2s7o8a-BJAVUv4wQUls|5&;t2iM~=Q@0UE;K>FVdQ&MBb@0PHg_LI3~&

literal 0
HcmV?d00001