blob: 4acbe3c3006e94ecf8c299cff72b75334524ef3c [file] [log] [blame]
// Copyright 2018 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROME_BROWSER_WEB_APPLICATIONS_WEB_APP_H_
#define CHROME_BROWSER_WEB_APPLICATIONS_WEB_APP_H_
#include <bitset>
#include <iosfwd>
#include <string>
#include <vector>
#include "base/values.h"
#include "chrome/browser/web_applications/components/web_app_chromeos_data.h"
#include "chrome/browser/web_applications/components/web_app_constants.h"
#include "chrome/browser/web_applications/components/web_app_id.h"
#include "chrome/browser/web_applications/components/web_app_system_web_app_data.h"
#include "chrome/browser/web_applications/components/web_application_info.h"
#include "components/services/app_service/public/cpp/file_handler.h"
#include "components/services/app_service/public/cpp/protocol_handler_info.h"
#include "components/services/app_service/public/cpp/share_target.h"
#include "components/services/app_service/public/cpp/url_handler_info.h"
#include "components/sync/model/string_ordinal.h"
#include "third_party/abseil-cpp/absl/types/optional.h"
#include "third_party/skia/include/core/SkColor.h"
#include "url/gurl.h"
namespace web_app {
class WebApp {
public:
explicit WebApp(const AppId& app_id);
~WebApp();
// Copyable and move-assignable to support Copy-on-Write with Commit.
WebApp(const WebApp& web_app);
WebApp& operator=(WebApp&& web_app);
// Explicitly disallow other copy ctors and assign operators.
WebApp(WebApp&&) = delete;
WebApp& operator=(const WebApp&) = delete;
const AppId& app_id() const { return app_id_; }
// UTF8 encoded application name.
const std::string& name() const { return name_; }
// UTF8 encoded long application description (a full application name).
const std::string& description() const { return description_; }
const GURL& start_url() const { return start_url_; }
const std::string* launch_query_params() const {
return launch_query_params_ ? &launch_query_params_.value() : nullptr;
}
const GURL& scope() const { return scope_; }
const absl::optional<SkColor>& theme_color() const { return theme_color_; }
const absl::optional<SkColor>& background_color() const {
return background_color_;
}
DisplayMode display_mode() const { return display_mode_; }
DisplayMode user_display_mode() const { return user_display_mode_; }
const std::vector<DisplayMode>& display_mode_override() const {
return display_mode_override_;
}
syncer::StringOrdinal user_page_ordinal() const { return user_page_ordinal_; }
syncer::StringOrdinal user_launch_ordinal() const {
return user_launch_ordinal_;
}
const absl::optional<WebAppChromeOsData>& chromeos_data() const {
return chromeos_data_;
}
struct ClientData {
ClientData();
~ClientData();
ClientData(const ClientData& client_data);
base::Value AsDebugValue() const;
absl::optional<WebAppSystemWebAppData> system_web_app_data;
};
const ClientData& client_data() const { return client_data_; }
ClientData* client_data() { return &client_data_; }
// Locally installed apps have shortcuts installed on various UI surfaces.
// If app isn't locally installed, it is excluded from UIs and only listed as
// a part of user's app library.
bool is_locally_installed() const { return is_locally_installed_; }
// Sync-initiated installation produces a stub app awaiting for full
// installation process. The |is_in_sync_install| app has only app_id,
// launch_url and sync_fallback_data fields defined, no icons. If online
// install succeeds, icons get downloaded and all the fields get their values.
// If online install fails, we do the fallback installation to generate icons
// using |sync_fallback_data| fields.
bool is_in_sync_install() const { return is_in_sync_install_; }
// Represents whether the web app is being uninstalled.
bool is_uninstalling() const { return is_uninstalling_; }
// Represents the last time the Badging API was used.
const base::Time& last_badging_time() const { return last_badging_time_; }
// Represents the last time this app is launched.
const base::Time& last_launch_time() const { return last_launch_time_; }
// Represents the time when this app is installed.
const base::Time& install_time() const { return install_time_; }
// Represents the "icons" field in the manifest.
const std::vector<WebApplicationIconInfo>& icon_infos() const {
return icon_infos_;
}
// Represents which icon sizes we successfully downloaded from the
// |icon_infos| for the given |purpose|.
const SortedSizesPx& downloaded_icon_sizes(IconPurpose purpose) const;
// Represents whether the icons for the web app are generated by Chrome due to
// no suitable icons being available.
bool is_generated_icon() const { return is_generated_icon_; }
const apps::FileHandlers& file_handlers() const { return file_handlers_; }
bool file_handler_permission_blocked() const {
return file_handler_permission_blocked_;
}
const absl::optional<apps::ShareTarget>& share_target() const {
return share_target_;
}
const std::vector<std::string>& additional_search_terms() const {
return additional_search_terms_;
}
const std::vector<apps::ProtocolHandlerInfo>& protocol_handlers() const {
return protocol_handlers_;
}
const std::vector<std::string>& approved_launch_protocols() const {
return approved_launch_protocols_;
}
// URL within scope to launch for a "new note" action. Valid iff this is
// considered a note-taking app.
// TODO(crbug.com/1185678): Persist this in the database.
const GURL& note_taking_new_note_url() const {
return note_taking_new_note_url_;
}
const apps::UrlHandlers& url_handlers() const { return url_handlers_; }
RunOnOsLoginMode run_on_os_login_mode() const {
return run_on_os_login_mode_;
}
bool window_controls_overlay_enabled() const {
return window_controls_overlay_enabled_;
}
// While local |name| and |theme_color| may vary from device to device, the
// synced copies of these fields are replicated to all devices. The synced
// copies are read by a device to generate a placeholder icon (if needed). Any
// device may write new values to |sync_fallback_data|, random last update
// wins.
struct SyncFallbackData {
SyncFallbackData();
~SyncFallbackData();
// Copyable and move-assignable to support Copy-on-Write with Commit.
SyncFallbackData(const SyncFallbackData& sync_fallback_data);
SyncFallbackData& operator=(SyncFallbackData&& sync_fallback_data);
base::Value AsDebugValue() const;
std::string name;
absl::optional<SkColor> theme_color;
GURL scope;
std::vector<WebApplicationIconInfo> icon_infos;
};
const SyncFallbackData& sync_fallback_data() const {
return sync_fallback_data_;
}
// Represents the "shortcuts" field in the manifest.
const std::vector<WebApplicationShortcutsMenuItemInfo>&
shortcuts_menu_item_infos() const {
return shortcuts_menu_item_infos_;
}
// Represents which shortcuts menu icon sizes we successfully downloaded for
// each WebAppShortcutsMenuItemInfo.shortcuts_menu_icon_infos.
const std::vector<IconSizes>& downloaded_shortcuts_menu_icons_sizes() const {
return downloaded_shortcuts_menu_icons_sizes_;
}
blink::mojom::CaptureLinks capture_links() const { return capture_links_; }
const GURL& manifest_url() const { return manifest_url_; }
const absl::optional<std::string>& manifest_id() const {
return manifest_id_;
}
bool IsStorageIsolated() const { return is_storage_isolated_; }
// A Web App can be installed from multiple sources simultaneously. Installs
// add a source to the app. Uninstalls remove a source from the app.
void AddSource(Source::Type source);
void RemoveSource(Source::Type source);
bool HasAnySources() const;
bool HasOnlySource(Source::Type source) const;
bool IsSynced() const;
bool IsPreinstalledApp() const;
bool IsPolicyInstalledApp() const;
bool IsSystemApp() const;
bool CanUserUninstallWebApp() const;
bool WasInstalledByUser() const;
// Returns the highest priority source. AppService assumes that every app has
// just one install source.
Source::Type GetHighestPrioritySource() const;
void SetName(const std::string& name);
void SetDescription(const std::string& description);
void SetStartUrl(const GURL& start_url);
void SetLaunchQueryParams(absl::optional<std::string> launch_query_params);
void SetScope(const GURL& scope);
void SetThemeColor(absl::optional<SkColor> theme_color);
void SetBackgroundColor(absl::optional<SkColor> background_color);
void SetDisplayMode(DisplayMode display_mode);
void SetUserDisplayMode(DisplayMode user_display_mode);
void SetDisplayModeOverride(std::vector<DisplayMode> display_mode_override);
void SetUserPageOrdinal(syncer::StringOrdinal page_ordinal);
void SetUserLaunchOrdinal(syncer::StringOrdinal launch_ordinal);
void SetWebAppChromeOsData(absl::optional<WebAppChromeOsData> chromeos_data);
void SetIsLocallyInstalled(bool is_locally_installed);
void SetIsInSyncInstall(bool is_in_sync_install);
void SetIsUninstalling(bool is_uninstalling);
void SetIconInfos(std::vector<WebApplicationIconInfo> icon_infos);
// Performs sorting and uniquifying of |sizes| if passed as vector.
void SetDownloadedIconSizes(IconPurpose purpose, SortedSizesPx sizes);
void SetIsGeneratedIcon(bool is_generated_icon);
void SetShortcutsMenuItemInfos(
std::vector<WebApplicationShortcutsMenuItemInfo>
shortcuts_menu_item_infos);
void SetDownloadedShortcutsMenuIconsSizes(std::vector<IconSizes> icon_sizes);
void SetFileHandlers(apps::FileHandlers file_handlers);
void SetShareTarget(absl::optional<apps::ShareTarget> share_target);
void SetAdditionalSearchTerms(
std::vector<std::string> additional_search_terms);
void SetProtocolHandlers(
std::vector<apps::ProtocolHandlerInfo> protocol_handlers);
void SetApprovedLaunchProtocols(
std::vector<std::string> approved_launch_protocols);
void SetUrlHandlers(apps::UrlHandlers url_handlers);
void SetNoteTakingNewNoteUrl(const GURL& note_taking_new_note_url);
void SetLastBadgingTime(const base::Time& time);
void SetLastLaunchTime(const base::Time& time);
void SetInstallTime(const base::Time& time);
void SetRunOnOsLoginMode(RunOnOsLoginMode mode);
void SetSyncFallbackData(SyncFallbackData sync_fallback_data);
void SetCaptureLinks(blink::mojom::CaptureLinks capture_links);
void SetManifestUrl(const GURL& manifest_url);
void SetManifestId(const absl::optional<std::string>& manifest_id);
void SetFileHandlerPermissionBlocked(bool permission_blocked);
void SetWindowControlsOverlayEnabled(bool enabled);
void SetStorageIsolated(bool is_storage_isolated);
// For logging and debug purposes.
bool operator==(const WebApp&) const;
bool operator!=(const WebApp&) const;
base::Value AsDebugValue() const;
private:
using Sources = std::bitset<Source::kMaxValue + 1>;
bool HasAnySpecifiedSourcesAndNoOtherSources(Sources specified_sources) const;
friend class WebAppDatabase;
friend std::ostream& operator<<(std::ostream&, const WebApp&);
AppId app_id_;
// This set always contains at least one source.
Sources sources_;
std::string name_;
std::string description_;
GURL start_url_;
absl::optional<std::string> launch_query_params_;
GURL scope_;
absl::optional<SkColor> theme_color_;
absl::optional<SkColor> background_color_;
DisplayMode display_mode_;
DisplayMode user_display_mode_;
std::vector<DisplayMode> display_mode_override_;
syncer::StringOrdinal user_page_ordinal_;
syncer::StringOrdinal user_launch_ordinal_;
absl::optional<WebAppChromeOsData> chromeos_data_;
bool is_locally_installed_ = true;
bool is_in_sync_install_ = false;
// Note: This field is not persisted in the database.
// TODO(crbug.com/1162477): Add this field to the protocol buffer file and
// other places to save it to the database, and then make sure to continue
// uninstallation on startup if any web apps have this field set to true.
bool is_uninstalling_ = false;
std::vector<WebApplicationIconInfo> icon_infos_;
SortedSizesPx downloaded_icon_sizes_any_;
SortedSizesPx downloaded_icon_sizes_monochrome_;
SortedSizesPx downloaded_icon_sizes_maskable_;
bool is_generated_icon_ = false;
std::vector<WebApplicationShortcutsMenuItemInfo> shortcuts_menu_item_infos_;
std::vector<IconSizes> downloaded_shortcuts_menu_icons_sizes_;
apps::FileHandlers file_handlers_;
absl::optional<apps::ShareTarget> share_target_;
std::vector<std::string> additional_search_terms_;
std::vector<apps::ProtocolHandlerInfo> protocol_handlers_;
std::vector<std::string> approved_launch_protocols_;
apps::UrlHandlers url_handlers_;
GURL note_taking_new_note_url_;
base::Time last_badging_time_;
base::Time last_launch_time_;
base::Time install_time_;
RunOnOsLoginMode run_on_os_login_mode_ = RunOnOsLoginMode::kNotRun;
SyncFallbackData sync_fallback_data_;
blink::mojom::CaptureLinks capture_links_ =
blink::mojom::CaptureLinks::kUndefined;
ClientData client_data_;
GURL manifest_url_;
absl::optional<std::string> manifest_id_;
bool file_handler_permission_blocked_ = false;
bool window_controls_overlay_enabled_ = false;
bool is_storage_isolated_ = false;
// New fields must be added to:
// - |operator==|
// - AsDebugValue()
// - WebAppDatabase::CreateWebApp()
// - WebAppDatabase::CreateWebAppProto()
// - CreateRandomWebApp()
// - ManifestUpdateTask::IsUpdateNeededForManifest()
};
// For logging and debug purposes.
std::ostream& operator<<(std::ostream& out, const WebApp& app);
bool operator==(const WebApp::SyncFallbackData& sync_fallback_data1,
const WebApp::SyncFallbackData& sync_fallback_data2);
bool operator!=(const WebApp::SyncFallbackData& sync_fallback_data1,
const WebApp::SyncFallbackData& sync_fallback_data2);
} // namespace web_app
#endif // CHROME_BROWSER_WEB_APPLICATIONS_WEB_APP_H_