content/public/browser/shared_worker_instance.h

// Copyright 2014 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 CONTENT_PUBLIC_BROWSER_SHARED_WORKER_INSTANCE_H_
#define CONTENT_PUBLIC_BROWSER_SHARED_WORKER_INSTANCE_H_

#include <string>

#include "content/common/content_export.h"
#include "services/network/public/mojom/content_security_policy.mojom.h"
#include "services/network/public/mojom/fetch_api.mojom.h"
#include "services/network/public/mojom/ip_address_space.mojom.h"
#include "third_party/blink/public/mojom/script/script_type.mojom.h"
#include "third_party/blink/public/mojom/worker/shared_worker_creation_context_type.mojom.h"
#include "url/gurl.h"
#include "url/origin.h"

namespace content {

// SharedWorkerInstance is the browser-side representation of one instance of a
// shared worker.
class CONTENT_EXPORT SharedWorkerInstance {
 public:
  SharedWorkerInstance(
      int64_t id,
      const GURL& url,
      blink::mojom::ScriptType script_type,
      network::mojom::CredentialsMode credentials_mode,
      const std::string& name,
      const url::Origin& constructor_origin,
      const std::string& content_security_policy,
      network::mojom::ContentSecurityPolicyType content_security_policy_type,
      network::mojom::IPAddressSpace creation_address_space,
      blink::mojom::SharedWorkerCreationContextType creation_context_type);
  SharedWorkerInstance(const SharedWorkerInstance& other);
  SharedWorkerInstance(SharedWorkerInstance&& other);
  SharedWorkerInstance& operator=(const SharedWorkerInstance& other);
  SharedWorkerInstance& operator=(SharedWorkerInstance&& other);
  ~SharedWorkerInstance();

  // Checks if this SharedWorkerInstance matches the passed url, name, and
  // constructor origin params according to the SharedWorker constructor steps
  // in the HTML spec:
  // https://html.spec.whatwg.org/multipage/workers.html#shared-workers-and-the-sharedworker-interface
  bool Matches(const GURL& url,
               const std::string& name,
               const url::Origin& constructor_origin) const;

  // Accessors.
  const GURL& url() const { return url_; }
  const std::string& name() const { return name_; }
  blink::mojom::ScriptType script_type() const { return script_type_; }
  network::mojom::CredentialsMode credentials_mode() const {
    return credentials_mode_;
  }
  const url::Origin& constructor_origin() const { return constructor_origin_; }
  const std::string& content_security_policy() const {
    return content_security_policy_;
  }
  network::mojom::ContentSecurityPolicyType content_security_policy_type()
      const {
    return content_security_policy_type_;
  }
  network::mojom::IPAddressSpace creation_address_space() const {
    return creation_address_space_;
  }
  blink::mojom::SharedWorkerCreationContextType creation_context_type() const {
    return creation_context_type_;
  }

 private:
  // Compares SharedWorkerInstances using the |id_|.
  CONTENT_EXPORT friend bool operator<(const SharedWorkerInstance& lhs,
                                       const SharedWorkerInstance& rhs);

  // An internal ID that is unique within a storage partition. It is needed to
  // differentiate 2 SharedWorkerInstance that have the same url, name and
  // constructor origin but actually represent different workers. This is
  // possible with a file: |url| or |constructor_origin| since they are treated
  // as opaque in this class.
  int64_t id_;

  GURL url_;
  blink::mojom::ScriptType script_type_;

  // Used for fetching the top-level worker script.
  network::mojom::CredentialsMode credentials_mode_;

  std::string name_;

  // The origin of the document that created this shared worker instance. Used
  // for security checks. See Matches() for details.
  // https://html.spec.whatwg.org/multipage/workers.html#concept-sharedworkerglobalscope-constructor-origin
  url::Origin constructor_origin_;

  std::string content_security_policy_;
  network::mojom::ContentSecurityPolicyType content_security_policy_type_;
  network::mojom::IPAddressSpace creation_address_space_;
  blink::mojom::SharedWorkerCreationContextType creation_context_type_;
};

}  // namespace content

#endif  // CONTENT_PUBLIC_BROWSER_SHARED_WORKER_INSTANCE_H_