chrome/renderer/spellchecker/spellcheck_provider.cc

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #include "chrome/renderer/spellchecker/spellcheck_provider.h"
   6
   7 #include "base/command_line.h"
   8 #include "base/metrics/histogram.h"
   9 #include "chrome/common/chrome_switches.h"
  10 #include "chrome/common/spellcheck_marker.h"
  11 #include "chrome/common/spellcheck_messages.h"
  12 #include "chrome/common/spellcheck_result.h"
  13 #include "chrome/renderer/spellchecker/spellcheck.h"
  14 #include "chrome/renderer/spellchecker/spellcheck_language.h"
  15 #include "content/public/renderer/render_view.h"
  16 #include "third_party/WebKit/public/platform/WebVector.h"
  17 #include "third_party/WebKit/public/web/WebDocument.h"
  18 #include "third_party/WebKit/public/web/WebElement.h"
  19 #include "third_party/WebKit/public/web/WebFrame.h"
  20 #include "third_party/WebKit/public/web/WebTextCheckingCompletion.h"
  21 #include "third_party/WebKit/public/web/WebTextCheckingResult.h"
  22 #include "third_party/WebKit/public/web/WebTextDecorationType.h"
  23 #include "third_party/WebKit/public/web/WebView.h"
  24
  25 using blink::WebElement;
  26 using blink::WebFrame;
  27 using blink::WebString;
  28 using blink::WebTextCheckingCompletion;
  29 using blink::WebTextCheckingResult;
  30 using blink::WebTextDecorationType;
  31 using blink::WebVector;
  32
  33 static_assert(int(blink::WebTextDecorationTypeSpelling) ==
  34               int(SpellCheckResult::SPELLING), "mismatching enums");
  35 static_assert(int(blink::WebTextDecorationTypeGrammar) ==
  36               int(SpellCheckResult::GRAMMAR), "mismatching enums");
  37 static_assert(int(blink::WebTextDecorationTypeInvisibleSpellcheck) ==
  38               int(SpellCheckResult::INVISIBLE), "mismatching enums");
  39
  40 SpellCheckProvider::SpellCheckProvider(
  41     content::RenderView* render_view,
  42     SpellCheck* spellcheck)
  43     : content::RenderViewObserver(render_view),
  44       content::RenderViewObserverTracker<SpellCheckProvider>(render_view),
  45       spelling_panel_visible_(false),
  46       spellcheck_(spellcheck) {
  47   DCHECK(spellcheck_);
  48   if (render_view) {  // NULL in unit tests.
  49     render_view->GetWebView()->setSpellCheckClient(this);
  50     EnableSpellcheck(spellcheck_->IsSpellcheckEnabled());
  51   }
  52 }
  53
  54 SpellCheckProvider::~SpellCheckProvider() {
  55 }
  56
  57 void SpellCheckProvider::RequestTextChecking(
  58     const base::string16& text,
  59     WebTextCheckingCompletion* completion,
  60     const std::vector<SpellCheckMarker>& markers) {
  61   // Ignore invalid requests.
  62   if (text.empty() || !HasWordCharacters(text, 0)) {
  63     completion->didCancelCheckingText();
  64     return;
  65   }
  66
  67   // Try to satisfy check from cache.
  68   if (SatisfyRequestFromCache(text, completion))
  69     return;
  70
  71   // Send this text to a browser. A browser checks the user profile and send
  72   // this text to the Spelling service only if a user enables this feature.
  73   last_request_.clear();
  74   last_results_.assign(blink::WebVector<blink::WebTextCheckingResult>());
  75
  76 #if defined(USE_BROWSER_SPELLCHECKER)
  77   // Text check (unified request for grammar and spell check) is only
  78   // available for browser process, so we ask the system spellchecker
  79   // over IPC or return an empty result if the checker is not
  80   // available.
  81   Send(new SpellCheckHostMsg_RequestTextCheck(
  82       routing_id(),
  83       text_check_completions_.Add(completion),
  84       text,
  85       markers));
  86 #else
  87   Send(new SpellCheckHostMsg_CallSpellingService(
  88       routing_id(),
  89       text_check_completions_.Add(completion),
  90       base::string16(text),
  91       markers));
  92 #endif  // !USE_BROWSER_SPELLCHECKER
  93 }
  94
  95 bool SpellCheckProvider::OnMessageReceived(const IPC::Message& message) {
  96   bool handled = true;
  97   IPC_BEGIN_MESSAGE_MAP(SpellCheckProvider, message)
  98 #if !defined(USE_BROWSER_SPELLCHECKER)
  99     IPC_MESSAGE_HANDLER(SpellCheckMsg_RespondSpellingService,
 100                         OnRespondSpellingService)
 101 #endif
 102 #if defined(USE_BROWSER_SPELLCHECKER)
 103     IPC_MESSAGE_HANDLER(SpellCheckMsg_AdvanceToNextMisspelling,
 104                         OnAdvanceToNextMisspelling)
 105     IPC_MESSAGE_HANDLER(SpellCheckMsg_RespondTextCheck, OnRespondTextCheck)
 106     IPC_MESSAGE_HANDLER(SpellCheckMsg_ToggleSpellPanel, OnToggleSpellPanel)
 107 #endif
 108     IPC_MESSAGE_UNHANDLED(handled = false)
 109   IPC_END_MESSAGE_MAP()
 110   return handled;
 111 }
 112
 113 void SpellCheckProvider::FocusedNodeChanged(const blink::WebNode& unused) {
 114 #if defined(USE_BROWSER_SPELLCHECKER)
 115   WebFrame* frame = render_view()->GetWebView()->focusedFrame();
 116   WebElement element = frame->document().isNull() ? WebElement() :
 117       frame->document().focusedElement();
 118   bool enabled = !element.isNull() && element.isEditable();
 119   bool checked = enabled && frame->isContinuousSpellCheckingEnabled();
 120
 121   Send(new SpellCheckHostMsg_ToggleSpellCheck(routing_id(), enabled, checked));
 122 #endif  // USE_BROWSER_SPELLCHECKER
 123 }
 124
 125 void SpellCheckProvider::spellCheck(
 126     const WebString& text,
 127     int& offset,
 128     int& length,
 129     WebVector<WebString>* optional_suggestions) {
 130   base::string16 word(text);
 131   std::vector<base::string16> suggestions;
 132   const int kWordStart = 0;
 133   spellcheck_->SpellCheckWord(
 134       word.c_str(), kWordStart, word.size(), routing_id(),
 135       &offset, &length, optional_suggestions ? & suggestions : NULL);
 136   if (optional_suggestions) {
 137     *optional_suggestions = suggestions;
 138     UMA_HISTOGRAM_COUNTS("SpellCheck.api.check.suggestions", word.size());
 139   } else {
 140     UMA_HISTOGRAM_COUNTS("SpellCheck.api.check", word.size());
 141     // If optional_suggestions is not requested, the API is called
 142     // for marking.  So we use this for counting markable words.
 143     Send(new SpellCheckHostMsg_NotifyChecked(routing_id(), word, 0 < length));
 144   }
 145 }
 146
 147 void SpellCheckProvider::checkTextOfParagraph(
 148     const blink::WebString& text,
 149     blink::WebTextCheckingTypeMask mask,
 150     blink::WebVector<blink::WebTextCheckingResult>* results) {
 151   if (!results)
 152     return;
 153
 154   if (!(mask & blink::WebTextCheckingTypeSpelling))
 155     return;
 156
 157   // TODO(groby): As far as I can tell, this method is never invoked.
 158   // UMA results seem to support that. Investigate, clean up if true.
 159   NOTREACHED();
 160   spellcheck_->SpellCheckParagraph(text, results);
 161   UMA_HISTOGRAM_COUNTS("SpellCheck.api.paragraph", text.length());
 162 }
 163
 164 void SpellCheckProvider::requestCheckingOfText(
 165     const WebString& text,
 166     const WebVector<uint32>& markers,
 167     const WebVector<unsigned>& marker_offsets,
 168     WebTextCheckingCompletion* completion) {
 169   std::vector<SpellCheckMarker> spellcheck_markers;
 170   for (size_t i = 0; i < markers.size(); ++i) {
 171     spellcheck_markers.push_back(
 172         SpellCheckMarker(markers[i], marker_offsets[i]));
 173   }
 174   RequestTextChecking(text, completion, spellcheck_markers);
 175   UMA_HISTOGRAM_COUNTS("SpellCheck.api.async", text.length());
 176 }
 177
 178 WebString SpellCheckProvider::autoCorrectWord(const WebString& word) {
 179   const base::CommandLine& command_line =
 180       *base::CommandLine::ForCurrentProcess();
 181   if (command_line.HasSwitch(switches::kEnableSpellingAutoCorrect)) {
 182     UMA_HISTOGRAM_COUNTS("SpellCheck.api.autocorrect", word.length());
 183     return spellcheck_->GetAutoCorrectionWord(word, routing_id());
 184   }
 185   return base::string16();
 186 }
 187
 188 void SpellCheckProvider::showSpellingUI(bool show) {
 189 #if defined(USE_BROWSER_SPELLCHECKER)
 190   UMA_HISTOGRAM_BOOLEAN("SpellCheck.api.showUI", show);
 191   Send(new SpellCheckHostMsg_ShowSpellingPanel(routing_id(), show));
 192 #endif
 193 }
 194
 195 bool SpellCheckProvider::isShowingSpellingUI() {
 196   return spelling_panel_visible_;
 197 }
 198
 199 void SpellCheckProvider::updateSpellingUIWithMisspelledWord(
 200     const WebString& word) {
 201 #if defined(USE_BROWSER_SPELLCHECKER)
 202   Send(new SpellCheckHostMsg_UpdateSpellingPanelWithMisspelledWord(routing_id(),
 203                                                                    word));
 204 #endif
 205 }
 206
 207 #if !defined(USE_BROWSER_SPELLCHECKER)
 208 void SpellCheckProvider::OnRespondSpellingService(
 209     int identifier,
 210     bool succeeded,
 211     const base::string16& line,
 212     const std::vector<SpellCheckResult>& results) {
 213   WebTextCheckingCompletion* completion =
 214       text_check_completions_.Lookup(identifier);
 215   if (!completion)
 216     return;
 217   text_check_completions_.Remove(identifier);
 218
 219   // If |succeeded| is false, we use local spellcheck as a fallback.
 220   if (!succeeded) {
 221     spellcheck_->RequestTextChecking(line, completion);
 222     return;
 223   }
 224
 225   // Double-check the returned spellchecking results with our spellchecker to
 226   // visualize the differences between ours and the on-line spellchecker.
 227   blink::WebVector<blink::WebTextCheckingResult> textcheck_results;
 228   spellcheck_->CreateTextCheckingResults(SpellCheck::USE_NATIVE_CHECKER,
 229                                          0,
 230                                          line,
 231                                          results,
 232                                          &textcheck_results);
 233   completion->didFinishCheckingText(textcheck_results);
 234
 235   // Cache the request and the converted results.
 236   last_request_ = line;
 237   last_results_.swap(textcheck_results);
 238 }
 239 #endif
 240
 241 bool SpellCheckProvider::HasWordCharacters(
 242     const base::string16& text,
 243     int index) const {
 244   const base::char16* data = text.data();
 245   int length = text.length();
 246   while (index < length) {
 247     uint32 code = 0;
 248     U16_NEXT(data, index, length, code);
 249     UErrorCode error = U_ZERO_ERROR;
 250     if (uscript_getScript(code, &error) != USCRIPT_COMMON)
 251       return true;
 252   }
 253   return false;
 254 }
 255
 256 #if defined(USE_BROWSER_SPELLCHECKER)
 257 void SpellCheckProvider::OnAdvanceToNextMisspelling() {
 258   if (!render_view()->GetWebView())
 259     return;
 260   render_view()->GetWebView()->focusedFrame()->executeCommand(
 261       WebString::fromUTF8("AdvanceToNextMisspelling"));
 262 }
 263
 264 void SpellCheckProvider::OnRespondTextCheck(
 265     int identifier,
 266     const base::string16& line,
 267     const std::vector<SpellCheckResult>& results) {
 268   // TODO(groby): Unify with SpellCheckProvider::OnRespondSpellingService
 269   DCHECK(spellcheck_);
 270   WebTextCheckingCompletion* completion =
 271       text_check_completions_.Lookup(identifier);
 272   if (!completion)
 273     return;
 274   text_check_completions_.Remove(identifier);
 275   blink::WebVector<blink::WebTextCheckingResult> textcheck_results;
 276   spellcheck_->CreateTextCheckingResults(SpellCheck::DO_NOT_MODIFY,
 277                                          0,
 278                                          line,
 279                                          results,
 280                                          &textcheck_results);
 281   completion->didFinishCheckingText(textcheck_results);
 282
 283   // TODO(groby): Add request caching once OSX reports back original request.
 284   // (cf. SpellCheckProvider::OnRespondSpellingService)
 285   // Cache the request and the converted results.
 286 }
 287
 288 void SpellCheckProvider::OnToggleSpellPanel(bool is_currently_visible) {
 289   if (!render_view()->GetWebView())
 290     return;
 291   // We need to tell the webView whether the spelling panel is visible or not so
 292   // that it won't need to make ipc calls later.
 293   spelling_panel_visible_ = is_currently_visible;
 294   render_view()->GetWebView()->focusedFrame()->executeCommand(
 295       WebString::fromUTF8("ToggleSpellPanel"));
 296 }
 297 #endif
 298
 299 void SpellCheckProvider::EnableSpellcheck(bool enable) {
 300   if (!render_view()->GetWebView())
 301     return;
 302
 303   WebFrame* frame = render_view()->GetWebView()->focusedFrame();
 304   frame->enableContinuousSpellChecking(enable);
 305   if (!enable)
 306     frame->removeSpellingMarkers();
 307 }
 308
 309 bool SpellCheckProvider::SatisfyRequestFromCache(
 310     const base::string16& text,
 311     WebTextCheckingCompletion* completion) {
 312   size_t last_length = last_request_.length();
 313
 314   // Send back the |last_results_| if the |last_request_| is a substring of
 315   // |text| and |text| does not have more words to check. Provider cannot cancel
 316   // the spellcheck request here, because WebKit might have discarded the
 317   // previous spellcheck results and erased the spelling markers in response to
 318   // the user editing the text.
 319   base::string16 request(text);
 320   size_t text_length = request.length();
 321   if (text_length >= last_length &&
 322       !request.compare(0, last_length, last_request_)) {
 323     if (text_length == last_length || !HasWordCharacters(text, last_length)) {
 324       completion->didFinishCheckingText(last_results_);
 325       return true;
 326     }
 327     int code = 0;
 328     int length = static_cast<int>(text_length);
 329     U16_PREV(text.data(), 0, length, code);
 330     UErrorCode error = U_ZERO_ERROR;
 331     if (uscript_getScript(code, &error) != USCRIPT_COMMON) {
 332       completion->didCancelCheckingText();
 333       return true;
 334     }
 335   }
 336   // Create a subset of the cached results and return it if the given text is a
 337   // substring of the cached text.
 338   if (text_length < last_length &&
 339       !last_request_.compare(0, text_length, request)) {
 340     size_t result_size = 0;
 341     for (size_t i = 0; i < last_results_.size(); ++i) {
 342       size_t start = last_results_[i].location;
 343       size_t end = start + last_results_[i].length;
 344       if (start <= text_length && end <= text_length)
 345         ++result_size;
 346     }
 347     if (result_size > 0) {
 348       blink::WebVector<blink::WebTextCheckingResult> results(result_size);
 349       for (size_t i = 0; i < result_size; ++i) {
 350         results[i].decoration = last_results_[i].decoration;
 351         results[i].location = last_results_[i].location;
 352         results[i].length = last_results_[i].length;
 353         results[i].replacement = last_results_[i].replacement;
 354       }
 355       completion->didFinishCheckingText(results);
 356       return true;
 357     }
 358   }
 359
 360   return false;
 361 }