src/xwalk/runtime/browser/android/xwalk_content.cc

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Copyright (c) 2013 Intel Corporation. All rights reserved.
   3 // Use of this source code is governed by a BSD-style license that can be
   4 // found in the LICENSE file.
   5
   6 #include "xwalk/runtime/browser/android/xwalk_content.h"
   7
   8 #include <algorithm>
   9 #include <cctype>
  10 #include <string>
  11 #include <vector>
  12
  13 #include "base/android/jni_array.h"
  14 #include "base/android/jni_string.h"
  15 #include "base/base_paths_android.h"
  16 #include "base/json/json_reader.h"
  17 #include "base/json/json_writer.h"
  18 #include "base/path_service.h"
  19 #include "base/pickle.h"
  20 #include "content/public/browser/browser_context.h"
  21 #include "content/public/browser/browser_thread.h"
  22 #include "content/public/browser/devtools_agent_host.h"
  23 #include "content/public/browser/render_process_host.h"
  24 #include "content/public/browser/render_view_host.h"
  25 #include "content/public/browser/web_contents.h"
  26 #include "content/public/common/renderer_preferences.h"
  27 #include "content/public/common/url_constants.h"
  28 #include "components/navigation_interception/intercept_navigation_delegate.h"
  29 #include "xwalk/application/common/application_manifest_constants.h"
  30 #include "xwalk/application/common/manifest.h"
  31 #include "xwalk/runtime/browser/android/net_disk_cache_remover.h"
  32 #include "xwalk/runtime/browser/android/state_serializer.h"
  33 #include "xwalk/runtime/browser/android/xwalk_contents_client_bridge.h"
  34 #include "xwalk/runtime/browser/android/xwalk_contents_client_bridge_base.h"
  35 #include "xwalk/runtime/browser/android/xwalk_contents_io_thread_client_impl.h"
  36 #include "xwalk/runtime/browser/android/xwalk_web_contents_delegate.h"
  37 #include "xwalk/runtime/browser/runtime_context.h"
  38 #include "xwalk/runtime/browser/runtime_resource_dispatcher_host_delegate_android.h"
  39 #include "xwalk/runtime/browser/xwalk_runner.h"
  40 #include "jni/XWalkContent_jni.h"
  41
  42 using base::android::AttachCurrentThread;
  43 using base::android::ConvertUTF8ToJavaString;
  44 using base::android::ScopedJavaLocalRef;
  45 using content::BrowserThread;
  46 using content::WebContents;
  47 using navigation_interception::InterceptNavigationDelegate;
  48 using xwalk::application_manifest_keys::kDisplay;
  49
  50 namespace keys = xwalk::application_manifest_keys;
  51
  52 namespace xwalk {
  53
  54 namespace {
  55
  56 const void* kXWalkContentUserDataKey = &kXWalkContentUserDataKey;
  57
  58 class XWalkContentUserData : public base::SupportsUserData::Data {
  59  public:
  60   explicit XWalkContentUserData(XWalkContent* ptr) : content_(ptr) {}
  61
  62   static XWalkContent* GetContents(content::WebContents* web_contents) {
  63     if (!web_contents)
  64       return NULL;
  65     XWalkContentUserData* data = reinterpret_cast<XWalkContentUserData*>(
  66         web_contents->GetUserData(kXWalkContentUserDataKey));
  67     return data ? data->content_ : NULL;
  68   }
  69
  70  private:
  71   XWalkContent* content_;
  72 };
  73
  74 // FIXME(wang16): Remove following methods after deprecated fields
  75 // are not supported any more.
  76 void PrintManifestDeprecationWarning(std::string field) {
  77   LOG(WARNING) << "\"" << field << "\" is deprecated for Crosswalk. "
  78       << "Please follow "
  79       << "https://www.crosswalk-project.org/#documentation/manifest.";
  80 }
  81
  82 bool ManifestHasPath(const xwalk::application::Manifest& manifest,
  83                      const std::string& path,
  84                      const std::string& deprecated_path) {
  85   if (manifest.HasPath(path))
  86     return true;
  87   if (manifest.HasPath(deprecated_path)) {
  88     PrintManifestDeprecationWarning(deprecated_path);
  89     return true;
  90   }
  91   return false;
  92 }
  93
  94 bool ManifestGetString(const xwalk::application::Manifest& manifest,
  95                        const std::string& path,
  96                        const std::string& deprecated_path,
  97                        std::string* out_value) {
  98   if (manifest.GetString(path, out_value))
  99     return true;
 100   if (manifest.GetString(deprecated_path, out_value)) {
 101     PrintManifestDeprecationWarning(deprecated_path);
 102     return true;
 103   }
 104   return false;
 105 }
 106
 107 }  // namespace
 108
 109 XWalkContent::XWalkContent(JNIEnv* env,
 110                            jobject obj,
 111                            jobject web_contents_delegate,
 112                            jobject contents_client_bridge)
 113     : java_ref_(env, obj),
 114       web_contents_delegate_(
 115           new XWalkWebContentsDelegate(env, web_contents_delegate)),
 116       contents_client_bridge_(
 117           new XWalkContentsClientBridge(env, contents_client_bridge)) {
 118 }
 119
 120 XWalkContent::~XWalkContent() {
 121 }
 122
 123 // static
 124 XWalkContent* XWalkContent::FromID(int render_process_id,
 125                                    int render_view_id) {
 126   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
 127   const content::RenderViewHost* rvh =
 128       content::RenderViewHost::FromID(render_process_id, render_view_id);
 129   if (!rvh) return NULL;
 130   content::WebContents* web_contents =
 131       content::WebContents::FromRenderViewHost(rvh);
 132   if (!web_contents) return NULL;
 133   return FromWebContents(web_contents);
 134 }
 135
 136 // static
 137 XWalkContent* XWalkContent::FromWebContents(
 138     content::WebContents* web_contents) {
 139   return XWalkContentUserData::GetContents(web_contents);
 140 }
 141
 142 jlong XWalkContent::GetWebContents(
 143     JNIEnv* env, jobject obj, jobject io_thread_client,
 144     jobject intercept_navigation_delegate) {
 145   if (!web_contents_) {
 146     web_contents_.reset(CreateWebContents(env, io_thread_client,
 147                                           intercept_navigation_delegate));
 148
 149     render_view_host_ext_.reset(
 150         new XWalkRenderViewHostExt(web_contents_.get()));
 151   }
 152   return reinterpret_cast<intptr_t>(web_contents_.get());
 153 }
 154
 155 content::WebContents* XWalkContent::CreateWebContents(
 156     JNIEnv* env, jobject io_thread_client,
 157     jobject intercept_navigation_delegate) {
 158
 159   RuntimeContext* runtime_context =
 160       XWalkRunner::GetInstance()->runtime_context();
 161   CHECK(runtime_context);
 162
 163   content::WebContents* web_contents = content::WebContents::Create(
 164       content::WebContents::CreateParams(runtime_context));
 165
 166   web_contents->SetUserData(kXWalkContentUserDataKey,
 167                             new XWalkContentUserData(this));
 168
 169   XWalkContentsIoThreadClientImpl::RegisterPendingContents(web_contents);
 170
 171   // XWalk does not use disambiguation popup for multiple targets.
 172   content::RendererPreferences* prefs =
 173       web_contents->GetMutableRendererPrefs();
 174   prefs->tap_multiple_targets_strategy =
 175       content::TAP_MULTIPLE_TARGETS_STRATEGY_NONE;
 176
 177   XWalkContentsClientBridgeBase::Associate(web_contents,
 178       contents_client_bridge_.get());
 179   XWalkContentsIoThreadClientImpl::Associate(web_contents,
 180       ScopedJavaLocalRef<jobject>(env, io_thread_client));
 181   int render_process_id = web_contents->GetRenderProcessHost()->GetID();
 182   int render_frame_id = web_contents->GetRoutingID();
 183   RuntimeResourceDispatcherHostDelegateAndroid::OnIoThreadClientReady(
 184       render_process_id, render_frame_id);
 185   InterceptNavigationDelegate::Associate(web_contents,
 186       make_scoped_ptr(new InterceptNavigationDelegate(
 187           env, intercept_navigation_delegate)));
 188   web_contents->SetDelegate(web_contents_delegate_.get());
 189   return web_contents;
 190 }
 191
 192 void XWalkContent::ClearCache(
 193     JNIEnv* env,
 194     jobject obj,
 195     jboolean include_disk_files) {
 196   DCHECK(content::BrowserThread::CurrentlyOn(content::BrowserThread::UI));
 197   render_view_host_ext_->ClearCache();
 198
 199   if (include_disk_files) {
 200     RemoveHttpDiskCache(web_contents_->GetBrowserContext(),
 201                         web_contents_->GetRoutingID());
 202   }
 203 }
 204
 205 ScopedJavaLocalRef<jstring> XWalkContent::DevToolsAgentId(JNIEnv* env,
 206                                                           jobject obj) {
 207   scoped_refptr<content::DevToolsAgentHost> agent_host(
 208       content::DevToolsAgentHost::GetOrCreateFor(web_contents_.get()));
 209   return base::android::ConvertUTF8ToJavaString(env, agent_host->GetId());
 210 }
 211
 212 void XWalkContent::Destroy(JNIEnv* env, jobject obj) {
 213   delete this;
 214 }
 215
 216 ScopedJavaLocalRef<jstring> XWalkContent::GetVersion(JNIEnv* env,
 217                                                      jobject obj) {
 218   return base::android::ConvertUTF8ToJavaString(env, XWALK_VERSION);
 219 }
 220
 221 void XWalkContent::SetJsOnlineProperty(JNIEnv* env,
 222                                        jobject obj,
 223                                        jboolean network_up) {
 224   render_view_host_ext_->SetJsOnlineProperty(network_up);
 225 }
 226
 227 jboolean XWalkContent::SetManifest(JNIEnv* env,
 228                                    jobject obj,
 229                                    jstring path,
 230                                    jstring manifest_string) {
 231   std::string path_str = base::android::ConvertJavaStringToUTF8(env, path);
 232   std::string json_input =
 233       base::android::ConvertJavaStringToUTF8(env, manifest_string);
 234
 235   base::Value* manifest_value = base::JSONReader::Read(json_input);
 236   if (!manifest_value) return false;
 237
 238   base::DictionaryValue* manifest_dictionary;
 239   manifest_value->GetAsDictionary(&manifest_dictionary);
 240   if (!manifest_dictionary) return false;
 241
 242   scoped_ptr<base::DictionaryValue>
 243       manifest_dictionary_ptr(manifest_dictionary);
 244
 245   xwalk::application::Manifest manifest(
 246       xwalk::application::Manifest::INVALID_TYPE,
 247       manifest_dictionary_ptr.Pass());
 248
 249   std::string url;
 250   if (manifest.GetString(keys::kStartURLKey, &url)) {
 251     std::string scheme = GURL(url).scheme();
 252     if (scheme.empty())
 253       url = path_str + url;
 254   } else if (manifest.GetString(keys::kLaunchLocalPathKey, &url)) {
 255     PrintManifestDeprecationWarning(keys::kLaunchLocalPathKey);
 256     // According to original proposal for "app:launch:local_path", the "http"
 257     // and "https" schemes are supported. So |url| should do nothing when it
 258     // already has "http" or "https" scheme.
 259     std::string scheme = GURL(url).scheme();
 260     if (scheme != url::kHttpScheme && scheme != url::kHttpsScheme)
 261       url = path_str + url;
 262   } else if (manifest.GetString(keys::kLaunchWebURLKey, &url)) {
 263     PrintManifestDeprecationWarning(keys::kLaunchWebURLKey);
 264   } else {
 265     NOTIMPLEMENTED();
 266   }
 267
 268   std::string match_patterns;
 269   const base::ListValue* xwalk_hosts = NULL;
 270   if (manifest.GetList(
 271           xwalk::application_manifest_keys::kXWalkHostsKey, &xwalk_hosts)) {
 272       base::JSONWriter::Write(xwalk_hosts, &match_patterns);
 273   }
 274   render_view_host_ext_->SetOriginAccessWhitelist(url, match_patterns);
 275
 276   std::string csp;
 277   ManifestGetString(manifest, keys::kCSPKey, keys::kDeprecatedCSPKey, &csp);
 278   RuntimeContext* runtime_context =
 279       XWalkRunner::GetInstance()->runtime_context();
 280   CHECK(runtime_context);
 281   runtime_context->SetCSPString(csp);
 282
 283   ScopedJavaLocalRef<jstring> url_buffer =
 284       base::android::ConvertUTF8ToJavaString(env, url);
 285
 286   if (manifest.HasPath(kDisplay)) {
 287     std::string display_string;
 288     manifest.GetString(kDisplay, &display_string);
 289     // TODO(David): update the handling process of the display strings
 290     // including fullscreen etc.
 291     bool display_as_fullscreen = (
 292         display_string.find("fullscreen") != std::string::npos);
 293     Java_XWalkContent_onGetFullscreenFlagFromManifest(
 294         env, obj, display_as_fullscreen ? JNI_TRUE : JNI_FALSE);
 295   }
 296
 297   // Check whether need to display launch screen. (Read from manifest.json)
 298   if (ManifestHasPath(manifest,
 299                       keys::kXWalkLaunchScreen,
 300                       keys::kLaunchScreen)) {
 301     std::string ready_when;
 302     // Get the value of 'ready_when' from manifest.json
 303     ManifestGetString(manifest,
 304                       keys::kXWalkLaunchScreenReadyWhen,
 305                       keys::kLaunchScreenReadyWhen,
 306                       &ready_when);
 307     ScopedJavaLocalRef<jstring> ready_when_buffer =
 308         base::android::ConvertUTF8ToJavaString(env, ready_when);
 309
 310     // Get the value of 'image_border'
 311     // 1. When 'launch_screen.[orientation]' was defined, but no 'image_border'
 312     //    The value of 'image_border' will be set as 'empty'.
 313     // 2. Otherwise, there is no 'launch_screen.[orientation]' defined,
 314     //    The value of 'image_border' will be empty.
 315     const char empty[] = "empty";
 316     std::string image_border_default;
 317     ManifestGetString(manifest,
 318                       keys::kXWalkLaunchScreenImageBorderDefault,
 319                       keys::kLaunchScreenImageBorderDefault,
 320                       &image_border_default);
 321     if (image_border_default.empty() &&
 322         ManifestHasPath(manifest,
 323                         keys::kXWalkLaunchScreenDefault,
 324                         keys::kLaunchScreenDefault)) {
 325       image_border_default = empty;
 326     }
 327
 328     std::string image_border_landscape;
 329     ManifestGetString(manifest,
 330                       keys::kXWalkLaunchScreenImageBorderLandscape,
 331                       keys::kLaunchScreenImageBorderLandscape,
 332                       &image_border_landscape);
 333     if (image_border_landscape.empty() &&
 334         ManifestHasPath(manifest,
 335                         keys::kXWalkLaunchScreenLandscape,
 336                         keys::kLaunchScreenLandscape)) {
 337       image_border_landscape = empty;
 338     }
 339
 340     std::string image_border_portrait;
 341     ManifestGetString(manifest,
 342                       keys::kXWalkLaunchScreenImageBorderPortrait,
 343                       keys::kLaunchScreenImageBorderPortrait,
 344                       &image_border_portrait);
 345     if (image_border_portrait.empty() &&
 346         ManifestHasPath(manifest,
 347                         keys::kXWalkLaunchScreenPortrait,
 348                         keys::kLaunchScreenPortrait)) {
 349       image_border_portrait = empty;
 350     }
 351
 352     std::string image_border = image_border_default + ';' +
 353         image_border_landscape  + ';' + image_border_portrait;
 354     ScopedJavaLocalRef<jstring> image_border_buffer =
 355         base::android::ConvertUTF8ToJavaString(env, image_border);
 356
 357     Java_XWalkContent_onGetUrlAndLaunchScreenFromManifest(
 358         env, obj, url_buffer.obj(), ready_when_buffer.obj(),
 359         image_border_buffer.obj());
 360   } else {
 361     // No need to display launch screen, load the url directly.
 362     Java_XWalkContent_onGetUrlFromManifest(env, obj, url_buffer.obj());
 363   }
 364   return true;
 365 }
 366
 367 jint XWalkContent::GetRoutingID(JNIEnv* env, jobject obj) {
 368   DCHECK(web_contents_.get());
 369   return web_contents_->GetRoutingID();
 370 }
 371
 372 base::android::ScopedJavaLocalRef<jbyteArray> XWalkContent::GetState(
 373     JNIEnv* env,
 374     jobject obj) {
 375   if (!web_contents_->GetController().GetEntryCount())
 376     return ScopedJavaLocalRef<jbyteArray>();
 377
 378   Pickle pickle;
 379   if (!WriteToPickle(*web_contents_, &pickle)) {
 380     return ScopedJavaLocalRef<jbyteArray>();
 381   } else {
 382     return base::android::ToJavaByteArray(
 383         env,
 384         reinterpret_cast<const uint8*>(pickle.data()),
 385         pickle.size());
 386   }
 387 }
 388
 389 jboolean XWalkContent::SetState(JNIEnv* env, jobject obj, jbyteArray state) {
 390   std::vector<uint8> state_vector;
 391   base::android::JavaByteArrayToByteVector(env, state, &state_vector);
 392
 393   Pickle pickle(reinterpret_cast<const char*>(state_vector.begin()),
 394                 state_vector.size());
 395   PickleIterator iterator(pickle);
 396
 397   return RestoreFromPickle(&iterator, web_contents_.get());
 398 }
 399
 400 static jlong Init(JNIEnv* env, jobject obj, jobject web_contents_delegate,
 401     jobject contents_client_bridge) {
 402   XWalkContent* xwalk_core_content =
 403     new XWalkContent(env, obj, web_contents_delegate, contents_client_bridge);
 404   return reinterpret_cast<intptr_t>(xwalk_core_content);
 405 }
 406
 407 bool RegisterXWalkContent(JNIEnv* env) {
 408   return RegisterNativesImpl(env) >= 0;
 409 }
 410
 411 namespace {
 412
 413 void ShowGeolocationPromptHelperTask(
 414     const JavaObjectWeakGlobalRef& java_ref,
 415     const GURL& origin) {
 416   JNIEnv* env = AttachCurrentThread();
 417   ScopedJavaLocalRef<jobject> j_ref = java_ref.get(env);
 418   if (j_ref.obj()) {
 419     ScopedJavaLocalRef<jstring> j_origin(
 420         ConvertUTF8ToJavaString(env, origin.spec()));
 421     Java_XWalkContent_onGeolocationPermissionsShowPrompt(env,
 422                                                          j_ref.obj(),
 423                                                          j_origin.obj());
 424   }
 425 }
 426
 427 void ShowGeolocationPromptHelper(const JavaObjectWeakGlobalRef& java_ref,
 428                                  const GURL& origin) {
 429   JNIEnv* env = AttachCurrentThread();
 430   if (java_ref.get(env).obj()) {
 431     content::BrowserThread::PostTask(
 432         content::BrowserThread::UI,
 433         FROM_HERE,
 434         base::Bind(&ShowGeolocationPromptHelperTask,
 435                    java_ref,
 436                    origin));
 437   }
 438 }
 439 }  // anonymous namespace
 440
 441 void XWalkContent::ShowGeolocationPrompt(
 442     const GURL& requesting_frame,
 443     const base::Callback<void(bool)>& callback) { // NOLINT
 444   GURL origin = requesting_frame.GetOrigin();
 445   bool show_prompt = pending_geolocation_prompts_.empty();
 446   pending_geolocation_prompts_.push_back(OriginCallback(origin, callback));
 447   if (show_prompt) {
 448     ShowGeolocationPromptHelper(java_ref_, origin);
 449   }
 450 }
 451
 452 // Called by Java.
 453 void XWalkContent::InvokeGeolocationCallback(JNIEnv* env,
 454                                              jobject obj,
 455                                              jboolean value,
 456                                              jstring origin) {
 457   GURL callback_origin(base::android::ConvertJavaStringToUTF16(env, origin));
 458   if (callback_origin.GetOrigin() ==
 459       pending_geolocation_prompts_.front().first) {
 460     pending_geolocation_prompts_.front().second.Run(value);
 461     pending_geolocation_prompts_.pop_front();
 462     if (!pending_geolocation_prompts_.empty()) {
 463       ShowGeolocationPromptHelper(java_ref_,
 464                                   pending_geolocation_prompts_.front().first);
 465     }
 466   }
 467 }
 468
 469 void XWalkContent::HideGeolocationPrompt(const GURL& origin) {
 470   bool removed_current_outstanding_callback = false;
 471   std::list<OriginCallback>::iterator it = pending_geolocation_prompts_.begin();
 472   while (it != pending_geolocation_prompts_.end()) {
 473     if ((*it).first == origin.GetOrigin()) {
 474       if (it == pending_geolocation_prompts_.begin()) {
 475         removed_current_outstanding_callback = true;
 476       }
 477       it = pending_geolocation_prompts_.erase(it);
 478     } else {
 479       ++it;
 480     }
 481   }
 482
 483   if (removed_current_outstanding_callback) {
 484     JNIEnv* env = AttachCurrentThread();
 485     ScopedJavaLocalRef<jobject> j_ref = java_ref_.get(env);
 486     if (j_ref.obj()) {
 487       Java_XWalkContent_onGeolocationPermissionsHidePrompt(env, j_ref.obj());
 488     }
 489     if (!pending_geolocation_prompts_.empty()) {
 490       ShowGeolocationPromptHelper(java_ref_,
 491                             pending_geolocation_prompts_.front().first);
 492     }
 493   }
 494 }
 495 }  // namespace xwalk