chrome/browser/web_applications/locks/app_lock.h

// Copyright 2022 The Chromium Authors
// 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_LOCKS_APP_LOCK_H_
#define CHROME_BROWSER_WEB_APPLICATIONS_LOCKS_APP_LOCK_H_

#include <memory>

#include "base/containers/flat_set.h"
#include "base/memory/weak_ptr.h"
#include "chrome/browser/web_applications/locks/lock.h"
#include "chrome/browser/web_applications/locks/with_app_resources.h"
#include "components/webapps/common/web_app_id.h"

namespace web_app {

struct PartitionedLockHolder;
class WebAppLockManager;

// This locks the given app ID(s) in the WebAppProvider system.
//
// Locks can be acquired by using the `WebAppLockManager`.
class AppLockDescription : public LockDescription {
 public:
  explicit AppLockDescription(const webapps::AppId& app_id);
  explicit AppLockDescription(base::flat_set<webapps::AppId> app_ids);
  AppLockDescription(AppLockDescription&&);
  ~AppLockDescription();
};

// Holding this lock means that no other lock-compatible operations are touching
// the same app id/s. This does not ensure that the app/s are installed when the
// lock is granted. Checks for that will need to be handled by the user of
// the lock.
//
// See `WebAppLockManager` for how to use locks. Destruction of this class will
// release the lock or cancel the lock request if it is not acquired yet.
//
// Note: Accessing a lock will CHECK-fail if the WebAppProvider system has
// shutdown (or the profile has shut down).
class AppLock : public Lock, public WithAppResources {
 public:
  using LockDescription = AppLockDescription;

  ~AppLock();

  base::WeakPtr<AppLock> AsWeakPtr() { return weak_factory_.GetWeakPtr(); }

 private:
  friend class WebAppLockManager;
  AppLock(base::WeakPtr<WebAppLockManager> lock_manager,
          std::unique_ptr<PartitionedLockHolder> holder);

  base::WeakPtrFactory<AppLock> weak_factory_{this};
};

}  // namespace web_app

#endif  // CHROME_BROWSER_WEB_APPLICATIONS_LOCKS_APP_LOCK_H_