summaryrefslogtreecommitdiffstats
path: root/chrome/browser/extensions/default_apps.h
blob: 767b2f3f99f68713b93a3ef07fae3e7336cff4b5 (plain)
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
// Copyright (c) 2010 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CHROME_BROWSER_EXTENSIONS_DEFAULT_APPS_H_
#define CHROME_BROWSER_EXTENSIONS_DEFAULT_APPS_H_
#pragma once

#include <set>
#include <string>
#include "chrome/common/extensions/extension.h"
#include "base/gtest_prod_util.h"

class PrefService;

// Manages the installation of the set of default apps into Chrome, and the
// promotion of those apps in the launcher.
//
// It implements the following rules:
//
// - Only install default apps once per-profile.
// - Don't install default apps if any apps are already installed.
// - Do not start showing the promo until all default apps have been installed.
// - Do not show the promo if it has been hidden by the user.
// - Do not show promo after one app has been manually installed or uninstalled.
// - Do not show promo if the set of installed apps is different than the set of
//   default apps.
// - Only show promo a certain amount of times.
//
// The promo can also be forced on with --force-apps-promo-visible.
class DefaultApps {
 public:
  // The maximum number of times to show the apps promo.
  static const int kAppsPromoCounterMax;

  // Register our preferences.
  static void RegisterUserPrefs(PrefService* prefs);

  explicit DefaultApps(PrefService* prefs);
  ~DefaultApps();

  // Gets the list of default apps that should be installed. Can return NULL if
  // no apps need to be installed.
  const ExtensionIdSet* GetAppsToInstall() const;

  // Gets the list of default apps.
  const ExtensionIdSet* GetDefaultApps() const;

  // Should be called after each app is installed. Once installed_ids contains
  // all the default apps, GetAppsToInstall() will start returning NULL.
  void DidInstallApp(const ExtensionIdSet& installed_ids);

  // Returns true if the apps promo should be displayed in the launcher. This
  // starts returning true once the default apps have all been installed and
  // stops after the promo expires.
  bool ShouldShowPromo(const ExtensionIdSet& installed_ids);

  // Should be called after each time the promo is installed.
  void DidShowPromo();

  // Force the promo to be hidden.
  void SetPromoHidden();

 private:
  FRIEND_TEST_ALL_PREFIXES(DefaultApps, Basics);
  FRIEND_TEST_ALL_PREFIXES(DefaultApps, HidePromo);
  FRIEND_TEST_ALL_PREFIXES(DefaultApps, InstallingAnAppHidesPromo);
  FRIEND_TEST_ALL_PREFIXES(DefaultApps,
                           ManualAppInstalledWhileInstallingDefaultApps);

  bool GetDefaultAppsInstalled() const;
  void SetDefaultAppsInstalled(bool val);

  int GetPromoCounter() const;
  void SetPromoCounter(int val);

  // Our permanent state is stored in this PrefService instance.
  PrefService* prefs_;

  // The set of default extensions. Initialized to a static list in the
  // constructor.
  ExtensionIdSet ids_;

  DISALLOW_COPY_AND_ASSIGN(DefaultApps);
};

#endif  // CHROME_BROWSER_EXTENSIONS_DEFAULT_APPS_H_