File: proceed_until_response_navigation_throttle.cc

package info (click to toggle)
chromium 139.0.7258.138-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 6,120,676 kB
  • sloc: cpp: 35,100,869; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (187 lines) | stat: -rw-r--r-- 6,968 bytes parent folder | download | duplicates (5)
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "components/policy/content/proceed_until_response_navigation_throttle.h"

#include "base/notimplemented.h"
#include "base/strings/strcat.h"

ProceedUntilResponseNavigationThrottle::Client::Client(
    content::NavigationThrottleRegistry& registry)
    : NavigationThrottle(registry) {}

ProceedUntilResponseNavigationThrottle::ProceedUntilResponseNavigationThrottle(
    content::NavigationThrottleRegistry& registry,
    std::unique_ptr<Client> client,
    std::optional<DeferredResultCallback> deferred_result_callback)
    : NavigationThrottle(registry),
      name_(base::StrCat({"ProceedUntilResponseNavigationThrottle::",
                          client ? client->GetNameForLogging() : ""})),
      client_(std::move(client)),
      deferred_result_callback_(std::move(deferred_result_callback)) {
  CHECK(client_);
  client_->SetDeferredResultCallback(base::BindRepeating(
      &ProceedUntilResponseNavigationThrottle::ResolveDeferredResult,
      base::Unretained(this)));
}

ProceedUntilResponseNavigationThrottle::
    ~ProceedUntilResponseNavigationThrottle() = default;

content::NavigationThrottle::ThrottleCheckResult
ProceedUntilResponseNavigationThrottle::WillStartRequest() {
  CHECK_EQ(deferred_state_, DeferredState::kNotDeferred);
  CHECK(!result_.has_value());
  return ProcessEvent(Event::kWillStartRequest);
}

content::NavigationThrottle::ThrottleCheckResult
ProceedUntilResponseNavigationThrottle::WillRedirectRequest() {
  return ProcessEvent(Event::kWillRedirectRequest);
}

content::NavigationThrottle::ThrottleCheckResult
ProceedUntilResponseNavigationThrottle::WillFailRequest() {
  NOTIMPLEMENTED() << "not verified in any test";
  return ProcessEvent(Event::kWillFailRequest);
}

content::NavigationThrottle::ThrottleCheckResult
ProceedUntilResponseNavigationThrottle::WillProcessResponse() {
  return ProcessEvent(Event::kWillProcessResponse);
}

content::NavigationThrottle::ThrottleCheckResult
ProceedUntilResponseNavigationThrottle::WillCommitWithoutUrlLoader() {
  NOTIMPLEMENTED() << "not verified in any test";
  return ProcessEvent(Event::kWillCommitWithoutUrlLoader);
}

const char* ProceedUntilResponseNavigationThrottle::GetNameForLogging() {
  return name_.c_str();
}

content::NavigationThrottle::ThrottleCheckResult
ProceedUntilResponseNavigationThrottle::ProcessEvent(Event event) {
  switch (deferred_state_) {
    case DeferredState::kNotDeferred: {
      // The internal throttle isn't currently running an asynchronous task.
      // If the previous asynchronous task returned non-PROCEED action, return
      // it.
      if (result_.has_value() && result_->action() != PROCEED) {
        return std::move(result_).value();
      }
      // Otherwise, forward the event to the internal throttle.
      content::NavigationThrottle::ThrottleCheckResult result =
          CallInternalThrottle(event);
      if (result.action() == DEFER) {
        if (!CanProceedSpeculatively(event)) {
          // Need to be kDeferredExposed state, but ResolveDeferredResult()
          // need a dedicated implementation for this case.
          NOTIMPLEMENTED();
        }
        // Hides the DEFER action and proceeds.
        deferred_state_ = DeferredState::kDeferredNotExposed;
        pending_event_ = Event::kNoEvent;
        return PROCEED;
      }
      return result;
    }
    case DeferredState::kDeferredNotExposed:
      // The internal throttle is still running an asynchronous task. Change the
      // deferred_state_ to kDeferredExposed to revisit the event when the
      // asynchronous task completes.
      deferred_state_ = DeferredState::kDeferredExposed;
      pending_event_ = event;
      // Returns DEFER to avoid more events happening.
      return DEFER;
    case DeferredState::kDeferredExposed:
      // While we expose DEFER, any event should not be delivered.
      NOTREACHED();
  }
}

bool ProceedUntilResponseNavigationThrottle::CanProceedSpeculatively(
    Event event) {
  switch (event) {
    case Event::kNoEvent:
      NOTREACHED();
    case Event::kWillStartRequest:
    case Event::kWillRedirectRequest:
      return true;
    case Event::kWillFailRequest:
    case Event::kWillProcessResponse:
    case Event::kWillCommitWithoutUrlLoader:
      return false;
  }
  NOTREACHED();
}

content::NavigationThrottle::ThrottleCheckResult
ProceedUntilResponseNavigationThrottle::CallInternalThrottle(Event event) {
  switch (event) {
    case Event::kNoEvent:
      NOTREACHED();
    case Event::kWillStartRequest:
      return client_->WillStartRequest();
    case Event::kWillRedirectRequest:
      return client_->WillRedirectRequest();
    case Event::kWillFailRequest:
      return client_->WillFailRequest();
    case Event::kWillProcessResponse:
      return client_->WillProcessResponse();
    case Event::kWillCommitWithoutUrlLoader:
      return client_->WillCommitWithoutUrlLoader();
  }
  NOTREACHED();
}

void ProceedUntilResponseNavigationThrottle::ResolveDeferredResult(
    bool proceed,
    std::optional<ThrottleCheckResult> result) {
  // Ensure that `proceed` and `result` are consistent with each other.
  CHECK(proceed || (result.has_value() && result->action() != PROCEED));
  switch (deferred_state_) {
    case DeferredState::kNotDeferred:
      NOTREACHED();
    case DeferredState::kDeferredNotExposed:
      // An asynchronous task finished before the next navigation event arrives.
      // Remember the result only if the `proceed` is false, to return it when
      // the next event arrives. If the `proceed` is true, `result` may contain
      // a junk.
      if (!proceed) {
        result_ = std::move(result);
      }
      deferred_state_ = DeferredState::kNotDeferred;
      break;
    case DeferredState::kDeferredExposed:
      // An asynchronous task triggered finished after the next navigation event
      // arrives. The throttle runner is suspended.
      deferred_state_ = DeferredState::kNotDeferred;
      if (proceed) {
        // If the asynchronous task allows to proceed, re-process the next
        // navigation event now after previously immediately deferring it,
        // and resume the runner with the throttle's result.
        // As `ProcessEvent()` can hide the internal DEFER always, there is no
        // case we need to expose DEFER below.
        result = ProcessEvent(pending_event_);
        CHECK_NE(DEFER, result->action());
        proceed = result->action() == PROCEED;
      }
      if (proceed) {
        if (deferred_result_callback_) {
          deferred_result_callback_->Run(proceed, std::nullopt);
        } else {
          Resume();
        }
      } else {
        if (deferred_result_callback_) {
          deferred_result_callback_->Run(proceed, result);
        } else {
          CancelDeferredNavigation(*result);
        }
      }
      break;
  }
}