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
|
// 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_SERVICE_WORKER_CONTEXT_H_
#define CONTENT_PUBLIC_BROWSER_SERVICE_WORKER_CONTEXT_H_
#include <set>
#include <string>
#include "base/callback_forward.h"
#include "content/public/browser/service_worker_usage_info.h"
#include "url/gurl.h"
namespace content {
// Represents the per-StoragePartition ServiceWorker data.
class ServiceWorkerContext {
public:
// https://rawgithub.com/slightlyoff/ServiceWorker/master/spec/service_worker/index.html#url-scope:
// roughly, must be of the form "<origin>/<path>/*".
typedef GURL Scope;
typedef base::Callback<void(bool success)> ResultCallback;
typedef base::Callback<void(const std::vector<ServiceWorkerUsageInfo>&
usage_info)> GetUsageInfoCallback;
typedef base::Callback<void(bool has_service_worker)>
CheckHasServiceWorkerCallback;
// Registers the header name which should not be passed to the ServiceWorker.
// Must be called from the IO thread.
CONTENT_EXPORT static void AddExcludedHeadersForFetchEvent(
const std::set<std::string>& header_names);
// Returns true if the header name should not be passed to the ServiceWorker.
// Must be called from the IO thread.
static bool IsExcludedHeaderNameForFetchEvent(const std::string& header_name);
// Equivalent to calling navigator.serviceWorker.register(script_url, {scope:
// pattern}) from a renderer, except that |pattern| is an absolute URL instead
// of relative to some current origin. |callback| is passed true when the JS
// promise is fulfilled or false when the JS promise is rejected.
//
// The registration can fail if:
// * |script_url| is on a different origin from |pattern|
// * Fetching |script_url| fails.
// * |script_url| fails to parse or its top-level execution fails.
// TODO: The error message for this needs to be available to developers.
// * Something unexpected goes wrong, like a renderer crash or a full disk.
//
// This function can be called from any thread, but the callback will always
// be called on the UI thread.
virtual void RegisterServiceWorker(const Scope& pattern,
const GURL& script_url,
const ResultCallback& callback) = 0;
// Equivalent to calling navigator.serviceWorker.unregister(pattern) from a
// renderer, except that |pattern| is an absolute URL instead of relative to
// some current origin. |callback| is passed true when the JS promise is
// fulfilled or false when the JS promise is rejected.
//
// Unregistration can fail if:
// * No Service Worker was registered for |pattern|.
// * Something unexpected goes wrong, like a renderer crash.
//
// This function can be called from any thread, but the callback will always
// be called on the UI thread.
virtual void UnregisterServiceWorker(const Scope& pattern,
const ResultCallback& callback) = 0;
// Methods used in response to browsing data and quota manager requests.
// Must be called from the IO thread.
virtual void GetAllOriginsInfo(const GetUsageInfoCallback& callback) = 0;
// This function can be called from any thread, but the callback will always
// be called on the IO thread.
virtual void DeleteForOrigin(const GURL& origin_url,
const ResultCallback& callback) = 0;
// Returns true if a Service Worker registration exists that matches |url|,
// and if |other_url| falls inside the scope of the same registration. Note
// this still returns true even if there is a Service Worker registration
// which has a longer match for |other_url|.
//
// This function can be called from any thread, but the callback will always
// be called on the UI thread.
virtual void CheckHasServiceWorker(
const GURL& url,
const GURL& other_url,
const CheckHasServiceWorkerCallback& callback) = 0;
// Stops all running workers on the given |origin|.
//
// This function can be called from any thread.
virtual void StopAllServiceWorkersForOrigin(const GURL& origin) = 0;
// Stops all running service workers and unregisters all service worker
// registrations. This method is used in LayoutTests to make sure that the
// existing service worker will not affect the succeeding tests.
//
// This function can be called from any thread, but the callback will always
// be called on the UI thread.
virtual void ClearAllServiceWorkersForTest(const base::Closure& callback) = 0;
protected:
ServiceWorkerContext() {}
virtual ~ServiceWorkerContext() {}
};
} // namespace content
#endif // CONTENT_PUBLIC_BROWSER_SERVICE_WORKER_CONTEXT_H_
|
