File: spelling_menu_observer.cc

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (581 lines) | stat: -rw-r--r-- 24,608 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
// Copyright 2014 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "chrome/browser/renderer_context_menu/spelling_menu_observer.h"

#include <utility>

#include "base/barrier_closure.h"
#include "base/command_line.h"
#include "base/functional/bind.h"
#include "base/i18n/case_conversion.h"
#include "base/strings/utf_string_conversions.h"
#include "build/build_config.h"
#include "chrome/app/chrome_command_ids.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/browser/renderer_context_menu/render_view_context_menu.h"
#include "chrome/browser/renderer_context_menu/spelling_bubble_model.h"
#include "chrome/browser/spellchecker/spellcheck_factory.h"
#include "chrome/browser/spellchecker/spellcheck_service.h"
#include "chrome/browser/ui/confirm_bubble.h"
#include "chrome/common/chrome_switches.h"
#include "chrome/common/pref_names.h"
#include "chrome/grit/generated_resources.h"
#include "components/prefs/pref_service.h"
#include "components/spellcheck/browser/pref_names.h"
#include "components/spellcheck/browser/spellcheck_host_metrics.h"
#include "components/spellcheck/browser/spellcheck_platform.h"
#include "components/spellcheck/browser/spelling_service_client.h"
#include "components/spellcheck/common/spellcheck_common.h"
#include "components/spellcheck/common/spellcheck_features.h"
#include "components/spellcheck/common/spellcheck_result.h"
#include "components/spellcheck/spellcheck_buildflags.h"
#include "content/public/browser/browser_thread.h"
#include "content/public/browser/context_menu_params.h"
#include "content/public/browser/render_view_host.h"
#include "content/public/browser/render_widget_host.h"
#include "content/public/browser/render_widget_host_view.h"
#include "content/public/browser/web_contents.h"
#include "extensions/browser/view_type_utils.h"
#include "ui/base/l10n/l10n_util.h"
#include "ui/gfx/geometry/rect.h"

using content::BrowserThread;

const int kMaxSpellingSuggestions = 3;

SpellingMenuObserver::SpellingMenuObserver(RenderViewContextMenuProxy* proxy)
    : proxy_(proxy),
      loading_frame_(0),
      succeeded_(false),
      client_(new SpellingServiceClient) {
  if (proxy_ && proxy_->GetBrowserContext()) {
    Profile* profile = Profile::FromBrowserContext(proxy_->GetBrowserContext());
    integrate_spelling_service_.Init(
        spellcheck::prefs::kSpellCheckUseSpellingService, profile->GetPrefs());
  }
}

SpellingMenuObserver::~SpellingMenuObserver() = default;

