Java tutorial
/* Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ package org.apache.cordova.engine.apiref; import java.util.Hashtable; import org.apache.cordova.AuthenticationToken; import org.apache.cordova.CordovaInterface; import org.apache.cordova.CordovaUriHelper; import org.apache.cordova.LOG; import org.json.JSONException; import org.json.JSONObject; import android.annotation.TargetApi; import android.content.pm.ApplicationInfo; import android.content.pm.PackageManager; import android.content.pm.PackageManager.NameNotFoundException; import android.graphics.Bitmap; import android.net.http.SslError; import android.view.View; import android.webkit.HttpAuthHandler; import android.webkit.SslErrorHandler; import android.webkit.WebView; import android.webkit.WebViewClient; /** * This class is the WebViewClient that implements callbacks for our web view. * The kind of callbacks that happen here are regarding the rendering of the * document instead of the chrome surrounding it, such as onPageStarted(), * shouldOverrideUrlLoading(), etc. Related to but different than * CordovaChromeClient. * * @see <a href="http://developer.android.com/reference/android/webkit/WebViewClient.html">WebViewClient</a> * @see <a href="http://developer.android.com/guide/webapps/webview.html">WebView guide</a> * @see CordovaChromeClient * @see CordovaWebView */ public class ImpSpecificWebViewClient extends WebViewClient { private static final String TAG = "AndroidWebViewClient"; protected final CordovaInterface cordova; protected final ReferenceWebView appView; protected final CordovaUriHelper helper; private boolean doClearHistory = false; boolean isCurrentlyLoading; /** The authorization tokens. */ private Hashtable<String, AuthenticationToken> authenticationTokens = new Hashtable<String, AuthenticationToken>(); public ImpSpecificWebViewClient(CordovaInterface cordova, ReferenceWebView view) { this.cordova = cordova; this.appView = view; helper = new CordovaUriHelper(cordova, view); } /** * Give the host application a chance to take over the control when a new url * is about to be loaded in the current WebView. * * @param view The WebView that is initiating the callback. * @param url The url to be loaded. * @return true to override, false for default behavior */ @Override public boolean shouldOverrideUrlLoading(WebView view, String url) { return helper.shouldOverrideUrlLoading(url); } /** * On received http auth request. * The method reacts on all registered authentication tokens. There is one and only one authentication token for any host + realm combination */ @Override public void onReceivedHttpAuthRequest(WebView view, HttpAuthHandler handler, String host, String realm) { // Get the authentication token AuthenticationToken token = this.getAuthenticationToken(host, realm); if (token != null) { handler.proceed(token.getUserName(), token.getPassword()); } else { // Handle 401 like we'd normally do! super.onReceivedHttpAuthRequest(view, handler, host, realm); } } /** * Notify the host application that a page has started loading. * This method is called once for each main frame load so a page with iframes or framesets will call onPageStarted * one time for the main frame. This also means that onPageStarted will not be called when the contents of an * embedded frame changes, i.e. clicking a link whose target is an iframe. * * @param view The webview initiating the callback. * @param url The url of the page. */ @Override public void onPageStarted(WebView view, String url, Bitmap favicon) { super.onPageStarted(view, url, favicon); isCurrentlyLoading = true; LOG.d(TAG, "onPageStarted(" + url + ")"); // Flush stale messages & reset plugins. this.appView.onPageReset(); // Broadcast message that page has loaded this.appView.getPluginManager().postMessage("onPageStarted", url); } /** * Notify the host application that a page has finished loading. * This method is called only for main frame. When onPageFinished() is called, the rendering picture may not be updated yet. * * * @param view The webview initiating the callback. * @param url The url of the page. */ @Override public void onPageFinished(WebView view, String url) { super.onPageFinished(view, url); // Ignore excessive calls. if (!isCurrentlyLoading) { return; } isCurrentlyLoading = false; LOG.d(TAG, "onPageFinished(" + url + ")"); /** * Because of a timing issue we need to clear this history in onPageFinished as well as * onPageStarted. However we only want to do this if the doClearHistory boolean is set to * true. You see when you load a url with a # in it which is common in jQuery applications * onPageStared is not called. Clearing the history at that point would break jQuery apps. */ if (this.doClearHistory) { view.clearHistory(); this.doClearHistory = false; } // Clear timeout flag appView.loadUrlTimeout++; // Broadcast message that page has loaded this.appView.getPluginManager().postMessage("onPageFinished", url); // Make app visible after 2 sec in case there was a JS error and Cordova JS never initialized correctly if (this.appView.getVisibility() == View.INVISIBLE) { Thread t = new Thread(new Runnable() { public void run() { try { Thread.sleep(2000); cordova.getActivity().runOnUiThread(new Runnable() { public void run() { appView.getPluginManager().postMessage("spinner", "stop"); } }); } catch (InterruptedException e) { } } }); t.start(); } // Shutdown if blank loaded if (url.equals("about:blank")) { appView.getPluginManager().postMessage("exit", null); } } /** * Report an error to the host application. These errors are unrecoverable (i.e. the main resource is unavailable). * The errorCode parameter corresponds to one of the ERROR_* constants. * * @param view The WebView that is initiating the callback. * @param errorCode The error code corresponding to an ERROR_* value. * @param description A String describing the error. * @param failingUrl The url that failed to load. */ @Override public void onReceivedError(WebView view, int errorCode, String description, String failingUrl) { // Ignore error due to stopLoading(). if (!isCurrentlyLoading) { return; } LOG.d(TAG, "CordovaWebViewClient.onReceivedError: Error code=%s Description=%s URL=%s", errorCode, description, failingUrl); // Clear timeout flag appView.loadUrlTimeout++; // If this is a "Protocol Not Supported" error, then revert to the previous // page. If there was no previous page, then punt. The application's config // is likely incorrect (start page set to sms: or something like that) if (errorCode == WebViewClient.ERROR_UNSUPPORTED_SCHEME) { if (view.canGoBack()) { view.goBack(); return; } else { super.onReceivedError(view, errorCode, description, failingUrl); } } // Handle other errors by passing them to the webview in JS JSONObject data = new JSONObject(); try { data.put("errorCode", errorCode); data.put("description", description); data.put("url", failingUrl); } catch (JSONException e) { e.printStackTrace(); } this.appView.getPluginManager().postMessage("onReceivedError", data); } /** * Notify the host application that an SSL error occurred while loading a resource. * The host application must call either handler.cancel() or handler.proceed(). * Note that the decision may be retained for use in response to future SSL errors. * The default behavior is to cancel the load. * * @param view The WebView that is initiating the callback. * @param handler An SslErrorHandler object that will handle the user's response. * @param error The SSL error object. */ @TargetApi(8) @Override public void onReceivedSslError(WebView view, SslErrorHandler handler, SslError error) { final String packageName = this.cordova.getActivity().getPackageName(); final PackageManager pm = this.cordova.getActivity().getPackageManager(); ApplicationInfo appInfo; try { appInfo = pm.getApplicationInfo(packageName, PackageManager.GET_META_DATA); if ((appInfo.flags & ApplicationInfo.FLAG_DEBUGGABLE) != 0) { // debug = true handler.proceed(); return; } else { // debug = false super.onReceivedSslError(view, handler, error); } } catch (NameNotFoundException e) { // When it doubt, lock it out! super.onReceivedSslError(view, handler, error); } } /** * Sets the authentication token. * * @param authenticationToken * @param host * @param realm */ public void setAuthenticationToken(AuthenticationToken authenticationToken, String host, String realm) { if (host == null) { host = ""; } if (realm == null) { realm = ""; } this.authenticationTokens.put(host.concat(realm), authenticationToken); } /** * Removes the authentication token. * * @param host * @param realm * * @return the authentication token or null if did not exist */ public AuthenticationToken removeAuthenticationToken(String host, String realm) { return this.authenticationTokens.remove(host.concat(realm)); } /** * Gets the authentication token. * * In order it tries: * 1- host + realm * 2- host * 3- realm * 4- no host, no realm * * @param host * @param realm * * @return the authentication token */ public AuthenticationToken getAuthenticationToken(String host, String realm) { AuthenticationToken token = null; token = this.authenticationTokens.get(host.concat(realm)); if (token == null) { // try with just the host token = this.authenticationTokens.get(host); // Try the realm if (token == null) { token = this.authenticationTokens.get(realm); } // if no host found, just query for default if (token == null) { token = this.authenticationTokens.get(""); } } return token; } /** * Clear all authentication tokens. */ public void clearAuthenticationTokens() { this.authenticationTokens.clear(); } }