Use "= default" to denote default constructor or destructor
[WebKit-https.git] / Source / WebCore / page / PageConsoleClient.cpp
1 /*
2  * Copyright (C) 2013, 2014 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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #include "config.h"
30 #include "PageConsoleClient.h"
31
32 #include "Chrome.h"
33 #include "ChromeClient.h"
34 #include "Document.h"
35 #include "Frame.h"
36 #include "InspectorController.h"
37 #include "InspectorInstrumentation.h"
38 #include "JSMainThreadExecState.h"
39 #include "MainFrame.h"
40 #include "Page.h"
41 #include "ScriptableDocumentParser.h"
42 #include "Settings.h"
43 #include <inspector/ConsoleMessage.h>
44 #include <inspector/ScriptArguments.h>
45 #include <inspector/ScriptCallStack.h>
46 #include <inspector/ScriptCallStackFactory.h>
47
48
49 namespace WebCore {
50 using namespace Inspector;
51
52 PageConsoleClient::PageConsoleClient(Page& page)
53     : m_page(page)
54 {
55 }
56
57 PageConsoleClient::~PageConsoleClient() = default;
58
59 static int muteCount = 0;
60 static bool printExceptions = false;
61
62 bool PageConsoleClient::shouldPrintExceptions()
63 {
64     return printExceptions;
65 }
66
67 void PageConsoleClient::setShouldPrintExceptions(bool print)
68 {
69     printExceptions = print;
70 }
71
72 void PageConsoleClient::mute()
73 {
74     muteCount++;
75 }
76
77 void PageConsoleClient::unmute()
78 {
79     ASSERT(muteCount > 0);
80     muteCount--;
81 }
82
83 static void getParserLocationForConsoleMessage(Document* document, String& url, unsigned& line, unsigned& column)
84 {
85     if (!document)
86         return;
87
88     // We definitely cannot associate the message with a location being parsed if we are not even parsing.
89     if (!document->parsing())
90         return;
91
92     ScriptableDocumentParser* parser = document->scriptableDocumentParser();
93     if (!parser)
94         return;
95
96     // When the parser waits for scripts, any messages must be coming from some other source, and are not related to the location of the script element that made the parser wait.
97     if (!parser->shouldAssociateConsoleMessagesWithTextPosition())
98         return;
99
100     url = document->url().string();
101     TextPosition position = parser->textPosition();
102     line = position.m_line.oneBasedInt();
103     column = position.m_column.oneBasedInt();
104 }
105
106 void PageConsoleClient::addMessage(std::unique_ptr<Inspector::ConsoleMessage>&& consoleMessage)
107 {
108     if (consoleMessage->source() != MessageSource::CSS && !m_page.usesEphemeralSession()) {
109         m_page.chrome().client().addMessageToConsole(consoleMessage->source(), consoleMessage->level(), consoleMessage->message(), consoleMessage->line(), consoleMessage->column(), consoleMessage->url());
110
111         if (m_page.settings().logsPageMessagesToSystemConsoleEnabled() || shouldPrintExceptions())
112             ConsoleClient::printConsoleMessage(MessageSource::ConsoleAPI, MessageType::Log, consoleMessage->level(), consoleMessage->message(), consoleMessage->url(), consoleMessage->line(), consoleMessage->column());
113     }
114
115     InspectorInstrumentation::addMessageToConsole(m_page, WTFMove(consoleMessage));
116 }
117
118 void PageConsoleClient::addMessage(MessageSource source, MessageLevel level, const String& message, unsigned long requestIdentifier, Document* document)
119 {
120     String url;
121     unsigned line = 0;
122     unsigned column = 0;
123     getParserLocationForConsoleMessage(document, url, line, column);
124
125     addMessage(source, level, message, url, line, column, 0, JSMainThreadExecState::currentState(), requestIdentifier);
126 }
127
128 void PageConsoleClient::addMessage(MessageSource source, MessageLevel level, const String& message, Ref<ScriptCallStack>&& callStack)
129 {
130     addMessage(source, level, message, String(), 0, 0, WTFMove(callStack), 0);
131 }
132
133 void PageConsoleClient::addMessage(MessageSource source, MessageLevel level, const String& messageText, const String& suggestedURL, unsigned suggestedLineNumber, unsigned suggestedColumnNumber, RefPtr<ScriptCallStack>&& callStack, JSC::ExecState* state, unsigned long requestIdentifier)
134 {
135     if (muteCount && source != MessageSource::ConsoleAPI)
136         return;
137
138     std::unique_ptr<Inspector::ConsoleMessage> message;
139
140     if (callStack)
141         message = std::make_unique<Inspector::ConsoleMessage>(source, MessageType::Log, level, messageText, callStack.releaseNonNull(), requestIdentifier);
142     else
143         message = std::make_unique<Inspector::ConsoleMessage>(source, MessageType::Log, level, messageText, suggestedURL, suggestedLineNumber, suggestedColumnNumber, state, requestIdentifier);
144
145     addMessage(WTFMove(message));
146 }
147
148
149 void PageConsoleClient::messageWithTypeAndLevel(MessageType type, MessageLevel level, JSC::ExecState* exec, Ref<Inspector::ScriptArguments>&& arguments)
150 {
151     String messageText;
152     bool gotMessage = arguments->getFirstArgumentAsString(messageText);
153
154     auto message = std::make_unique<Inspector::ConsoleMessage>(MessageSource::ConsoleAPI, type, level, messageText, arguments.copyRef(), exec);
155
156     String url = message->url();
157     unsigned lineNumber = message->line();
158     unsigned columnNumber = message->column();
159
160     InspectorInstrumentation::addMessageToConsole(m_page, WTFMove(message));
161
162     if (m_page.usesEphemeralSession())
163         return;
164
165     if (gotMessage)
166         m_page.chrome().client().addMessageToConsole(MessageSource::ConsoleAPI, level, messageText, lineNumber, columnNumber, url);
167
168     if (m_page.settings().logsPageMessagesToSystemConsoleEnabled() || PageConsoleClient::shouldPrintExceptions())
169         ConsoleClient::printConsoleMessageWithArguments(MessageSource::ConsoleAPI, type, level, exec, WTFMove(arguments));
170 }
171
172 void PageConsoleClient::count(JSC::ExecState* exec, Ref<ScriptArguments>&& arguments)
173 {
174     InspectorInstrumentation::consoleCount(m_page, exec, WTFMove(arguments));
175 }
176
177 void PageConsoleClient::profile(JSC::ExecState* exec, const String& title)
178 {
179     // FIXME: <https://webkit.org/b/153499> Web Inspector: console.profile should use the new Sampling Profiler
180     InspectorInstrumentation::startProfiling(m_page, exec, title);
181 }
182
183 void PageConsoleClient::profileEnd(JSC::ExecState* exec, const String& title)
184 {
185     // FIXME: <https://webkit.org/b/153499> Web Inspector: console.profile should use the new Sampling Profiler
186     InspectorInstrumentation::stopProfiling(m_page, exec, title);
187 }
188
189 void PageConsoleClient::takeHeapSnapshot(JSC::ExecState*, const String& title)
190 {
191     InspectorInstrumentation::takeHeapSnapshot(m_page.mainFrame(), title);
192 }
193
194 void PageConsoleClient::time(JSC::ExecState*, const String& title)
195 {
196     InspectorInstrumentation::startConsoleTiming(m_page.mainFrame(), title);
197 }
198
199 void PageConsoleClient::timeEnd(JSC::ExecState* exec, const String& title)
200 {
201     InspectorInstrumentation::stopConsoleTiming(m_page.mainFrame(), title, createScriptCallStackForConsole(exec, 1));
202 }
203
204 void PageConsoleClient::timeStamp(JSC::ExecState*, Ref<ScriptArguments>&& arguments)
205 {
206     InspectorInstrumentation::consoleTimeStamp(m_page.mainFrame(), WTFMove(arguments));
207 }
208
209 } // namespace WebCore