void SpellingMenuObserver::InitMenu(const content::ContextMenuParams& params) {
  DCHECK_CURRENTLY_ON(BrowserThread::UI);
  DCHECK(!params.misspelled_word.empty() ||
         params.dictionary_suggestions.empty());

  // Exit if we are not in an editable element because we add a menu item only
  // for editable elements.
  content::BrowserContext* browser_context = proxy_->GetBrowserContext();
  if (!params.is_editable || !browser_context)
    return;

  // Exit if there is no misspelled word.
  if (params.misspelled_word.empty())
    return;

  // Note that for Windows, suggestions_ will initially only contain those
  // suggestions obtained using Hunspell.
  suggestions_ = params.dictionary_suggestions;
  misspelled_word_ = params.misspelled_word;

  use_remote_suggestions_ = SpellingServiceClient::IsAvailable(
      browser_context, SpellingServiceClient::SUGGEST);

#if BUILDFLAG(IS_WIN) && BUILDFLAG(USE_BROWSER_SPELLCHECKER)
  use_platform_suggestions_ = spellcheck::UseBrowserSpellChecker();
  if (use_platform_suggestions_) {
    // Need to asynchronously retrieve suggestions from the platform
    // spellchecker, which requires the SpellcheckService.
    SpellcheckService* spellcheck_service =
        SpellcheckServiceFactory::GetForContext(browser_context);
    if (!spellcheck_service)
      return;

    // If there are no local suggestions or the spellcheck cloud service isn't
    // used, this separator will be removed later.
    proxy_->AddSeparator();

    // Append placeholders for maximum number of suggestions. Note that all but
    // the first placeholder will be made hidden in OnContextMenuShown override.
    // It can't be done here because UpdateMenuItem can only be called after
    // ToolkitDelegateViews is initialized, which happens after
    // RenderViewContextMenu::InitMenu.
    for (int i = 0;
         i < kMaxSpellingSuggestions &&
         IDC_SPELLCHECK_SUGGESTION_0 + i <= IDC_SPELLCHECK_SUGGESTION_LAST;
         ++i) {
      proxy_->AddMenuItem(IDC_SPELLCHECK_SUGGESTION_0 + i,
                          /*title=*/std::u16string());
    }

    // Completion barrier for local (and possibly remote) retrieval of
    // suggestions. Remote suggestion cannot be displayed until local
    // suggestions have been retrieved, so that duplicates can be accounted for.
    completion_barrier_ = base::BarrierClosure(
        use_remote_suggestions_ ? 2 : 1,
        base::BindOnce(&SpellingMenuObserver::OnGetSuggestionsComplete,
                       weak_ptr_factory_.GetWeakPtr()));

    // Asynchronously retrieve suggestions from the platform spellchecker.
    spellcheck_platform::GetPerLanguageSuggestions(
        spellcheck_service->platform_spell_checker(), misspelled_word_,
        base::BindOnce(&SpellingMenuObserver::OnGetPlatformSuggestionsComplete,
                       weak_ptr_factory_.GetWeakPtr()));

    if (use_remote_suggestions_) {
      // Asynchronously retrieve remote suggestions in parallel.
      GetRemoteSuggestions();
    } else {
      // Animate first suggestion placeholder while retrieving suggestions.
      loading_message_ =
          l10n_util::GetStringUTF16(IDS_CONTENT_CONTEXT_SPELLING_CHECKING);
      loading_frame_ = 0;
      animation_timer_.Start(
          FROM_HERE, base::Seconds(1),
          base::BindRepeating(&SpellingMenuObserver::OnAnimationTimerExpired,
                              weak_ptr_factory_.GetWeakPtr(),
                              IDC_SPELLCHECK_SUGGESTION_0));
    }

    // If there are no suggestions, this separator between suggestions and "Add
    // to dictionary" will be removed later.
    proxy_->AddSeparator();
  } else {
#endif  // BUILDFLAG(IS_WIN) && BUILDFLAG(USE_BROWSER_SPELLCHECKER)
    if (!suggestions_.empty() || use_remote_suggestions_)
      proxy_->AddSeparator();

    // Append Dictionary spell check suggestions.
    int length =
        std::min(kMaxSpellingSuggestions,
                 static_cast<int>(params.dictionary_suggestions.size()));
    for (int i = 0; i < length && IDC_SPELLCHECK_SUGGESTION_0 + i <=
                                      IDC_SPELLCHECK_SUGGESTION_LAST;
         ++i) {
      proxy_->AddMenuItem(IDC_SPELLCHECK_SUGGESTION_0 + i,
                          params.dictionary_suggestions[i]);
    }

    if (use_remote_suggestions_)
      GetRemoteSuggestions();

    if (!params.dictionary_suggestions.empty()) {
      // |spellcheck_service| can be null when the suggested word is
      // provided by Web SpellCheck API.
      SpellcheckService* spellcheck_service =
          SpellcheckServiceFactory::GetForContext(browser_context);
      if (spellcheck_service && spellcheck_service->GetMetrics())
        spellcheck_service->GetMetrics()->RecordSuggestionStats(1);
      proxy_->AddSeparator();
    }
#if BUILDFLAG(IS_WIN) && BUILDFLAG(USE_BROWSER_SPELLCHECKER)
  }
#endif  // BUILDFLAG(IS_WIN) && BUILDFLAG(USE_BROWSER_SPELLCHECKER)

  // If word is misspelled, give option for "Add to dictionary" and, if
  // multilingual spellchecking is not enabled, a check item "Ask Google for
  // suggestions".
  proxy_->AddMenuItem(
      IDC_SPELLCHECK_ADD_TO_DICTIONARY,
      l10n_util::GetStringUTF16(IDS_CONTENT_CONTEXT_ADD_TO_DICTIONARY));
  proxy_->AddSpellCheckServiceItem(integrate_spelling_service_.GetValue());
}

