File: peripherals_app_delegate_impl.cc

package info (click to toggle)
chromium 138.0.7204.183-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 6,080,960 kB
  • sloc: cpp: 34,937,079; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,954; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,811; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (176 lines) | stat: -rw-r--r-- 6,707 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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "chrome/browser/ash/input_device_settings/peripherals_app_delegate_impl.h"

#include "ash/constants/ash_features.h"
#include "ash/system/input_device_settings/input_device_settings_metadata.h"
#include "chrome/browser/apps/almanac_api_client/almanac_api_util.h"
#include "chrome/browser/apps/almanac_api_client/almanac_app_icon_loader.h"
#include "chrome/browser/apps/almanac_api_client/proto/client_context.pb.h"
#include "chrome/browser/apps/app_service/app_install/app_install_types.h"
#include "chrome/browser/apps/app_service/package_id_util.h"
#include "chrome/browser/apps/peripherals/proto/peripherals.pb.h"
#include "chrome/browser/profiles/profile_manager.h"
#include "components/services/app_service/public/cpp/package_id.h"
#include "components/version_info/version_info.h"
#include "google_apis/google_api_keys.h"
#include "services/network/public/cpp/shared_url_loader_factory.h"
#include "services/network/public/cpp/simple_url_loader.h"
#include "ui/base/webui/web_ui_util.h"

namespace ash {

namespace {

// Endpoint for requesting peripherals app info on the ChromeOS Almanac API.
constexpr char kPeripheralsAlmanacEndpoint[] = "v1/peripherals";

// Maximum size of peripherals response is 1MB.
constexpr int kMaxResponseSizeInBytes = 1024 * 1024;

// Description of the network request.
constexpr net::NetworkTrafficAnnotationTag kTrafficAnnotation =
    net::DefineNetworkTrafficAnnotation("peripherals_companion_app", R"(
      semantics {
        sender: "Input Device Settings"
        description:
          "Retrieves companion app information for supported devices. Given a "
          "device key, Google's servers will return the app information (name, "
          "icon, etc) and an action link that will be used to trigger the app "
          "installation dialog."
        trigger:
          "A request is sent when the user initiates the install in the "
          "Settings app."
        data:
          "A device_key in the format <vid>:<pid> "
          "(where VID = vendor ID and PID = product ID) is "
          "used to specify the device image to fetch."
        destination: GOOGLE_OWNED_SERVICE
        internal {
          contacts {
              email: "cros-device-enablement@google.com"
          }
        }
        user_data {
          type: DEVICE_ID
        }
        last_reviewed: "2024-06-21"
      }
      policy {
        cookies_allowed: NO
        setting: "This feature cannot be disabled by settings."
        policy_exception_justification:
          "This feature is required to deliver core user experiences and "
          "cannot be disabled by policy."
      }
    )");

}  // namespace

PeripheralsAppDelegateImpl::PeripheralsAppDelegateImpl() = default;
PeripheralsAppDelegateImpl::~PeripheralsAppDelegateImpl() = default;

void PeripheralsAppDelegateImpl::GetCompanionAppInfo(
    const std::string& device_key,
    GetCompanionAppInfoCallback callback) {
  // Ensure that the build uses the Google-internal file containing the
  // official API keys, which are required to make queries to the Almanac.
  if (!google_apis::IsGoogleChromeAPIKeyUsed() && !is_testing_) {
    LOG(ERROR) << "Invalid API key or missing internal file. Cannot make "
                  "queries to Almanac. Device key: "
               << device_key;
    return;
  }

  Profile* active_user_profile = GetActiveUserProfile();

  apps::proto::PeripheralsGetRequest request;
  request.set_device(GetDeviceKeyForMetadataRequest(device_key));

  QueryAlmanacApiWithContext<apps::proto::PeripheralsGetRequest,
                             apps::proto::PeripheralsGetResponse>(
      active_user_profile, kPeripheralsAlmanacEndpoint, request,
      kTrafficAnnotation, kMaxResponseSizeInBytes,
      /*error_histogram_name=*/std::nullopt,
      base::BindOnce(
          &PeripheralsAppDelegateImpl::ConvertPeripheralsResponseProto,
          weak_factory_.GetWeakPtr(), active_user_profile->GetWeakPtr(),
          std::move(callback)));
}

void PeripheralsAppDelegateImpl::ConvertPeripheralsResponseProto(
    base::WeakPtr<Profile> active_user_profile_weak_ptr,
    GetCompanionAppInfoCallback callback,
    base::expected<apps::proto::PeripheralsGetResponse, apps::QueryError>
        query_response) {
  Profile* profile = active_user_profile_weak_ptr.get();
  if (!profile) {
    std::move(callback).Run(std::nullopt);
    return;
  }

  if (!query_response.has_value()) {
    std::move(callback).Run(std::nullopt);
    return;
  }

  const auto& response = query_response.value();
  auto package_id = apps::PackageId::FromString(response.package_id());
  if (!package_id.has_value()) {
    std::move(callback).Run(std::nullopt);
    return;
  }

  mojom::CompanionAppInfo info;
  info.action_link = response.action_link();
  info.app_name = response.name();
  info.package_id = package_id.value().ToString();
  info.state =
      apps_util::GetAppWithPackageId(&*profile, package_id.value()).has_value()
          ? mojom::CompanionAppState::kInstalled
          : mojom::CompanionAppState::kAvailable;

  icon_loader_ = std::make_unique<apps::AlmanacAppIconLoader>(*profile);
  auto icon = response.icon();
  apps::AppInstallIcon app_install_icon{
      .url = GURL(icon.url()),
      .width_in_pixels = icon.width_in_pixels(),
      .mime_type = icon.mime_type(),
      .is_masking_allowed = icon.is_masking_allowed()};
  // Callback execution is not critical if object is deleted before icon load.
  // This should rarely occur as the InputDeviceSettingsController, the primary
  // user of this delegate, is initialized in shell and typically persistent.
  icon_loader_->GetAppIcon(
      app_install_icon.url, app_install_icon.mime_type,
      app_install_icon.is_masking_allowed,
      base::BindOnce(&PeripheralsAppDelegateImpl::OnAppIconLoaded,
                     weak_factory_.GetWeakPtr(), std::move(callback),
                     std::move(info)));
}

void PeripheralsAppDelegateImpl::OnAppIconLoaded(
    GetCompanionAppInfoCallback callback,
    mojom::CompanionAppInfo info,
    apps::IconValuePtr icon_value) {
  icon_loader_.reset();
  if (icon_value) {
    info.icon_url = webui::GetBitmapDataUrl(*icon_value->uncompressed.bitmap());
  }
  std::move(callback).Run(info);
}

Profile* PeripheralsAppDelegateImpl::GetActiveUserProfile() {
  if (is_testing_) {
    return profile_for_testing_;
  }

  return ProfileManager::GetActiveUserProfile();
}

GURL PeripheralsAppDelegateImpl::GetServerUrl() {
  return apps::GetAlmanacEndpointUrl(kPeripheralsAlmanacEndpoint);
}

}  // namespace ash