File: ScriptFetchOptions.h

package info (click to toggle)
firefox 149.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 4,767,760 kB
  • sloc: cpp: 7,416,064; javascript: 6,752,859; ansic: 3,774,850; python: 1,250,473; xml: 641,578; asm: 439,191; java: 186,617; sh: 56,634; makefile: 18,856; objc: 13,092; perl: 12,763; pascal: 5,960; yacc: 4,583; cs: 3,846; lex: 1,720; ruby: 1,002; php: 436; lisp: 258; awk: 105; sql: 66; sed: 53; csh: 10; exp: 6
file content (131 lines) | stat: -rw-r--r-- 4,462 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef js_loader_ScriptFecthOptions_h
#define js_loader_ScriptFecthOptions_h

#include "mozilla/AlreadyAddRefed.h"
#include "mozilla/CORSMode.h"
#include "mozilla/MemoryReporting.h"
#include "mozilla/dom/ReferrerPolicyBinding.h"
#include "mozilla/dom/RequestBinding.h"  // RequestPriority
#include "nsCOMPtr.h"
#include "nsIPrincipal.h"

namespace JS::loader {

// https://fetch.spec.whatwg.org/#concept-request-parser-metadata
// All scripts are either "parser-inserted" or "not-parser-inserted", so
// the empty string is not necessary.
enum class ParserMetadata : uint8_t {
  NotParserInserted,
  ParserInserted,
};

/*
 * ScriptFetchOptions loosely corresponds to HTML's "script fetch options",
 * https://html.spec.whatwg.org/multipage/webappapis.html#script-fetch-options
 * with the exception of the following properties:
 *   integrity metadata
 *      The integrity metadata used for the initial fetch. This is
 *      implemented in ScriptLoadRequest, as it changes for every
 *      ScriptLoadRequest.
 *
 *   referrerPolicy
 *     For a module script, its referrerPolicy will be updated if there is a
 *     HTTP Response 'REFERRER-POLICY' header, given this value may be different
 *     for every ScriptLoadRequest, so we store it directly in
 *     ScriptLoadRequest.
 *
 * In the case of classic scripts without dynamic import, this object is
 * used once. For modules, this object is propogated throughout the module
 * tree. If there is a dynamically imported module in any type of script,
 * the ScriptFetchOptions object will be propogated from its importer.
 */

class ScriptFetchOptions {
  ~ScriptFetchOptions();

 public:
  NS_INLINE_DECL_THREADSAFE_REFCOUNTING(ScriptFetchOptions)

  ScriptFetchOptions(mozilla::CORSMode aCORSMode, const nsAString& aNonce,
                     mozilla::dom::RequestPriority aFetchPriority,
                     const ParserMetadata aParserMetadata,
                     nsIPrincipal* aTriggeringPrincipal = nullptr);

  // https://html.spec.whatwg.org/#default-script-fetch-options
  static already_AddRefed<ScriptFetchOptions> CreateDefault();

  void SetTriggeringPrincipal(nsIPrincipal* aTriggeringPrincipal);

  // Returns true if given fetch option is compatible with this fetch option
  // in term of sharing the server response.
  inline bool IsCompatible(ScriptFetchOptions* other) {
    if (this == other) {
      return true;
    }

    if (mTriggeringPrincipal && other->mTriggeringPrincipal) {
      bool equals;
      (void)mTriggeringPrincipal->Equals(other->mTriggeringPrincipal, &equals);
      if (!equals) {
        return false;
      }
    } else if (mTriggeringPrincipal || other->mTriggeringPrincipal) {
      return false;
    }

    // NOTE: mParserMetadata can be ignored.
    return mCORSMode == other->mCORSMode && mNonce == other->mNonce &&
           mFetchPriority == other->mFetchPriority;
  }

  size_t SizeOfIncludingThis(mozilla::MallocSizeOf aMallocSizeOf) const {
    return aMallocSizeOf(this) + SizeOfExcludingThis(aMallocSizeOf);
  }
  size_t SizeOfExcludingThis(mozilla::MallocSizeOf aMallocSizeOf) const {
    return mNonce.SizeOfExcludingThisIfUnshared(aMallocSizeOf);
  }

 public:
  /* Fields */

  /*
   *  The credentials mode used for the initial fetch (for module scripts)
   *  and for fetching any imported modules (for both module scripts and
   *  classic scripts)
   */
  const mozilla::CORSMode mCORSMode;

  /*
   * <https://html.spec.whatwg.org/multipage/webappapis.html#script-fetch-options>.
   */
  const mozilla::dom::RequestPriority mFetchPriority;

  /*
   * The parser metadata used for the initial fetch and for fetching any
   * imported modules
   */
  const ParserMetadata mParserMetadata;

  /*
   *  Used to determine CSP and if we are on the About page.
   *  Only used in DOM content scripts.
   *  TODO: Move to ScriptLoadContext
   */
  nsCOMPtr<nsIPrincipal> mTriggeringPrincipal;

  /*
   * The cryptographic nonce metadata used for the initial fetch and for
   * fetching any imported modules.
   */
  const nsString mNonce;
};

}  // namespace JS::loader

#endif  // js_loader_ScriptFetchOptions_h