Added webview header support (#35)

* Added webview header support for Android

* Set custom headers on iOS

* Clear headers when a URL is opened in a webview

* review fix

Author: britzl

.gitignore

@@ -9,8 +9,8 @@ Thumbs.db
 .cproject
 builtins
 docs/_site
-.editor_settings
-debug.keystore
-debug.keystore.pass.txt
+/.editor_settings
 manifest.private.der
 manifest.public.der
+debug.keystore
+debug.keystore.pass.txt

main/main.gui_script

@@ -24,6 +24,7 @@ local function webview_callback(self, webview_id, request_id, type, data)
 
     elseif type == webview.CALLBACK_RESULT_URL_LOADING then
         print("CALLBACK_RESULT_URL_LOADING")
+        pprint(data)
         -- a page is loading
         -- return false to prevent it from loading
         -- return true or nil to continue loading the page
@@ -87,7 +88,13 @@ function on_input(self, action_id, action)
     dirtylarry:button("button_open", action_id, action, function()
         if not webview_exists(self) then return end
 
-        webview.open(self.webview_id, "https://www.google.com")
+        local options = {
+            headers = {
+                ["Accept-Origin"] = "*",
+                ["User-Agent"] = "Foobar 1.0",
+            }
+        }
+        webview.open(self.webview_id, "https://www.google.com", options)
     end)
 
     dirtylarry:button("button_eval", action_id, action, function()

webview/api/webview.script_api

@@ -111,6 +111,9 @@
           - name: hidden
             type: boolean
             desc: If true, the webview will stay hidden (default=false)
+          - name: headers
+            type: table
+            desc: A table of header keys and values
           - name: transparent
             type: boolean
             desc: If true, the webview background will be transparent (default=false)

webview/src/java/com/defold/webview/WebViewJNI.java

@@ -20,16 +20,24 @@
 import android.widget.LinearLayout;
 import android.webkit.ConsoleMessage;
 import android.webkit.JavascriptInterface;
+import android.webkit.MimeTypeMap;
 import android.webkit.WebChromeClient;
 import android.webkit.WebView;
 import android.webkit.WebViewClient;
 import android.webkit.WebSettings;
+import android.webkit.WebResourceRequest;
+import android.webkit.WebResourceResponse;
 
 import android.graphics.PixelFormat;
 import android.graphics.Color;
 
 import android.util.Log;
 
+import java.util.Map;
+import java.util.HashMap;
+import java.net.HttpURLConnection;
+import java.net.URL;
+
 
 public class WebViewJNI {
 
@@ -55,6 +63,7 @@ private static class CustomWebViewClient extends WebViewClient {
         private String continueLoadingUrl;
         private WebViewJNI webviewJNI;
         private String PACKAGE_NAME;
+        private Map<String, String> extraHeaders = new HashMap<>();
 
         // This is a hack to counter for the case where the load() experiences an error
         // In that case, the onReceivedError will be called, and onPageFinished will be called TWICE
@@ -70,6 +79,19 @@ public CustomWebViewClient(Activity activity, WebViewJNI webviewJNI, int webview
             reset(-1);
         }
 
+        public void addHeader(final String header, final String value) {
+            if (value == null) {
+                extraHeaders.remove(header);
+            }
+            else {
+                extraHeaders.put(header, value);
+            }
+        }
+
+        public void clearHeaders() {
+            extraHeaders.clear();
+        }
+
         private String trimTrailingSlash(String url) {
             if (url.endsWith("/")) {
                 url = url.substring(0, url.length() - 1);
@@ -98,6 +120,36 @@ private boolean shouldContinueLoadingUrl(String url) {
             return trimTrailingSlash(continueLoadingUrl).equals(trimTrailingSlash(url));
         }
 
+        @Override
+        public WebResourceResponse shouldInterceptRequest(WebView view, WebResourceRequest request) {
+            final String method = request.getMethod();
+            final String url = request.getUrl().toString();
+            String ext = MimeTypeMap.getFileExtensionFromUrl(url);
+            String mime = MimeTypeMap.getSingleton().getMimeTypeFromExtension(ext);
+
+            try {
+                HttpURLConnection conn = (HttpURLConnection)new URL(url).openConnection();
+                conn.setRequestMethod(method);
+                for (String header : extraHeaders.keySet()) {
+                    String value = extraHeaders.get(header);
+                    conn.setRequestProperty(header, value);
+                }
+                conn.setDoInput(true);
+                conn.setUseCaches(false);
+
+                return new WebResourceResponse(
+                    mime,
+                    conn.getContentEncoding(),
+                    conn.getInputStream()
+                );
+
+            }
+            catch (Exception e) {
+                Log.e(TAG, "shouldInterceptRequest: " + e);
+            }
+            return null;
+        }
+
         @Override
         public boolean shouldOverrideUrlLoading(WebView view, String url) {
             if( url.startsWith(PACKAGE_NAME) )
@@ -353,6 +405,14 @@ public void run() {
         });
     }
 
+    public void addHeader(final int webview_id, final String header, final String value) {
+        WebViewJNI.this.infos[webview_id].webviewClient.addHeader(header, value);
+    }
+
+    public void clearHeaders(final int webview_id) {
+        WebViewJNI.this.infos[webview_id].webviewClient.clearHeaders();
+    }
+
     public void loadRaw(final String html, final int webview_id, final int request_id, final int hidden, final int transparent) {
         this.activity.runOnUiThread(new Runnable() {
             @Override

webview/src/webview_android.cpp

@@ -68,6 +68,8 @@ struct WebViewExtensionState
     jmethodID               m_SetVisible;
     jmethodID               m_IsVisible;
     jmethodID               m_SetPosition;
+    jmethodID               m_AddHeader;
+    jmethodID               m_ClearHeaders;
     dmMutex::HMutex         m_Mutex;
     dmArray<WebViewCommand> m_CmdQueue;
 };
@@ -178,6 +180,7 @@ int Platform_Eval(lua_State* L, int webview_id, const char* code)
     JNIEnv* env = threadAttacher.GetEnv();
     jstring jcode = env->NewStringUTF(code);
     env->CallVoidMethod(g_WebView.m_WebViewJNI, g_WebView.m_Eval, jcode, webview_id, request_id);
+    env->DeleteLocalRef(jcode);
     return request_id;
 }
 
@@ -217,6 +220,28 @@ int Platform_SetPosition(lua_State* L, int webview_id, int x, int y, int width,
     return 0;
 }
 
+int Platform_ClearHeaders(lua_State* L, int webview_id)
+{
+    CHECK_WEBVIEW_AND_RETURN();
+    dmAndroid::ThreadAttacher threadAttacher;
+    JNIEnv* env = threadAttacher.GetEnv();
+    env->CallVoidMethod(g_WebView.m_WebViewJNI, g_WebView.m_ClearHeaders, webview_id);
+    return 0;
+}
+
+int Platform_AddHeader(lua_State* L, int webview_id, const char* header, const char* value)
+{
+    CHECK_WEBVIEW_AND_RETURN();
+    dmAndroid::ThreadAttacher threadAttacher;
+    JNIEnv* env = threadAttacher.GetEnv();
+    jstring jheader = env->NewStringUTF(header);
+    jstring jvalue = env->NewStringUTF(value);
+    env->CallVoidMethod(g_WebView.m_WebViewJNI, g_WebView.m_AddHeader, webview_id, jheader, jvalue);
+    env->DeleteLocalRef(jheader);
+    env->DeleteLocalRef(jvalue);
+    return 0;
+}
+
 #undef CHECK_WEBVIEW_AND_RETURN
 
 static char* CopyString(JNIEnv* env, jstring s)
@@ -401,6 +426,8 @@ dmExtension::Result Platform_AppInitialize(dmExtension::AppParams* params)
     g_WebView.m_SetTransparent = env->GetMethodID(webview_class, "setTransparent", "(II)V");
     g_WebView.m_IsVisible = env->GetMethodID(webview_class, "isVisible", "(I)I");
     g_WebView.m_SetPosition = env->GetMethodID(webview_class, "setPosition", "(IIIII)V");
+    g_WebView.m_AddHeader = env->GetMethodID(webview_class, "addHeader", "(ILjava/lang/String;Ljava/lang/String;)V");
+    g_WebView.m_ClearHeaders = env->GetMethodID(webview_class, "clearHeaders", "(I)V");
 
     int32_t immersiveMode = dmConfigFile::GetInt(params->m_ConfigFile, "android.immersive_mode", 0);
     int32_t displayCutout = dmConfigFile::GetInt(params->m_ConfigFile, "android.display_cutout", 1);

webview/src/webview_common.cpp

@@ -136,18 +136,60 @@ static int Destroy(lua_State* L)
     return 1;
 }
 
-void ParseOptions(lua_State* L, int argumentindex, RequestInfo* requestinfo)
+
+void ParseHeaders(lua_State* L, int argumentindex, int webview_id)
+{
+    Platform_ClearHeaders(L, webview_id);
+    luaL_checktype(L, argumentindex, LUA_TTABLE);
+    lua_pushvalue(L, argumentindex);
+
+    // first key
+    lua_pushnil(L);
+
+    // push key-value pair
+    while (lua_next(L, -2))
+    {
+        // push copy of key (ie the header), convert it, pop it
+        // note from Lua docs: If the value is a number, then lua_tolstring also
+        // changes the actual value in the stack to a string. This change
+        // confuses lua_next when lua_tolstring is applied to keys during a
+        // table traversal
+        lua_pushvalue(L, -2);
+        const char* header = lua_tostring(L, -1);
+        lua_pop(L, 1);
+
+        // push copy of value, convert it, pop it
+        lua_pushvalue(L, -1);
+        const char* value = lua_tostring(L, -1);
+        lua_pop(L, 1);
+
+        Platform_AddHeader(L, webview_id, header, value);
+
+        // remove value, keep key for lua_next
+        lua_pop(L, 1);
+    }
+    lua_pop(L, 1);
+}
+
+
+void ParseOptions(lua_State* L, int argumentindex, int webview_id, RequestInfo* requestinfo)
 {
     luaL_checktype(L, argumentindex, LUA_TTABLE);
     lua_pushvalue(L, argumentindex);
     lua_pushnil(L);
     while (lua_next(L, -2)) {
-        const char* attr = lua_tostring(L, -2);
+        lua_pushvalue(L, -2);
+        const char* attr = lua_tostring(L, -1);
+        lua_pop(L, 1);
         if( strcmp(attr, "hidden") == 0 )
         {
             luaL_checktype(L, -1, LUA_TBOOLEAN);
             requestinfo->m_Hidden = lua_toboolean(L, -1);
         }
+        else if (strcmp(attr, "headers") == 0)
+        {
+            ParseHeaders(L, -1, webview_id);
+        }
         else if( strcmp(attr, "transparent") == 0 )
         {
             luaL_checktype(L, -1, LUA_TBOOLEAN);
@@ -158,10 +200,6 @@ void ParseOptions(lua_State* L, int argumentindex, RequestInfo* requestinfo)
     lua_pop(L, 1);
 }
 
-/** Opens an url in the view
-@param url url
-@return the request id
-*/
 static int Open(lua_State* L)
 {
     int top = lua_gettop(L);
@@ -171,7 +209,7 @@ static int Open(lua_State* L)
     RequestInfo requestinfo;
     if( top >= 3 && !lua_isnil(L, 3))
     {
-        ParseOptions(L, 3, &requestinfo);
+        ParseOptions(L, 3, webview_id, &requestinfo);
     }
 
     int request_id = Platform_Open(L, webview_id, url, &requestinfo);
@@ -190,7 +228,7 @@ static int OpenRaw(lua_State* L)
     RequestInfo requestinfo;
     if( top >= 3 && !lua_isnil(L, 3))
     {
-        ParseOptions(L, 3, &requestinfo);
+        ParseOptions(L, 3, webview_id, &requestinfo);
     }
 
     int request_id = Platform_OpenRaw(L, webview_id, html, &requestinfo);

webview/src/webview_common.h

@@ -69,6 +69,8 @@ int Platform_SetTransparent(lua_State* L, int webview_id, int transparent);
 int Platform_SetVisible(lua_State* L, int webview_id, int visible);
 int Platform_IsVisible(lua_State* L, int webview_id);
 int Platform_SetPosition(lua_State* L, int webview_id, int x, int y, int width, int height);
+int Platform_AddHeader(lua_State* L, int webview_id, const char* header, const char* value);
+int Platform_ClearHeaders(lua_State* L, int webview_id);
 
 // The extension life cycle functions
 dmExtension::Result Platform_AppInitialize(dmExtension::AppParams* params);