1/*
2 * Copyright (C) 2007, 2008 Apple Inc. All rights reserved.
3 * Copyright (C) 2008 Matt Lilek <webkit@mattlilek.com>
4 * Copyright (C) 2009, 2010 Google Inc. All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 *
10 * 1.  Redistributions of source code must retain the above copyright
11 *     notice, this list of conditions and the following disclaimer.
12 * 2.  Redistributions in binary form must reproduce the above copyright
13 *     notice, this list of conditions and the following disclaimer in the
14 *     documentation and/or other materials provided with the distribution.
15 * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
16 *     its contributors may be used to endorse or promote products derived
17 *     from this software without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
20 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
23 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
26 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 */
30
31#include "config.h"
32
33#if ENABLE(INSPECTOR)
34
35#include "ConsoleMessage.h"
36
37#include "Console.h"
38#include "IdentifiersFactory.h"
39#include "InjectedScript.h"
40#include "InjectedScriptManager.h"
41#include "InspectorFrontend.h"
42#include "InspectorValues.h"
43#include "ScriptArguments.h"
44#include "ScriptCallFrame.h"
45#include "ScriptCallStack.h"
46#include "ScriptCallStackFactory.h"
47#include "ScriptValue.h"
48#include <wtf/MainThread.h>
49
50namespace WebCore {
51
52ConsoleMessage::ConsoleMessage(bool canGenerateCallStack, MessageSource source, MessageType type, MessageLevel level, const String& message, unsigned long requestIdentifier)
53    : m_source(source)
54    , m_type(type)
55    , m_level(level)
56    , m_message(message)
57    , m_url()
58    , m_line(0)
59    , m_column(0)
60    , m_repeatCount(1)
61    , m_requestId(IdentifiersFactory::requestId(requestIdentifier))
62{
63    autogenerateMetadata(canGenerateCallStack);
64}
65
66ConsoleMessage::ConsoleMessage(bool canGenerateCallStack, MessageSource source, MessageType type, MessageLevel level, const String& message, const String& url, unsigned line, unsigned column, ScriptState* state, unsigned long requestIdentifier)
67    : m_source(source)
68    , m_type(type)
69    , m_level(level)
70    , m_message(message)
71    , m_url(url)
72    , m_line(line)
73    , m_column(column)
74    , m_repeatCount(1)
75    , m_requestId(IdentifiersFactory::requestId(requestIdentifier))
76{
77    autogenerateMetadata(canGenerateCallStack, state);
78}
79
80ConsoleMessage::ConsoleMessage(bool, MessageSource source, MessageType type, MessageLevel level, const String& message, PassRefPtr<ScriptCallStack> callStack, unsigned long requestIdentifier)
81    : m_source(source)
82    , m_type(type)
83    , m_level(level)
84    , m_message(message)
85    , m_arguments(0)
86    , m_line(0)
87    , m_column(0)
88    , m_repeatCount(1)
89    , m_requestId(IdentifiersFactory::requestId(requestIdentifier))
90{
91    if (callStack && callStack->size()) {
92        const ScriptCallFrame& frame = callStack->at(0);
93        m_url = frame.sourceURL();
94        m_line = frame.lineNumber();
95        m_column = frame.columnNumber();
96    }
97    m_callStack = callStack;
98}
99
100ConsoleMessage::ConsoleMessage(bool canGenerateCallStack, MessageSource source, MessageType type, MessageLevel level, const String& message, PassRefPtr<ScriptArguments> arguments, ScriptState* state, unsigned long requestIdentifier)
101    : m_source(source)
102    , m_type(type)
103    , m_level(level)
104    , m_message(message)
105    , m_arguments(arguments)
106    , m_url()
107    , m_line(0)
108    , m_column(0)
109    , m_repeatCount(1)
110    , m_requestId(IdentifiersFactory::requestId(requestIdentifier))
111{
112    autogenerateMetadata(canGenerateCallStack, state);
113}
114
115ConsoleMessage::~ConsoleMessage()
116{
117}
118
119void ConsoleMessage::autogenerateMetadata(bool canGenerateCallStack, ScriptState* state)
120{
121    if (m_type == EndGroupMessageType)
122        return;
123
124    if (state)
125        m_callStack = createScriptCallStackForConsole(state);
126    else if (canGenerateCallStack)
127        m_callStack = createScriptCallStack(ScriptCallStack::maxCallStackSizeToCapture, true);
128    else
129        return;
130
131    if (m_callStack && m_callStack->size()) {
132        const ScriptCallFrame& frame = m_callStack->at(0);
133        m_url = frame.sourceURL();
134        m_line = frame.lineNumber();
135        m_column = frame.columnNumber();
136        return;
137    }
138
139    m_callStack.clear();
140}
141
142// Keep in sync with inspector/front-end/ConsoleView.js
143static TypeBuilder::Console::ConsoleMessage::Source::Enum messageSourceValue(MessageSource source)
144{
145    switch (source) {
146    case XMLMessageSource: return TypeBuilder::Console::ConsoleMessage::Source::Xml;
147    case JSMessageSource: return TypeBuilder::Console::ConsoleMessage::Source::Javascript;
148    case NetworkMessageSource: return TypeBuilder::Console::ConsoleMessage::Source::Network;
149    case ConsoleAPIMessageSource: return TypeBuilder::Console::ConsoleMessage::Source::Console_api;
150    case StorageMessageSource: return TypeBuilder::Console::ConsoleMessage::Source::Storage;
151    case AppCacheMessageSource: return TypeBuilder::Console::ConsoleMessage::Source::Appcache;
152    case RenderingMessageSource: return TypeBuilder::Console::ConsoleMessage::Source::Rendering;
153    case CSSMessageSource: return TypeBuilder::Console::ConsoleMessage::Source::Css;
154    case SecurityMessageSource: return TypeBuilder::Console::ConsoleMessage::Source::Security;
155    case OtherMessageSource: return TypeBuilder::Console::ConsoleMessage::Source::Other;
156    }
157    return TypeBuilder::Console::ConsoleMessage::Source::Other;
158}
159
160static TypeBuilder::Console::ConsoleMessage::Type::Enum messageTypeValue(MessageType type)
161{
162    switch (type) {
163    case LogMessageType: return TypeBuilder::Console::ConsoleMessage::Type::Log;
164    case ClearMessageType: return TypeBuilder::Console::ConsoleMessage::Type::Clear;
165    case DirMessageType: return TypeBuilder::Console::ConsoleMessage::Type::Dir;
166    case DirXMLMessageType: return TypeBuilder::Console::ConsoleMessage::Type::Dirxml;
167    case TableMessageType: return TypeBuilder::Console::ConsoleMessage::Type::Table;
168    case TraceMessageType: return TypeBuilder::Console::ConsoleMessage::Type::Trace;
169    case StartGroupMessageType: return TypeBuilder::Console::ConsoleMessage::Type::StartGroup;
170    case StartGroupCollapsedMessageType: return TypeBuilder::Console::ConsoleMessage::Type::StartGroupCollapsed;
171    case EndGroupMessageType: return TypeBuilder::Console::ConsoleMessage::Type::EndGroup;
172    case AssertMessageType: return TypeBuilder::Console::ConsoleMessage::Type::Assert;
173    case TimingMessageType: return TypeBuilder::Console::ConsoleMessage::Type::Timing;
174    case ProfileMessageType: return TypeBuilder::Console::ConsoleMessage::Type::Profile;
175    case ProfileEndMessageType: return TypeBuilder::Console::ConsoleMessage::Type::ProfileEnd;
176    }
177    return TypeBuilder::Console::ConsoleMessage::Type::Log;
178}
179
180static TypeBuilder::Console::ConsoleMessage::Level::Enum messageLevelValue(MessageLevel level)
181{
182    switch (level) {
183    case DebugMessageLevel: return TypeBuilder::Console::ConsoleMessage::Level::Debug;
184    case LogMessageLevel: return TypeBuilder::Console::ConsoleMessage::Level::Log;
185    case WarningMessageLevel: return TypeBuilder::Console::ConsoleMessage::Level::Warning;
186    case ErrorMessageLevel: return TypeBuilder::Console::ConsoleMessage::Level::Error;
187    }
188    return TypeBuilder::Console::ConsoleMessage::Level::Log;
189}
190
191void ConsoleMessage::addToFrontend(InspectorFrontend::Console* frontend, InjectedScriptManager* injectedScriptManager, bool generatePreview)
192{
193    RefPtr<TypeBuilder::Console::ConsoleMessage> jsonObj = TypeBuilder::Console::ConsoleMessage::create()
194        .setSource(messageSourceValue(m_source))
195        .setLevel(messageLevelValue(m_level))
196        .setText(m_message);
197    // FIXME: only send out type for ConsoleAPI source messages.
198    jsonObj->setType(messageTypeValue(m_type));
199    jsonObj->setLine(static_cast<int>(m_line));
200    jsonObj->setColumn(static_cast<int>(m_column));
201    jsonObj->setUrl(m_url);
202    jsonObj->setRepeatCount(static_cast<int>(m_repeatCount));
203    if (m_source == NetworkMessageSource && !m_requestId.isEmpty())
204        jsonObj->setNetworkRequestId(m_requestId);
205    if (m_arguments && m_arguments->argumentCount()) {
206        InjectedScript injectedScript = injectedScriptManager->injectedScriptFor(m_arguments->globalState());
207        if (!injectedScript.hasNoValue()) {
208            RefPtr<TypeBuilder::Array<TypeBuilder::Runtime::RemoteObject> > jsonArgs = TypeBuilder::Array<TypeBuilder::Runtime::RemoteObject>::create();
209            if (m_type == TableMessageType && generatePreview && m_arguments->argumentCount()) {
210                ScriptValue table = m_arguments->argumentAt(0);
211                ScriptValue columns = m_arguments->argumentCount() > 1 ? m_arguments->argumentAt(1) : ScriptValue();
212                RefPtr<TypeBuilder::Runtime::RemoteObject> inspectorValue = injectedScript.wrapTable(table, columns);
213                if (!inspectorValue) {
214                    ASSERT_NOT_REACHED();
215                    return;
216                }
217                jsonArgs->addItem(inspectorValue);
218            } else {
219                for (unsigned i = 0; i < m_arguments->argumentCount(); ++i) {
220                    RefPtr<TypeBuilder::Runtime::RemoteObject> inspectorValue = injectedScript.wrapObject(m_arguments->argumentAt(i), "console", generatePreview);
221                    if (!inspectorValue) {
222                        ASSERT_NOT_REACHED();
223                        return;
224                    }
225                    jsonArgs->addItem(inspectorValue);
226                }
227            }
228            jsonObj->setParameters(jsonArgs);
229        }
230    }
231    if (m_callStack)
232        jsonObj->setStackTrace(m_callStack->buildInspectorArray());
233    frontend->messageAdded(jsonObj);
234}
235
236void ConsoleMessage::updateRepeatCountInConsole(InspectorFrontend::Console* frontend)
237{
238    frontend->messageRepeatCountUpdated(m_repeatCount);
239}
240
241bool ConsoleMessage::isEqual(ConsoleMessage* msg) const
242{
243    if (m_arguments) {
244        if (!m_arguments->isEqual(msg->m_arguments.get()))
245            return false;
246        // Never treat objects as equal - their properties might change over time.
247        for (size_t i = 0; i < m_arguments->argumentCount(); ++i) {
248            if (m_arguments->argumentAt(i).isObject())
249                return false;
250        }
251    } else if (msg->m_arguments)
252        return false;
253
254    if (m_callStack) {
255        if (!m_callStack->isEqual(msg->m_callStack.get()))
256            return false;
257    } else if (msg->m_callStack)
258        return false;
259
260    return msg->m_source == m_source
261        && msg->m_type == m_type
262        && msg->m_level == m_level
263        && msg->m_message == m_message
264        && msg->m_line == m_line
265        && msg->m_column == m_column
266        && msg->m_url == m_url
267        && msg->m_requestId == m_requestId;
268}
269
270void ConsoleMessage::windowCleared(DOMWindow* window)
271{
272    if (!m_arguments)
273        return;
274    if (domWindowFromScriptState(m_arguments->globalState()) != window)
275        return;
276    if (!m_message)
277        m_message = "<message collected>";
278    m_arguments.clear();
279}
280
281unsigned ConsoleMessage::argumentCount()
282{
283    if (m_arguments)
284        return m_arguments->argumentCount();
285    return 0;
286}
287
288} // namespace WebCore
289
290#endif // ENABLE(INSPECTOR)
291