0a9438dbba
* docs: NetworkService-based protocol module * docs: separate ProtocolRequest * docs: separate ProtocolResponse * docs: fix lint warning * docs: fix electron.d.ts * fix: print deprecation warnings for protocol module * docs: fix links * Apply suggestions from code review Co-Authored-By: Felix Rieseberg <felix@felixrieseberg.com> * Apply suggestions from code review Co-Authored-By: Samuel Attard <samuel.r.attard@gmail.com> * Do not publish NetworkService changes draft * Apply suggestions from code review Co-Authored-By: Samuel Attard <samuel.r.attard@gmail.com> * docs: filePath must be absolute
96 lines
3.3 KiB
C++
96 lines
3.3 KiB
C++
// Copyright (c) 2019 GitHub, Inc.
|
|
// Use of this source code is governed by the MIT license that can be
|
|
// found in the LICENSE file.
|
|
|
|
#ifndef SHELL_BROWSER_API_ATOM_API_PROTOCOL_NS_H_
|
|
#define SHELL_BROWSER_API_ATOM_API_PROTOCOL_NS_H_
|
|
|
|
#include <string>
|
|
|
|
#include "content/public/browser/content_browser_client.h"
|
|
#include "native_mate/dictionary.h"
|
|
#include "native_mate/handle.h"
|
|
#include "shell/browser/api/trackable_object.h"
|
|
#include "shell/browser/net/atom_url_loader_factory.h"
|
|
|
|
namespace electron {
|
|
|
|
class AtomBrowserContext;
|
|
|
|
namespace api {
|
|
|
|
// Possible errors.
|
|
enum class ProtocolError {
|
|
OK, // no error
|
|
REGISTERED,
|
|
NOT_REGISTERED,
|
|
INTERCEPTED,
|
|
NOT_INTERCEPTED,
|
|
};
|
|
|
|
// Protocol implementation based on network services.
|
|
class ProtocolNS : public mate::TrackableObject<ProtocolNS> {
|
|
public:
|
|
static mate::Handle<ProtocolNS> Create(v8::Isolate* isolate,
|
|
AtomBrowserContext* browser_context);
|
|
|
|
static void BuildPrototype(v8::Isolate* isolate,
|
|
v8::Local<v8::FunctionTemplate> prototype);
|
|
|
|
// Used by AtomBrowserClient for creating URLLoaderFactory.
|
|
void RegisterURLLoaderFactories(
|
|
content::ContentBrowserClient::NonNetworkURLLoaderFactoryMap* factories);
|
|
|
|
const HandlersMap& intercept_handlers() const { return intercept_handlers_; }
|
|
|
|
private:
|
|
ProtocolNS(v8::Isolate* isolate, AtomBrowserContext* browser_context);
|
|
~ProtocolNS() override;
|
|
|
|
// Callback types.
|
|
using CompletionCallback =
|
|
base::RepeatingCallback<void(v8::Local<v8::Value>)>;
|
|
|
|
// JS APIs.
|
|
ProtocolError RegisterProtocol(ProtocolType type,
|
|
const std::string& scheme,
|
|
const ProtocolHandler& handler);
|
|
void UnregisterProtocol(const std::string& scheme, mate::Arguments* args);
|
|
bool IsProtocolRegistered(const std::string& scheme);
|
|
|
|
ProtocolError InterceptProtocol(ProtocolType type,
|
|
const std::string& scheme,
|
|
const ProtocolHandler& handler);
|
|
void UninterceptProtocol(const std::string& scheme, mate::Arguments* args);
|
|
bool IsProtocolIntercepted(const std::string& scheme);
|
|
|
|
// Old async version of IsProtocolRegistered.
|
|
v8::Local<v8::Promise> IsProtocolHandled(const std::string& scheme,
|
|
mate::Arguments* args);
|
|
|
|
// Helper for converting old registration APIs to new RegisterProtocol API.
|
|
template <ProtocolType type>
|
|
void RegisterProtocolFor(const std::string& scheme,
|
|
const ProtocolHandler& handler,
|
|
mate::Arguments* args) {
|
|
HandleOptionalCallback(args, RegisterProtocol(type, scheme, handler));
|
|
}
|
|
template <ProtocolType type>
|
|
void InterceptProtocolFor(const std::string& scheme,
|
|
const ProtocolHandler& handler,
|
|
mate::Arguments* args) {
|
|
HandleOptionalCallback(args, InterceptProtocol(type, scheme, handler));
|
|
}
|
|
|
|
// Be compatible with old interface, which accepts optional callback.
|
|
void HandleOptionalCallback(mate::Arguments* args, ProtocolError error);
|
|
|
|
HandlersMap handlers_;
|
|
HandlersMap intercept_handlers_;
|
|
};
|
|
|
|
} // namespace api
|
|
|
|
} // namespace electron
|
|
|
|
#endif // SHELL_BROWSER_API_ATOM_API_PROTOCOL_NS_H_
|