dom/console/ConsoleUtils.cpp

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #include "ConsoleUtils.h"
   8 #include "ConsoleCommon.h"
   9 #include "nsContentUtils.h"
  10 #include "nsIConsoleAPIStorage.h"
  11 #include "nsIXPConnect.h"
  12 #include "nsServiceManagerUtils.h"
  13
  14 #include "mozilla/ClearOnShutdown.h"
  15 #include "mozilla/NullPrincipal.h"
  16 #include "mozilla/dom/ConsoleBinding.h"
  17 #include "mozilla/dom/RootedDictionary.h"
  18 #include "mozilla/dom/ScriptSettings.h"
  19 #include "js/PropertyAndElement.h"  // JS_DefineProperty
  20
  21 namespace mozilla::dom {
  22
  23 namespace {
  24
  25 StaticRefPtr<ConsoleUtils> gConsoleUtilsService;
  26
  27 }
  28
  29 /* static */
  30 ConsoleUtils* ConsoleUtils::GetOrCreate() {
  31   if (!gConsoleUtilsService) {
  32     MOZ_ASSERT(NS_IsMainThread());
  33
  34     gConsoleUtilsService = new ConsoleUtils();
  35     ClearOnShutdown(&gConsoleUtilsService);
  36   }
  37
  38   return gConsoleUtilsService;
  39 }
  40
  41 ConsoleUtils::ConsoleUtils() = default;
  42 ConsoleUtils::~ConsoleUtils() = default;
  43
  44 /* static */
  45 void ConsoleUtils::ReportForServiceWorkerScope(const nsAString& aScope,
  46                                                const nsAString& aMessage,
  47                                                const nsAString& aFilename,
  48                                                uint32_t aLineNumber,
  49                                                uint32_t aColumnNumber,
  50                                                Level aLevel) {
  51   MOZ_ASSERT(NS_IsMainThread());
  52
  53   RefPtr<ConsoleUtils> service = ConsoleUtils::GetOrCreate();
  54   if (NS_WARN_IF(!service)) {
  55     return;
  56   }
  57
  58   service->ReportForServiceWorkerScopeInternal(
  59       aScope, aMessage, aFilename, aLineNumber, aColumnNumber, aLevel);
  60 }
  61
  62 void ConsoleUtils::ReportForServiceWorkerScopeInternal(
  63     const nsAString& aScope, const nsAString& aMessage,
  64     const nsAString& aFilename, uint32_t aLineNumber, uint32_t aColumnNumber,
  65     Level aLevel) {
  66   MOZ_ASSERT(NS_IsMainThread());
  67
  68   AutoJSAPI jsapi;
  69   jsapi.Init();
  70
  71   JSContext* cx = jsapi.cx();
  72
  73   ConsoleCommon::ClearException ce(cx);
  74   JS::Rooted<JSObject*> global(cx, GetOrCreateSandbox(cx));
  75   if (NS_WARN_IF(!global)) {
  76     return;
  77   }
  78
  79   // The GetOrCreateSandbox call returns a proxy to the actual sandbox object.
  80   // We don't need a proxy here.
  81   global = js::UncheckedUnwrap(global);
  82
  83   JSAutoRealm ar(cx, global);
  84
  85   RootedDictionary<ConsoleEvent> event(cx);
  86
  87   event.mID.Construct();
  88   event.mID.Value().SetAsString() = aScope;
  89
  90   event.mInnerID.Construct();
  91   event.mInnerID.Value().SetAsString() = u"ServiceWorker"_ns;
  92
  93   switch (aLevel) {
  94     case eLog:
  95       event.mLevel = u"log"_ns;
  96       break;
  97
  98     case eWarning:
  99       event.mLevel = u"warn"_ns;
 100       break;
 101
 102     case eError:
 103       event.mLevel = u"error"_ns;
 104       break;
 105   }
 106
 107   event.mFilename = aFilename;
 108   event.mLineNumber = aLineNumber;
 109   event.mColumnNumber = aColumnNumber;
 110   event.mTimeStamp = JS_Now() / PR_USEC_PER_MSEC;
 111   event.mMicroSecondTimeStamp = JS_Now();
 112
 113   JS::Rooted<JS::Value> messageValue(cx);
 114   if (!dom::ToJSValue(cx, aMessage, &messageValue)) {
 115     return;
 116   }
 117
 118   event.mArguments.Construct();
 119   if (!event.mArguments.Value().AppendElement(messageValue, fallible)) {
 120     return;
 121   }
 122
 123   nsCOMPtr<nsIConsoleAPIStorage> storage =
 124       do_GetService("@mozilla.org/consoleAPI-storage;1");
 125
 126   if (NS_WARN_IF(!storage)) {
 127     return;
 128   }
 129
 130   JS::Rooted<JS::Value> eventValue(cx);
 131   if (!ToJSValue(cx, event, &eventValue)) {
 132     return;
 133   }
 134
 135   // This is a legacy property.
 136   JS::Rooted<JSObject*> eventObj(cx, &eventValue.toObject());
 137   if (NS_WARN_IF(!JS_DefineProperty(cx, eventObj, "wrappedJSObject", eventObj,
 138                                     JSPROP_ENUMERATE))) {
 139     return;
 140   }
 141
 142   storage->RecordEvent(u"ServiceWorker"_ns, eventValue);
 143 }
 144
 145 JSObject* ConsoleUtils::GetOrCreateSandbox(JSContext* aCx) {
 146   AssertIsOnMainThread();
 147
 148   if (!mSandbox) {
 149     nsIXPConnect* xpc = nsContentUtils::XPConnect();
 150     MOZ_ASSERT(xpc, "This should never be null!");
 151
 152     RefPtr<NullPrincipal> nullPrincipal =
 153         NullPrincipal::CreateWithoutOriginAttributes();
 154
 155     JS::Rooted<JSObject*> sandbox(aCx);
 156     nsresult rv = xpc->CreateSandbox(aCx, nullPrincipal, sandbox.address());
 157     if (NS_WARN_IF(NS_FAILED(rv))) {
 158       return nullptr;
 159     }
 160
 161     mSandbox = new JSObjectHolder(aCx, sandbox);
 162   }
 163
 164   return mSandbox->GetJSObject();
 165 }
 166
 167 }  // namespace mozilla::dom