#if BUILDFLAG(IS_WIN) && BUILDFLAG(USE_BROWSER_SPELLCHECKER)
void SpellingMenuObserver::OnContextMenuShown(
    const content::ContextMenuParams& /*params*/,
    const gfx::Rect& /*bounds_in_screen*/) {
  if (!use_platform_suggestions_)
    return;

  // Disable the first place holder but keep it visible for animation if not
  // retrieving remote suggestions. Note that UpdateMenuItem does nothing if the
  // command_id is not found, e.g. if there is an early exit from InitMenu.
  proxy_->UpdateMenuItem(IDC_SPELLCHECK_SUGGESTION_0,
                         /*enabled=*/false,
                         /*hidden=*/use_remote_suggestions_, loading_message_);

  // Disable and hide the rest of the placeholders until suggestions obtained.
  for (int i = 1;
       i < kMaxSpellingSuggestions &&
       IDC_SPELLCHECK_SUGGESTION_0 + i <= IDC_SPELLCHECK_SUGGESTION_LAST;
       ++i) {
    proxy_->UpdateMenuItem(IDC_SPELLCHECK_SUGGESTION_0 + i,
                           /*enabled=*/false, /*hidden=*/true,
                           /*title=*/std::u16string());
  }
}
#endif  // BUILDFLAG(IS_WIN) && BUILDFLAG(USE_BROWSER_SPELLCHECKER)

bool SpellingMenuObserver::IsCommandIdSupported(int command_id) {
  if (command_id >= IDC_SPELLCHECK_SUGGESTION_0 &&
      command_id <= IDC_SPELLCHECK_SUGGESTION_LAST)
    return true;

  switch (command_id) {
    case IDC_SPELLCHECK_ADD_TO_DICTIONARY:
    case IDC_CONTENT_CONTEXT_NO_SPELLING_SUGGESTIONS:
    case IDC_CONTENT_CONTEXT_SPELLING_SUGGESTION:
    case IDC_CONTENT_CONTEXT_SPELLING_TOGGLE:
      return true;

    default:
      return false;
  }
}

bool SpellingMenuObserver::IsCommandIdChecked(int command_id) {
  DCHECK(IsCommandIdSupported(command_id));
  Profile* profile = Profile::FromBrowserContext(proxy_->GetBrowserContext());

  if (command_id == IDC_CONTENT_CONTEXT_SPELLING_TOGGLE)
    return integrate_spelling_service_.GetValue() &&
           !profile->IsOffTheRecord();
  return false;
}

bool SpellingMenuObserver::IsCommandIdEnabled(int command_id) {
  DCHECK(IsCommandIdSupported(command_id));

  if (command_id >= IDC_SPELLCHECK_SUGGESTION_0 &&
      command_id <= IDC_SPELLCHECK_SUGGESTION_LAST)
    return true;

  Profile* profile = Profile::FromBrowserContext(proxy_->GetBrowserContext());
  switch (command_id) {
    case IDC_SPELLCHECK_ADD_TO_DICTIONARY:
      return !misspelled_word_.empty();

    case IDC_CONTENT_CONTEXT_NO_SPELLING_SUGGESTIONS:
      return false;

    case IDC_CONTENT_CONTEXT_SPELLING_SUGGESTION:
      return succeeded_;

    case IDC_CONTENT_CONTEXT_SPELLING_TOGGLE:
      return integrate_spelling_service_.IsUserModifiable() &&
             !profile->IsOffTheRecord();

    default:
      return false;
  }
}

