File: app_install_progress.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 (107 lines) | stat: -rw-r--r-- 3,905 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
// Copyright 2019 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_UPDATER_APP_APP_INSTALL_PROGRESS_H_
#define CHROME_UPDATER_APP_APP_INSTALL_PROGRESS_H_

#include <cstdint>
#include <optional>
#include <string>
#include <vector>

#include "base/notreached.h"
#include "url/gurl.h"

namespace base {
class Time;
class TimeDelta;
class Version;
}  // namespace base

// The data structures defined in this file are similar to those defined
// defined in Omaha. Keep them as they are for now for documentation purposes
// until https://crbug.com/1014630 has been fixed.
namespace updater {

enum class CompletionCodes {
  COMPLETION_CODE_SUCCESS = 1,
  COMPLETION_CODE_EXIT_SILENTLY,
  COMPLETION_CODE_ERROR = COMPLETION_CODE_SUCCESS + 2,
  COMPLETION_CODE_RESTART_ALL_BROWSERS,
  COMPLETION_CODE_REBOOT,
  COMPLETION_CODE_RESTART_BROWSER,
  COMPLETION_CODE_RESTART_ALL_BROWSERS_NOTICE_ONLY,
  COMPLETION_CODE_REBOOT_NOTICE_ONLY,
  COMPLETION_CODE_RESTART_BROWSER_NOTICE_ONLY,
  COMPLETION_CODE_LAUNCH_COMMAND,
  COMPLETION_CODE_EXIT_SILENTLY_ON_LAUNCH_COMMAND,
  COMPLETION_CODE_INSTALL_FINISHED_BEFORE_CANCEL,
};

inline bool IsCompletionCodeSuccess(CompletionCodes completion_code) {
  return completion_code != CompletionCodes::COMPLETION_CODE_ERROR;
}

struct AppCompletionInfo {
  std::string app_id;
  std::u16string display_name;
  std::u16string completion_message;
  CompletionCodes completion_code = CompletionCodes::COMPLETION_CODE_SUCCESS;
  int error_code = 0;
  int extra_code1 = 0;
  uint32_t installer_result_code = 0;
  bool is_canceled = false;
  bool is_noupdate = false;  // |noupdate| response from server.
  std::string post_install_launch_command_line;
  GURL post_install_url;

  AppCompletionInfo();
  AppCompletionInfo(const AppCompletionInfo&);
  AppCompletionInfo& operator=(const AppCompletionInfo&);
  ~AppCompletionInfo();
};

struct ObserverCompletionInfo {
  CompletionCodes completion_code = CompletionCodes::COMPLETION_CODE_SUCCESS;
  std::u16string completion_text;
  GURL help_url;
  std::vector<AppCompletionInfo> apps_info;

  ObserverCompletionInfo();
  ObserverCompletionInfo(const ObserverCompletionInfo&);
  ObserverCompletionInfo& operator=(const ObserverCompletionInfo&);
  ~ObserverCompletionInfo();
};

// Defines an interface for observing install progress. This interface is
// typically implemented by a progress window.
class AppInstallProgress {
 public:
  virtual ~AppInstallProgress() = default;
  virtual void OnCheckingForUpdate() = 0;
  virtual void OnUpdateAvailable(const std::string& app_id,
                                 const std::u16string& app_name,
                                 const base::Version& version) = 0;
  virtual void OnWaitingToDownload(const std::string& app_id,
                                   const std::u16string& app_name) = 0;
  virtual void OnDownloading(const std::string& app_id,
                             const std::u16string& app_name,
                             std::optional<base::TimeDelta> time_remaining,
                             int pos) = 0;
  virtual void OnWaitingRetryDownload(const std::string& app_id,
                                      const std::u16string& app_name,
                                      base::Time next_retry_time) = 0;
  virtual void OnWaitingToInstall(const std::string& app_id,
                                  const std::u16string& app_name) = 0;
  virtual void OnInstalling(const std::string& app_id,
                            const std::u16string& app_name,
                            std::optional<base::TimeDelta> time_remaining,
                            int pos) = 0;
  virtual void OnPause() = 0;
  virtual void OnComplete(const ObserverCompletionInfo& observer_info) = 0;
};

}  // namespace updater

#endif  // CHROME_UPDATER_APP_APP_INSTALL_PROGRESS_H_