1/*
2 * Copyright (C) 2019 Apple Inc. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 *
13 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23 * THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26#pragma once
27
28#include "InspectorAgentBase.h"
29#include "InspectorBackendDispatchers.h"
30#include "JSCInlines.h"
31#include <wtf/FastMalloc.h>
32#include <wtf/Forward.h>
33#include <wtf/Noncopyable.h>
34
35namespace Inspector {
36
37class InjectedScript;
38class InjectedScriptManager;
39class ScriptDebugServer;
40typedef String ErrorString;
41
42class JS_EXPORT_PRIVATE InspectorAuditAgent : public InspectorAgentBase, public AuditBackendDispatcherHandler {
43 WTF_MAKE_NONCOPYABLE(InspectorAuditAgent);
44 WTF_MAKE_FAST_ALLOCATED;
45public:
46 virtual ~InspectorAuditAgent() = default;
47
48 // InspectorAgentBase
49 void didCreateFrontendAndBackend(FrontendRouter*, BackendDispatcher*) override;
50 void willDestroyFrontendAndBackend(DisconnectReason) override;
51
52 // AuditBackendDispatcherHandler
53 void setup(ErrorString&, const int* executionContextId) final;
54 void run(ErrorString&, const String& test, const int* executionContextId, RefPtr<Protocol::Runtime::RemoteObject>& result, Optional<bool>& wasThrown) final;
55 void teardown(ErrorString&) final;
56
57 bool hasActiveAudit() const;
58
59protected:
60 explicit InspectorAuditAgent(AgentContext&);
61
62 InjectedScriptManager& injectedScriptManager() { return m_injectedScriptManager; }
63
64 virtual InjectedScript injectedScriptForEval(ErrorString&, const int* executionContextId) = 0;
65
66 virtual void populateAuditObject(JSC::ExecState*, JSC::Strong<JSC::JSObject>& auditObject);
67
68 virtual void muteConsole() { };
69 virtual void unmuteConsole() { };
70
71private:
72 RefPtr<AuditBackendDispatcher> m_backendDispatcher;
73 InjectedScriptManager& m_injectedScriptManager;
74 ScriptDebugServer& m_scriptDebugServer;
75
76 JSC::Strong<JSC::JSObject> m_injectedWebInspectorAuditValue;
77};
78
79} // namespace Inspector
80