blob: 9c5334fd9ebd3ffdf0ab31e69aba716bc0ecfe79 [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.
#include <bitset>
#include <iosfwd>
#include <string>
#include <vector>
#include "base/optional.h"
#include "chrome/browser/web_applications/components/web_app_constants.h"
#include "chrome/browser/web_applications/components/web_app_helpers.h"
#include "chrome/common/web_application_info.h"
#include "third_party/skia/include/core/SkColor.h"
#include "url/gurl.h"
namespace web_app {
class WebApp {
explicit WebApp(const AppId& app_id);
// 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& launch_url() const { return launch_url_; }
const GURL& scope() const { return scope_; }
const base::Optional<SkColor>& theme_color() const { return theme_color_; }
DisplayMode display_mode() const { return display_mode_; }
DisplayMode user_display_mode() const { return user_display_mode_; }
// 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_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_data| fields.
bool is_in_sync_install() const { return is_in_sync_install_; }
// 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.
const std::vector<SquareSizePx>& downloaded_icon_sizes() const {
return downloaded_icon_sizes_;
// 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_data|, random last update wins.
struct SyncData {
// Copyable and move-assignable to support Copy-on-Write with Commit.
SyncData(const SyncData& sync_data);
SyncData& operator=(SyncData&& sync_data);
std::string name;
base::Optional<SkColor> theme_color;
const SyncData& sync_data() const { return sync_data_; }
// 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 IsDefaultApp() const;
bool CanUserUninstallExternalApp() const;
bool WasInstalledByUser() const;
void SetName(const std::string& name);
void SetDescription(const std::string& description);
void SetLaunchUrl(const GURL& launch_url);
void SetScope(const GURL& scope);
void SetThemeColor(base::Optional<SkColor> theme_color);
void SetDisplayMode(DisplayMode display_mode);
void SetUserDisplayMode(DisplayMode user_display_mode);
void SetIsLocallyInstalled(bool is_locally_installed);
void SetIsInSyncInstall(bool is_in_sync_install);
void SetIconInfos(std::vector<WebApplicationIconInfo> icon_infos);
void SetDownloadedIconSizes(std::vector<SquareSizePx> sizes);
void SetSyncData(SyncData sync_data);
using Sources = std::bitset<Source::kMaxValue + 1>;
bool HasAnySpecifiedSourcesAndNoOtherSources(Sources specified_sources) const;
friend class WebAppDatabase;
friend bool operator==(const WebApp&, const WebApp&);
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 launch_url_;
// TODO(loyso): Implement IsValid() function that verifies that the launch_url
// is within the scope.
GURL scope_;
base::Optional<SkColor> theme_color_;
DisplayMode display_mode_;
DisplayMode user_display_mode_;
bool is_locally_installed_ = true;
bool is_in_sync_install_ = false;
std::vector<WebApplicationIconInfo> icon_infos_;
std::vector<SquareSizePx> downloaded_icon_sizes_;
SyncData sync_data_;
// For logging and debug purposes.
std::ostream& operator<<(std::ostream& out, const WebApp::SyncData& sync_data);
std::ostream& operator<<(std::ostream& out, const WebApp& app);
bool operator==(const WebApp::SyncData& sync_data1,
const WebApp::SyncData& sync_data2);
bool operator!=(const WebApp::SyncData& sync_data1,
const WebApp::SyncData& sync_data2);
bool operator==(const WebApp& app1, const WebApp& app2);
bool operator!=(const WebApp& app1, const WebApp& app2);
} // namespace web_app