blob: c2c4839a26d1454645e8a545d647852c5e14bc17 [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 <memory>
#include <string>
#include "base/containers/linked_list.h"
#include "base/macros.h"
#include "base/optional.h"
#include "third_party/blink/public/mojom/cookie_store/cookie_store.mojom.h"
#include "url/gurl.h"
namespace content {
namespace proto {
class CookieChangeSubscriptionProto;
} // namespace proto
// Represents a single subscription to the list of cookies sent to a URL.
// The included linked list node and service worker registration ID are used by
// CookieStoreManager.
class CookieChangeSubscription
: public base::LinkNode<CookieChangeSubscription> {
// Used to read a service worker's subscriptions from the persistent store.
static base::Optional<std::vector<CookieChangeSubscription>>
DeserializeVector(const std::string& proto_string,
int64_t service_worker_registration_id);
// Converts subscriptions from a Mojo API call.
static std::vector<CookieChangeSubscription> FromMojoVector(
std::vector<blink::mojom::CookieChangeSubscriptionPtr> mojo_subscriptions,
int64_t service_worker_registration_id);
// Used to write a service worker's subscriptions to the service worker store.
// Returns the empty string in case of a serialization error.
static std::string SerializeVector(
const std::vector<CookieChangeSubscription>&);
// Converts a service worker's subscriptions to a Mojo API call result.
static std::vector<blink::mojom::CookieChangeSubscriptionPtr> ToMojoVector(
const std::vector<CookieChangeSubscription>&);
// Public for testing.
// Production code should use the vector-based factory methods above.
static base::Optional<CookieChangeSubscription> Create(
proto::CookieChangeSubscriptionProto proto,
int64_t service_worker_registration_id);
// Public for testing.
// Production code should use the vector-based factory methods above.
CookieChangeSubscription(GURL url,
std::string name,
::network::mojom::CookieMatchType match_type,
int64_t service_worker_registration_id);
// LinkNode supports move-construction, but not move assignment.
CookieChangeSubscription& operator=(CookieChangeSubscription&&) = delete;
// The URL whose cookie list is watched for changes.
const GURL& url() const { return url_; }
// Operator for name-based matching.
// This is used to implement both equality and prefix-based name matching.
// Supporting the latter helps avoid wasting battery by waking up service
// workers unnecessarily.
::network::mojom::CookieMatchType match_type() const { return match_type_; }
// Operand for the name-based matching operator above.
// For EQUAL matching, the cookie name must precisely match name(). For
// STARTS_WITH matching, the cookie name must be prefixed by name().
const std::string& name() const { return name_; }
// The service worker registration that this subscription belongs to.
int64_t service_worker_registration_id() const {
return service_worker_registration_id_;
// Writes the subscription to the given protobuf.
void Serialize(proto::CookieChangeSubscriptionProto* proto) const;
// Writes the subscription to the given Mojo object.
void Serialize(
blink::mojom::CookieChangeSubscription* mojo_subscription) const;
// True if the subscription covers a change to the given cookie.
bool ShouldObserveChangeTo(const net::CanonicalCookie& cookie) const;
const GURL url_;
const std::string name_;
const ::network::mojom::CookieMatchType match_type_;
const int64_t service_worker_registration_id_;
} // namespace content