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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
|
// 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 COMPONENTS_OFFLINE_PAGES_CORE_DOWNLOADS_DOWNLOAD_UI_ADAPTER_H_
#define COMPONENTS_OFFLINE_PAGES_CORE_DOWNLOADS_DOWNLOAD_UI_ADAPTER_H_
#include <memory>
#include <string>
#include <vector>
#include "base/memory/raw_ptr.h"
#include "base/supports_user_data.h"
#include "components/offline_items_collection/core/offline_content_aggregator.h"
#include "components/offline_items_collection/core/offline_content_provider.h"
#include "components/offline_items_collection/core/offline_item.h"
#include "components/offline_pages/core/background/request_coordinator.h"
#include "components/offline_pages/core/offline_page_model.h"
#include "components/offline_pages/core/offline_page_types.h"
#include "components/offline_pages/core/offline_page_visuals.h"
using ContentId = offline_items_collection::ContentId;
using OpenParams = offline_items_collection::OpenParams;
using OfflineContentProvider = offline_items_collection::OfflineContentProvider;
using OfflineContentAggregator =
offline_items_collection::OfflineContentAggregator;
using OfflineItem = offline_items_collection::OfflineItem;
using OfflineItemShareInfo = offline_items_collection::OfflineItemShareInfo;
using UpdateDelta = offline_items_collection::UpdateDelta;
namespace offline_pages {
class VisualsDecoder;
// C++ side of the UI Adapter. Mimics DownloadManager/Item/History (since we
// share UI with Downloads).
// An instance of this class is owned by OfflinePageModel and is shared between
// UI components if needed. It manages the cache of OfflineItems, which are fed
// to the OfflineContentAggregator which subsequently takes care of notifying
// observers of items being loaded, added, deleted etc. The creator of the
// adapter also passes in the Delegate that determines which items in the
// underlying OfflinePage backend are to be included (visible) in the
// collection.
class DownloadUIAdapter : public OfflineContentProvider,
public OfflinePageModel::Observer,
public RequestCoordinator::Observer,
public base::SupportsUserData::Data {
public:
// Delegate, used to customize behavior of this Adapter.
class Delegate {
public:
virtual ~Delegate() = default;
// Returns true if the page or request with the specified Client Id should
// be visible in the collection of items exposed by this Adapter. This also
// indicates if Observers will be notified about changes for the given page.
virtual bool IsVisibleInUI(const ClientId& client_id) = 0;
// Delegates need a reference to the UI adapter in order to notify it about
// visibility changes.
virtual void SetUIAdapter(DownloadUIAdapter* ui_adapter) = 0;
// Opens an offline item.
virtual void OpenItem(const OfflineItem& item,
int64_t offline_id,
const OpenParams& open_params) = 0;
// Share item to other apps.
virtual void GetShareInfoForItem(const ContentId& id,
ShareCallback share_callback) = 0;
};
// Create the adapter. visuals_decoder may be null, in which case,
// thumbnails and favicons will not be provided through GetVisualsForItem.
DownloadUIAdapter(OfflineContentAggregator* aggregator,
OfflinePageModel* model,
RequestCoordinator* coordinator,
std::unique_ptr<VisualsDecoder> visuals_decoder,
std::unique_ptr<Delegate> delegate);
DownloadUIAdapter(const DownloadUIAdapter&) = delete;
DownloadUIAdapter& operator=(const DownloadUIAdapter&) = delete;
~DownloadUIAdapter() override;
static DownloadUIAdapter* FromOfflinePageModel(OfflinePageModel* model);
static void AttachToOfflinePageModel(
std::unique_ptr<DownloadUIAdapter> adapter,
OfflinePageModel* model);
// OfflineContentProvider implementation.
void OpenItem(const OpenParams& open_params, const ContentId& id) override;
void RemoveItem(const ContentId& id) override;
void CancelDownload(const ContentId& id) override;
void PauseDownload(const ContentId& id) override;
void ResumeDownload(const ContentId& id) override;
void GetItemById(
const ContentId& id,
OfflineContentProvider::SingleItemCallback callback) override;
void GetAllItems(
OfflineContentProvider::MultipleItemCallback callback) override;
void GetVisualsForItem(const ContentId& id,
GetVisualsOptions options,
VisualsCallback callback) override;
void GetShareInfoForItem(const ContentId& id,
ShareCallback share_callback) override;
void RenameItem(const ContentId& id,
const std::string& name,
RenameCallback callback) override;
// OfflinePageModel::Observer
void OfflinePageModelLoaded(OfflinePageModel* model) override;
void OfflinePageAdded(OfflinePageModel* model,
const OfflinePageItem& added_page) override;
void OfflinePageDeleted(const OfflinePageItem& item) override;
void ThumbnailAdded(OfflinePageModel* model,
const int64_t offline_id,
const std::string& thumbnail) override;
// RequestCoordinator::Observer
void OnAdded(const SavePageRequest& request) override;
void OnCompleted(const SavePageRequest& request,
RequestNotifier::BackgroundSavePageResult status) override;
void OnChanged(const SavePageRequest& request) override;
void OnNetworkProgress(const SavePageRequest& request,
int64_t received_bytes) override;
Delegate* delegate() { return delegate_.get(); }
private:
using VisualResultCallback = base::OnceCallback<void(
std::unique_ptr<offline_items_collection::OfflineItemVisuals>)>;
// Task callbacks.
void PauseDownloadContinuation(
const std::string& guid,
std::vector<std::unique_ptr<SavePageRequest>> requests);
void ResumeDownloadContinuation(
const std::string& guid,
std::vector<std::unique_ptr<SavePageRequest>> requests);
void OnOfflinePagesLoaded(
OfflineContentProvider::MultipleItemCallback callback,
std::unique_ptr<OfflineContentProvider::OfflineItemList> offline_items,
const MultipleOfflinePageItemResult& pages);
void OnVisualsLoaded(GetVisualsOptions options,
VisualResultCallback callback,
std::unique_ptr<OfflinePageVisuals> visuals);
void DecodeThumbnail(std::unique_ptr<OfflinePageVisuals> visuals,
GetVisualsOptions options,
VisualResultCallback callback);
void DecodeFavicon(std::string favicon,
GetVisualsOptions options,
VisualResultCallback callback,
const gfx::Image& thumbnail);
void OnRequestsLoaded(
OfflineContentProvider::MultipleItemCallback callback,
std::unique_ptr<OfflineContentProvider::OfflineItemList> offline_items,
std::vector<std::unique_ptr<SavePageRequest>> requests);
void OnPageGetForVisuals(const ContentId& id,
GetVisualsOptions options,
VisualsCallback visuals_callback,
const std::vector<OfflinePageItem>& pages);
void OnPageGetForGetItem(const ContentId& id,
OfflineContentProvider::SingleItemCallback callback,
const std::vector<OfflinePageItem>& pages);
void OnAllRequestsGetForGetItem(
const ContentId& id,
OfflineContentProvider::SingleItemCallback callback,
std::vector<std::unique_ptr<SavePageRequest>> requests);
void OnPageGetForOpenItem(const OpenParams& open_params,
const std::vector<OfflinePageItem>& pages);
void OnPageGetForThumbnailAdded(const OfflinePageItem* page);
void OnDeletePagesDone(DeletePageResult result);
void OpenItemByGuid(const std::string& guid);
// A valid offline content aggregator, supplied at construction.
raw_ptr<OfflineContentAggregator> aggregator_;
// Always valid, this class is a member of the model.
raw_ptr<OfflinePageModel> model_;
// Always valid, a service.
raw_ptr<RequestCoordinator> request_coordinator_;
// May be null if thumbnails are not required.
std::unique_ptr<VisualsDecoder> visuals_decoder_;
// A delegate, supplied at construction.
std::unique_ptr<Delegate> delegate_;
base::WeakPtrFactory<DownloadUIAdapter> weak_ptr_factory_{this};
};
} // namespace offline_pages
#endif // COMPONENTS_OFFLINE_PAGES_CORE_DOWNLOADS_DOWNLOAD_UI_ADAPTER_H_
|
