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

#ifndef EXTENSIONS_BROWSER_UPDATER_EXTENSION_INSTALLER_H_
#define EXTENSIONS_BROWSER_UPDATER_EXTENSION_INSTALLER_H_

#include <memory>
#include <optional>
#include <string>

#include "base/files/file_path.h"
#include "base/functional/callback.h"
#include "components/update_client/update_client.h"
#include "extensions/common/extension_id.h"

namespace extensions {

// This class is used as a shim between the components::update_client and
// extensions code, to help the generic update_client code prepare and then
// install an updated version of an extension. Because the update_client code
// doesn't have the notion of extension ids, we use instances of this class to
// map an install request back to the original update check for a given
// extension.
class ExtensionInstaller : public update_client::CrxInstaller {
 public:
  using UpdateClientCallback = update_client::CrxInstaller::Callback;
  // A callback to implement the install of a new version of the extension.
  // Takes ownership of the directory at |unpacked_dir|.
  using ExtensionInstallerCallback = base::RepeatingCallback<void(
      const ExtensionId& extension_id,
      const std::string& public_key,
      const base::FilePath& unpacked_dir,
      bool install_immediately,
      UpdateClientCallback update_client_callback)>;

  // This method takes the id and root directory for an extension we're doing
  // an update check for, as well as a callback to call if we get a new version
  // of it to install.
  ExtensionInstaller(ExtensionId extension_id,
                     const base::FilePath& extension_root,
                     bool install_immediately,
                     ExtensionInstallerCallback extension_installer_callback);

  ExtensionInstaller(const ExtensionInstaller&) = delete;
  ExtensionInstaller& operator=(const ExtensionInstaller&) = delete;

  // update_client::CrxInstaller::
  void OnUpdateError(int error) override;

  // This function is executed by the component update client, which runs on a
  // blocking thread with background priority.
  // |update_client_callback| is expected to be called on a UI thread.
  void Install(const base::FilePath& unpack_path,
               const std::string& public_key,
               std::unique_ptr<InstallParams> install_params,
               ProgressCallback progress_callback,
               UpdateClientCallback update_client_callback) override;
  std::optional<base::FilePath> GetInstalledFile(
      const std::string& file) override;
  bool Uninstall() override;

  // For unit tests.
  bool install_immediately() const { return install_immediately_; }

 private:
  friend class base::RefCountedThreadSafe<ExtensionInstaller>;
  ~ExtensionInstaller() override;

  ExtensionId extension_id_;
  base::FilePath extension_root_;
  bool install_immediately_;
  ExtensionInstallerCallback extension_installer_callback_;
};

}  // namespace extensions

#endif  // EXTENSIONS_BROWSER_UPDATER_EXTENSION_INSTALLER_H_