void SpellingMenuObserver::ExecuteCommand(int command_id) {
  DCHECK(IsCommandIdSupported(command_id));

  if (command_id >= IDC_SPELLCHECK_SUGGESTION_0 &&
      command_id <= IDC_SPELLCHECK_SUGGESTION_LAST) {
    int suggestion_index = command_id - IDC_SPELLCHECK_SUGGESTION_0;
    proxy_->GetWebContents()->ReplaceMisspelling(
        suggestions_[suggestion_index]);
    // GetSpellCheckHost() can return null when the suggested word is provided
    // by Web SpellCheck API.
    content::BrowserContext* browser_context = proxy_->GetBrowserContext();
    if (browser_context) {
      SpellcheckService* spellcheck =
          SpellcheckServiceFactory::GetForContext(browser_context);
      if (spellcheck) {
        if (spellcheck->GetMetrics())
          spellcheck->GetMetrics()->RecordReplacedWordStats(1);
      }
    }
    return;
  }

  // When we choose the suggestion sent from the Spelling service, we replace
  // the misspelled word with the suggestion and add it to our custom-word
  // dictionary so this word is not marked as misspelled any longer.
  if (command_id == IDC_CONTENT_CONTEXT_SPELLING_SUGGESTION) {
    proxy_->GetWebContents()->ReplaceMisspelling(result_);
    misspelled_word_ = result_;
  }

  if (command_id == IDC_CONTENT_CONTEXT_SPELLING_SUGGESTION ||
      command_id == IDC_SPELLCHECK_ADD_TO_DICTIONARY) {
    // GetHostForProfile() can return null when the suggested word is provided
    // by Web SpellCheck API.
    content::BrowserContext* browser_context = proxy_->GetBrowserContext();
    if (browser_context) {
      SpellcheckService* spellcheck =
          SpellcheckServiceFactory::GetForContext(browser_context);
      if (spellcheck) {
        spellcheck->GetCustomDictionary()->AddWord(base::UTF16ToUTF8(
            misspelled_word_));

#if BUILDFLAG(USE_BROWSER_SPELLCHECKER)
        if (spellcheck::UseBrowserSpellChecker()) {
          spellcheck_platform::AddWord(spellcheck->platform_spell_checker(),
                                       misspelled_word_);
        }
#endif  // BUILDFLAG(USE_BROWSER_SPELLCHECKER)
      }
    }
  }

  Profile* profile = Profile::FromBrowserContext(proxy_->GetBrowserContext());

  // The spelling service can be toggled by the user only if it is not managed.
  if (command_id == IDC_CONTENT_CONTEXT_SPELLING_TOGGLE &&
      integrate_spelling_service_.IsUserModifiable()) {
    bool spellcheckEnabled =
        profile &&
        profile->GetPrefs()->GetBoolean(spellcheck::prefs::kSpellCheckEnable);

    // When a user enables the "Use enhanced spell check" item, we check to see
    // if the user has spellcheck disabled. If the user has spellcheck disabled
    // but has already enabled the spelling service, we just enable spellcheck.
    // If spellcheck is enabled but the spelling service is not, we show a
    // bubble to confirm it. On the other hand, when a user disables this
    // item, we directly update/ the profile and stop integrating the spelling
    // service immediately.
    if (!spellcheckEnabled && integrate_spelling_service_.GetValue()) {
      if (profile) {
        profile->GetPrefs()->SetBoolean(spellcheck::prefs::kSpellCheckEnable,
                                        true);
      }
    } else if (!integrate_spelling_service_.GetValue()) {
      // We use the web contents' primary main frame here rather than getting
      // the view from the local render frame host because we want to ensure
      // that it is non-null (proxy_->GetRenderFrameHost() can return nullptr if
      // the frame goes away). In these cases, the spelling preference changes
      // are still valid (tied to the BrowsingContext / WebContents) so we still
      // want to show the confirmation bubble.
      content::RenderFrameHost* rfh =
          proxy_->GetWebContents()->GetPrimaryMainFrame();
      gfx::Rect rect = rfh->GetRenderWidgetHost()->GetView()->GetViewBounds();
      std::unique_ptr<SpellingBubbleModel> model(
          new SpellingBubbleModel(profile, proxy_->GetWebContents()));
      chrome::ShowConfirmBubble(
          proxy_->GetWebContents()->GetTopLevelNativeWindow(),
          rfh->GetRenderWidgetHost()->GetView()->GetNativeView(),
          gfx::Point(rect.CenterPoint().x(), rect.y()), std::move(model));
    } else {
      if (profile) {
        profile->GetPrefs()->SetBoolean(
            spellcheck::prefs::kSpellCheckUseSpellingService, false);
      }
    }
  }
}

