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 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294
|
// 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 COMPONENTS_DRIVE_SERVICE_DRIVE_API_SERVICE_H_
#define COMPONENTS_DRIVE_SERVICE_DRIVE_API_SERVICE_H_
#include <stdint.h>
#include <memory>
#include <string>
#include "base/memory/raw_ptr.h"
#include "base/memory/ref_counted.h"
#include "base/memory/weak_ptr.h"
#include "base/observer_list.h"
#include "base/sequence_checker.h"
#include "base/threading/thread_checker.h"
#include "components/drive/drive_export.h"
#include "components/drive/service/drive_service_interface.h"
#include "google_apis/common/auth_service_interface.h"
#include "google_apis/common/auth_service_observer.h"
#include "google_apis/drive/drive_api_url_generator.h"
#include "net/traffic_annotation/network_traffic_annotation.h"
class GURL;
namespace base {
class FilePath;
class SequencedTaskRunner;
} // namespace base
namespace google_apis {
class FilesListRequestRunner;
class RequestSender;
namespace drive {
class BatchUploadRequest;
} // namespace drive
} // namespace google_apis
namespace signin {
class IdentityManager;
}
namespace network {
class SharedURLLoaderFactory;
}
namespace drive {
// Builder for batch request returned by |DriveAPIService|.
class COMPONENTS_DRIVE_EXPORT BatchRequestConfigurator
: public BatchRequestConfiguratorInterface {
public:
BatchRequestConfigurator(
const base::WeakPtr<google_apis::drive::BatchUploadRequest>&
batch_request,
base::SequencedTaskRunner* task_runner,
const google_apis::DriveApiUrlGenerator& url_generator,
const google_apis::CancelCallbackRepeating& cancel_callback);
BatchRequestConfigurator(const BatchRequestConfigurator&) = delete;
BatchRequestConfigurator& operator=(const BatchRequestConfigurator&) = delete;
~BatchRequestConfigurator() override;
// BatchRequestConfiguratorInterface overrides.
google_apis::CancelCallbackOnce MultipartUploadNewFile(
const std::string& content_type,
std::optional<std::string_view> converted_mime_type,
int64_t content_length,
const std::string& parent_resource_id,
const std::string& title,
const base::FilePath& local_file_path,
const UploadNewFileOptions& options,
google_apis::FileResourceCallback callback,
google_apis::ProgressCallback progress_callback) override;
google_apis::CancelCallbackOnce MultipartUploadExistingFile(
const std::string& content_type,
int64_t content_length,
const std::string& resource_id,
const base::FilePath& local_file_path,
const UploadExistingFileOptions& options,
google_apis::FileResourceCallback callback,
google_apis::ProgressCallback progress_callback) override;
void Commit() override;
private:
// Reference to batch request. It turns to null after committing.
base::WeakPtr<google_apis::drive::BatchUploadRequest> batch_request_;
scoped_refptr<base::SequencedTaskRunner> task_runner_;
google_apis::DriveApiUrlGenerator url_generator_;
google_apis::CancelCallbackRepeating cancel_callback_;
SEQUENCE_CHECKER(sequence_checker_);
};
// This class provides Drive request calls using Drive V2 API.
// Details of API call are abstracted in each request class and this class
// works as a thin wrapper for the API.
class COMPONENTS_DRIVE_EXPORT DriveAPIService
: public DriveServiceInterface,
public google_apis::AuthServiceObserver {
public:
// |identity_manager| is used for interacting with the identity system.
// |url_request_context_getter| is used to initialize URLFetcher.
// |url_loader_factory| is used to create SimpleURLLoaders used to create
// OAuth tokens.
// |blocking_task_runner| is used to run blocking tasks (like parsing JSON).
// |base_url| is used to generate URLs for communication with the drive API.
// |base_thumbnail_url| is used to generate URLs for downloading thumbnail
// from image server.
// |custom_user_agent| will be used for the User-Agent header in HTTP
// requests issues through the service if the value is not empty.
// |traffic_annotation| will be used to annotate the network request that will
// be created to perform this service.
DriveAPIService(
signin::IdentityManager* identity_manager,
scoped_refptr<network::SharedURLLoaderFactory> url_loader_factory,
base::SequencedTaskRunner* blocking_task_runner,
const GURL& base_url,
const GURL& base_thumbnail_url,
const std::string& custom_user_agent,
const net::NetworkTrafficAnnotationTag& traffic_annotation);
DriveAPIService(const DriveAPIService&) = delete;
DriveAPIService& operator=(const DriveAPIService&) = delete;
~DriveAPIService() override;
// DriveServiceInterface Overrides
void Initialize(const CoreAccountId& account_id) override;
void AddObserver(DriveServiceObserver* observer) override;
void RemoveObserver(DriveServiceObserver* observer) override;
bool CanSendRequest() const override;
bool HasAccessToken() const override;
void RequestAccessToken(google_apis::AuthStatusCallback callback) override;
bool HasRefreshToken() const override;
void ClearAccessToken() override;
void ClearRefreshToken() override;
std::string GetRootResourceId() const override;
google_apis::CancelCallbackOnce GetAllTeamDriveList(
google_apis::TeamDriveListCallback callback) override;
google_apis::CancelCallbackOnce GetAllFileList(
const std::string& team_drive_id,
google_apis::FileListCallback callback) override;
google_apis::CancelCallbackOnce GetFileListInDirectory(
const std::string& directory_resource_id,
google_apis::FileListCallback callback) override;
google_apis::CancelCallbackOnce Search(
const std::string& search_query,
google_apis::FileListCallback callback) override;
google_apis::CancelCallbackOnce SearchByTitle(
const std::string& title,
const std::string& directory_resource_id,
google_apis::FileListCallback callback) override;
google_apis::CancelCallbackOnce GetChangeList(
int64_t start_changestamp,
google_apis::ChangeListCallback callback) override;
google_apis::CancelCallbackOnce GetChangeListByToken(
const std::string& team_drive_id,
const std::string& start_page_token,
google_apis::ChangeListCallback callback) override;
google_apis::CancelCallbackOnce GetRemainingTeamDriveList(
const std::string& page_token,
google_apis::TeamDriveListCallback callback) override;
google_apis::CancelCallbackOnce GetRemainingChangeList(
const GURL& next_link,
google_apis::ChangeListCallback callback) override;
google_apis::CancelCallbackOnce GetRemainingFileList(
const GURL& next_link,
google_apis::FileListCallback callback) override;
google_apis::CancelCallbackOnce GetFileResource(
const std::string& resource_id,
google_apis::FileResourceCallback callback) override;
google_apis::CancelCallbackOnce GetAboutResource(
google_apis::AboutResourceCallback callback) override;
google_apis::CancelCallbackOnce GetStartPageToken(
const std::string& team_drive_id,
google_apis::StartPageTokenCallback callback) override;
google_apis::CancelCallbackOnce DeleteResource(
const std::string& resource_id,
const std::string& etag,
google_apis::EntryActionCallback callback) override;
google_apis::CancelCallbackOnce TrashResource(
const std::string& resource_id,
google_apis::EntryActionCallback callback) override;
google_apis::CancelCallbackOnce DownloadFile(
const base::FilePath& local_cache_path,
const std::string& resource_id,
google_apis::DownloadActionCallback download_action_callback,
const google_apis::GetContentCallback& get_content_callback,
google_apis::ProgressCallback progress_callback) override;
google_apis::CancelCallbackOnce CopyResource(
const std::string& resource_id,
const std::string& parent_resource_id,
const std::string& new_title,
const base::Time& last_modified,
google_apis::FileResourceCallback callback) override;
google_apis::CancelCallbackOnce UpdateResource(
const std::string& resource_id,
const std::string& parent_resource_id,
const std::string& new_title,
const base::Time& last_modified,
const base::Time& last_viewed_by_me,
const google_apis::drive::Properties& properties,
google_apis::FileResourceCallback callback) override;
google_apis::CancelCallbackOnce AddResourceToDirectory(
const std::string& parent_resource_id,
const std::string& resource_id,
google_apis::EntryActionCallback callback) override;
google_apis::CancelCallbackOnce RemoveResourceFromDirectory(
const std::string& parent_resource_id,
const std::string& resource_id,
google_apis::EntryActionCallback callback) override;
google_apis::CancelCallbackOnce AddNewDirectory(
const std::string& parent_resource_id,
const std::string& directory_title,
const AddNewDirectoryOptions& options,
google_apis::FileResourceCallback callback) override;
google_apis::CancelCallbackOnce InitiateUploadNewFile(
const std::string& content_type,
int64_t content_length,
const std::string& parent_resource_id,
const std::string& title,
const UploadNewFileOptions& options,
google_apis::InitiateUploadCallback callback) override;
google_apis::CancelCallbackOnce InitiateUploadExistingFile(
const std::string& content_type,
int64_t content_length,
const std::string& resource_id,
const UploadExistingFileOptions& options,
google_apis::InitiateUploadCallback callback) override;
google_apis::CancelCallbackOnce ResumeUpload(
const GURL& upload_url,
int64_t start_position,
int64_t end_position,
int64_t content_length,
const std::string& content_type,
const base::FilePath& local_file_path,
google_apis::drive::UploadRangeCallback callback,
google_apis::ProgressCallback progress_callback) override;
google_apis::CancelCallbackOnce GetUploadStatus(
const GURL& upload_url,
int64_t content_length,
google_apis::drive::UploadRangeCallback callback) override;
google_apis::CancelCallbackOnce MultipartUploadNewFile(
const std::string& content_type,
std::optional<std::string_view> converted_mime_type,
int64_t content_length,
const std::string& parent_resource_id,
const std::string& title,
const base::FilePath& local_file_path,
const drive::UploadNewFileOptions& options,
google_apis::FileResourceCallback callback,
google_apis::ProgressCallback progress_callback) override;
google_apis::CancelCallbackOnce MultipartUploadExistingFile(
const std::string& content_type,
int64_t content_length,
const std::string& resource_id,
const base::FilePath& local_file_path,
const drive::UploadExistingFileOptions& options,
google_apis::FileResourceCallback callback,
google_apis::ProgressCallback progress_callback) override;
google_apis::CancelCallbackOnce AddPermission(
const std::string& resource_id,
const std::string& email,
google_apis::drive::PermissionRole role,
google_apis::EntryActionCallback callback) override;
std::unique_ptr<BatchRequestConfiguratorInterface> StartBatchRequest()
override;
private:
// AuthServiceObserver override.
void OnOAuth2RefreshTokenChanged() override;
// The class is expected to run on UI thread.
base::ThreadChecker thread_checker_;
raw_ptr<signin::IdentityManager> identity_manager_;
scoped_refptr<network::SharedURLLoaderFactory> url_loader_factory_;
scoped_refptr<base::SequencedTaskRunner> blocking_task_runner_;
std::unique_ptr<google_apis::RequestSender> sender_;
std::unique_ptr<google_apis::FilesListRequestRunner>
files_list_request_runner_;
base::ObserverList<DriveServiceObserver>::Unchecked observers_;
google_apis::DriveApiUrlGenerator url_generator_;
const std::string custom_user_agent_;
const net::NetworkTrafficAnnotationTag traffic_annotation_;
};
} // namespace drive
#endif // COMPONENTS_DRIVE_SERVICE_DRIVE_API_SERVICE_H_
|