File: profile_customization_synced_theme_waiter.h

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 (92 lines) | stat: -rw-r--r-- 3,388 bytes parent folder | download | duplicates (3)
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
// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CHROME_BROWSER_UI_PROFILES_PROFILE_CUSTOMIZATION_SYNCED_THEME_WAITER_H_
#define CHROME_BROWSER_UI_PROFILES_PROFILE_CUSTOMIZATION_SYNCED_THEME_WAITER_H_

#include "base/dcheck_is_on.h"
#include "base/functional/callback_forward.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/weak_ptr.h"
#include "base/scoped_observation.h"
#include "chrome/browser/themes/theme_service.h"
#include "chrome/browser/themes/theme_service_observer.h"
#include "chrome/browser/themes/theme_syncable_service.h"
#include "components/sync/service/sync_service.h"
#include "components/sync/service/sync_service_observer.h"

// Helper class to delay showing the profile customization until the synced
// theme is applied.
// This object is intended for one time use and must be destroyed after
// `callback` is called.
class ProfileCustomizationSyncedThemeWaiter
    : public syncer::SyncServiceObserver,
      public ThemeSyncableService::Observer,
      public ThemeServiceObserver {
 public:
  enum class Outcome {
    // Either a theme was applied (successfully or not) or there was no theme
    // stored on the sync server.
    kSyncSuccess,
    // Theme cannot be synced.
    kSyncCannotStart,
    // Sync passphrase is required.
    kSyncPassphraseRequired,
    // Theme wasn't synced within timeout.
    kTimeout,
  };

  ProfileCustomizationSyncedThemeWaiter(
      syncer::SyncService* sync_service,
      ThemeService* theme_service,
      base::OnceCallback<void(Outcome)> callback);
  ~ProfileCustomizationSyncedThemeWaiter() override;

  // Returns whether theme sync can start (i.e. is not disabled by policy,
  // theme sync is enabled, ...).
  static bool CanThemeSyncStart(syncer::SyncService* sync_service);

  // Notifies `callback_` after a synced theme has been applied or a timeout has
  // expired. Must not be called more than once.
  void Run();

  // SyncServiceObserver:
  void OnStateChanged(syncer::SyncService* sync) override;

  // ThemeSyncableService::Observer:
  void OnThemeSyncStarted(ThemeSyncableService::ThemeSyncState state) override;

  // ThemeServiceObserver:
  void OnThemeChanged() override;

 private:
  void OnTimeout();
  // Returns `false` and invokes `callback_` with a corresponding outcome if not
  // all preconditions are fulfilled to start the theme sync.
  bool CheckThemeSyncPreconditions();

  // Invokes `callback_` with `outcome` parameter. Also resets all active
  // observations. `this` may be destroyed after this call.
  void InvokeCallback(Outcome outcome);

  const raw_ptr<syncer::SyncService> sync_service_;
  const raw_ptr<ThemeService> theme_service_;
  base::OnceCallback<void(Outcome)> callback_;

#if DCHECK_IS_ON()
  bool is_running_ = false;
#endif  // DCHECK_IS_ON()

  base::ScopedObservation<syncer::SyncService, syncer::SyncServiceObserver>
      sync_observation_{this};
  base::ScopedObservation<ThemeSyncableService, ThemeSyncableService::Observer>
      theme_sync_observation_{this};
  base::ScopedObservation<ThemeService, ThemeServiceObserver>
      theme_observation_{this};

  base::WeakPtrFactory<class ProfileCustomizationSyncedThemeWaiter>
      weak_ptr_factory_{this};
};

#endif  // CHROME_BROWSER_UI_PROFILES_PROFILE_CUSTOMIZATION_SYNCED_THEME_WAITER_H_