#if BUILDFLAG(IS_WIN) && BUILDFLAG(USE_BROWSER_SPELLCHECKER)
void SpellingMenuObserver::OnGetPlatformSuggestionsComplete(
    const spellcheck::PerLanguageSuggestions&
        platform_per_language_suggestions) {
  // Prioritize the platform results, since presumably the first user language
  // will have a Windows language pack installed. Treat the Hunspell suggestions
  // as if a single language.
  spellcheck::PerLanguageSuggestions per_language_suggestions =
      platform_per_language_suggestions;
  per_language_suggestions.push_back(suggestions_);

  std::vector<std::u16string> combined_suggestions;
  spellcheck::FillSuggestions(per_language_suggestions, &combined_suggestions);
  // suggestions_ will now include those from both the platform spellchecker and
  // Hunspell.
  suggestions_ = combined_suggestions;

  // The menu can be updated with local suggestions without waiting for the
  // request for remote suggestions to complete.
  if (suggestions_.empty() && !use_remote_suggestions_)
    proxy_->RemoveSeparatorBeforeMenuItem(IDC_SPELLCHECK_SUGGESTION_0);

  // Update spell check suggestions displayed on the menu.
  int length =
      std::min(kMaxSpellingSuggestions, static_cast<int>(suggestions_.size()));

  for (int i = 0; i < length && IDC_SPELLCHECK_SUGGESTION_0 + i <=
                                    IDC_SPELLCHECK_SUGGESTION_LAST;
       ++i) {
    proxy_->UpdateMenuItem(IDC_SPELLCHECK_SUGGESTION_0 + i,
                           /*enabled=*/true, /*hidden=*/false, suggestions_[i]);
  }

  for (int i = suggestions_.size(); i < kMaxSpellingSuggestions; ++i) {
    // There were fewer suggestions returned than placeholder slots, remove the
    // empty menu items.
    proxy_->RemoveMenuItem(IDC_SPELLCHECK_SUGGESTION_0 + i);
  }

  if (suggestions_.empty()) {
    proxy_->RemoveSeparatorBeforeMenuItem(IDC_SPELLCHECK_ADD_TO_DICTIONARY);
  } else {
    // |spellcheck_service| can be null when the suggested word is
    // provided by Web SpellCheck API.
    SpellcheckService* spellcheck_service =
        SpellcheckServiceFactory::GetForContext(proxy_->GetBrowserContext());
    if (spellcheck_service && spellcheck_service->GetMetrics())
      spellcheck_service->GetMetrics()->RecordSuggestionStats(1);
  }

  completion_barrier_.Run();
}

