File: pack_extension_job.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 (83 lines) | stat: -rw-r--r-- 2,986 bytes parent folder | download | duplicates (5)
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
// Copyright 2012 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_EXTENSIONS_PACK_EXTENSION_JOB_H_
#define CHROME_BROWSER_EXTENSIONS_PACK_EXTENSION_JOB_H_

#include <string>

#include "base/files/file_path.h"
#include "base/memory/raw_ptr.h"
#include "base/task/sequenced_task_runner.h"
#include "extensions/browser/extension_creator.h"
#include "extensions/buildflags/buildflags.h"

static_assert(BUILDFLAG(ENABLE_EXTENSIONS_CORE));

namespace extensions {

// Manages packing an extension on the file thread and reporting the result
// back to the UI.
// Ownership note: In "asynchronous" mode, `Client` has to make sure this
// class's instances are kept alive until OnPackSuccess|OnPackFailure is called.
// Therefore this class assumes that posting task with base::Unretained(this)
// is safe.
class PackExtensionJob {
 public:
  // Interface for people who want to use PackExtensionJob to implement.
  class Client {
   public:
    virtual void OnPackSuccess(const base::FilePath& crx_file,
                               const base::FilePath& key_file) = 0;
    virtual void OnPackFailure(const std::string& message,
                               ExtensionCreator::ErrorType error_type) = 0;

   protected:
    virtual ~Client() = default;
  };

  PackExtensionJob(Client* client,
                   const base::FilePath& root_directory,
                   const base::FilePath& key_file,
                   int run_flags);

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

  ~PackExtensionJob();

  // Starts the packing job.
  void Start();

  // The standard packing success message.
  static std::u16string StandardSuccessMessage(const base::FilePath& crx_file,
                                               const base::FilePath& key_file);

  void set_synchronous() { run_mode_ = RunMode::SYNCHRONOUS; }

 private:
  enum class RunMode { SYNCHRONOUS, ASYNCHRONOUS };

  // If `run_mode_` is SYNCHRONOUS, this is run on whichever thread calls it.
  void Run(scoped_refptr<base::SequencedTaskRunner> async_reply_task_runner);
  void ReportSuccessOnClientSequence(
      std::unique_ptr<base::FilePath> crx_file_out,
      std::unique_ptr<base::FilePath> key_file_out);
  void ReportFailureOnClientSequence(const std::string& error,
                                     ExtensionCreator::ErrorType error_type);

  const raw_ptr<Client> client_;  // Owns us.
  base::FilePath root_directory_;
  base::FilePath key_file_;
  RunMode run_mode_ = RunMode::ASYNCHRONOUS;
  int run_flags_;  // Bitset of ExtensionCreator::RunFlags values - we always
                   // assume kRequireModernManifestVersion, though.

  // Used to check methods that run on `client_`'s sequence.
  SEQUENCE_CHECKER(sequence_checker_);
};

}  // namespace extensions

#endif  // CHROME_BROWSER_EXTENSIONS_PACK_EXTENSION_JOB_H_