void SpellingMenuObserver::OnGetSuggestionsComplete() {
  animation_timer_.Stop();

  if (use_remote_suggestions_) {
    // Update remote suggestion too using cached values from
    // OnGetRemoteSuggestionsComplete.
    UpdateRemoteSuggestion(remote_service_type_, succeeded_, remote_results_);
  }

  FireSuggestionsCompleteCallbackIfNeededForTesting();
}

void SpellingMenuObserver::RegisterSuggestionsCompleteCallbackForTesting(
    base::OnceClosure callback) {
  suggestions_complete_callback_for_testing_ = std::move(callback);
}
#endif  // BUILDFLAG(IS_WIN) && BUILDFLAG(USE_BROWSER_SPELLCHECKER)

void SpellingMenuObserver::GetRemoteSuggestions() {
  // The service types |SpellingServiceClient::SPELLCHECK| and
  // |SpellingServiceClient::SUGGEST| are mutually exclusive. Only one is
  // available at a time.
  //
  // When |SpellingServiceClient::SPELLCHECK| is available, the contextual
  // suggestions from |SpellingServiceClient| are already stored in
  // |params.dictionary_suggestions|.  |SpellingMenuObserver| places these
  // suggestions in the slots |IDC_SPELLCHECK_SUGGESTION_[0-LAST]|. If
  // |SpellingMenuObserver| queried |SpellingServiceClient| again, then
  // quality of suggestions would be reduced by lack of context around the
  // misspelled word.
  //
  // When |SpellingServiceClient::SUGGEST| is available,
  // |params.dictionary_suggestions| contains suggestions only from Hunspell
  // dictionary. |SpellingMenuObserver| queries |SpellingServiceClient| with
  // the misspelled word without the surrounding context. Spellcheck
  // suggestions from |SpellingServiceClient::SUGGEST| are not available until
  // |SpellingServiceClient| responds to the query. While
  // |SpellingMenuObserver| waits for |SpellingServiceClient|, it shows a
  // placeholder text "Loading suggestion..." in the
  // |IDC_CONTENT_CONTEXT_SPELLING_SUGGESTION| slot. After
  // |SpellingServiceClient| responds to the query, |SpellingMenuObserver|
  // replaces the placeholder text with either the spelling suggestion or the
  // message "No more suggestions from Google." The "No more suggestions"
  // message is there when |SpellingServiceClient| returned the same
  // suggestion as Hunspell.
  //
  // Append a placeholder item for the suggestion from the Spelling service
  // and send a request to the service if we can retrieve suggestions from it.
  // Also, see if we can use the spelling service to get an ideal suggestion.
  // Otherwise, we'll fall back to the set of suggestions.  Initialize
  // variables used in OnTextCheckComplete(). We copy the input text to the
  // result text so we can replace its misspelled regions with suggestions.
  succeeded_ = false;
  result_ = misspelled_word_;

  // Add a placeholder item. This item will be updated when we receive a
  // response from the Spelling service. (We do not have to disable this
  // item now since Chrome will call IsCommandIdEnabled() and disable it.)
  loading_message_ =
      l10n_util::GetStringUTF16(IDS_CONTENT_CONTEXT_SPELLING_CHECKING);
  proxy_->AddMenuItem(IDC_CONTENT_CONTEXT_SPELLING_SUGGESTION,
                      loading_message_);

  // Invoke a JSON-RPC call to the Spelling service in the background so we
  // can update the placeholder item when we receive its response. It also
  // starts the animation timer so we can show animation until we receive
  // it.
  content::BrowserContext* browser_context = proxy_->GetBrowserContext();
  if (!browser_context)
    return;
  bool result = client_->RequestTextCheck(
      browser_context, SpellingServiceClient::SUGGEST, misspelled_word_,
      base::BindOnce(&SpellingMenuObserver::OnGetRemoteSuggestionsComplete,
                     weak_ptr_factory_.GetWeakPtr(),
                     SpellingServiceClient::SUGGEST));
  if (result) {
    loading_frame_ = 0;
    animation_timer_.Start(
        FROM_HERE, base::Seconds(1),
        base::BindRepeating(&SpellingMenuObserver::OnAnimationTimerExpired,
                            weak_ptr_factory_.GetWeakPtr(),
                            IDC_CONTENT_CONTEXT_SPELLING_SUGGESTION));
  }
}

void SpellingMenuObserver::OnGetRemoteSuggestionsComplete(
    SpellingServiceClient::ServiceType type,
    bool success,
    const std::u16string& /*text*/,
    const std::vector<SpellCheckResult>& results) {
#if BUILDFLAG(IS_WIN) && BUILDFLAG(USE_BROWSER_SPELLCHECKER)
  if (use_platform_suggestions_) {
    // Cache results since we need the parallel retrieval of local suggestions
    // to also complete in order to proceed.
    remote_service_type_ = type;
    succeeded_ = success;
    // Parameter |text| is unused.
    remote_results_ = results;

    completion_barrier_.Run();
  } else {
#endif  // BUILDFLAG(IS_WIN) && BUILDFLAG(USE_BROWSER_SPELLCHECKER)
    animation_timer_.Stop();
    UpdateRemoteSuggestion(type, success, results);
#if BUILDFLAG(IS_WIN) && BUILDFLAG(USE_BROWSER_SPELLCHECKER)
  }
#endif  // BUILDFLAG(IS_WIN) && BUILDFLAG(USE_BROWSER_SPELLCHECKER)
}

void SpellingMenuObserver::UpdateRemoteSuggestion(
    SpellingServiceClient::ServiceType type,
    bool success,
    const std::vector<SpellCheckResult>& results) {
  // Scan the text-check results and replace the misspelled regions with
  // suggested words. If the replaced text is included in the suggestion list
  // provided by the local spellchecker, we show a "No suggestions from Google"
  // message.
  succeeded_ = success;
  if (results.empty()) {
    succeeded_ = false;
  } else {
    for (auto it = results.begin(); it != results.end(); ++it) {
      // If there's more than one replacement, we can't automatically apply it
      if (it->replacements.size() == 1)
        result_.replace(it->location, it->length, it->replacements[0]);
    }
    std::u16string result = base::i18n::ToLower(result_);
    for (std::vector<std::u16string>::const_iterator it = suggestions_.begin();
         it != suggestions_.end(); ++it) {
      if (result == base::i18n::ToLower(*it)) {
        succeeded_ = false;
        break;
      }
    }
  }
  if (type != SpellingServiceClient::SPELLCHECK) {
    if (!succeeded_) {
      result_ = l10n_util::GetStringUTF16(
          IDS_CONTENT_CONTEXT_SPELLING_NO_SUGGESTIONS_FROM_GOOGLE);
    }

    // Update the menu item with the result text. We disable this item and hide
    // it when the spelling service does not provide valid suggestions.
    proxy_->UpdateMenuItem(IDC_CONTENT_CONTEXT_SPELLING_SUGGESTION, succeeded_,
                           false, result_);
  }
}

#if BUILDFLAG(IS_WIN) && BUILDFLAG(USE_BROWSER_SPELLCHECKER)
void SpellingMenuObserver::FireSuggestionsCompleteCallbackIfNeededForTesting() {
  if (suggestions_complete_callback_for_testing_)
    std::move(suggestions_complete_callback_for_testing_).Run();
}
#endif  // BUILDFLAG(IS_WIN) && BUILDFLAG(USE_BROWSER_SPELLCHECKER)

void SpellingMenuObserver::OnAnimationTimerExpired(int command_id) {
  // Append '.' characters to the end of "Checking".
  loading_frame_ = (loading_frame_ + 1) & 3;
  std::u16string loading_message =
      loading_message_ + std::u16string(loading_frame_, '.');

  // Update the menu item with the text. We disable this item to prevent users
  // from selecting it.
  proxy_->UpdateMenuItem(command_id,
                         /*enabled=*/false, /*hidden=*/false, loading_message);
}