Apply script preprocessor to Web page scripts only.

Source/bindings/v8/ScriptController.cpp

 /*
  * Copyright (C) 2008, 2009 Google Inc. All rights reserved.
  * Copyright (C) 2009 Apple Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are
  * met:
  *
  *     * Redistributions of source code must retain the above copyright
  * notice, this list of conditions and the following disclaimer.
@@ skipping 20 matching lines @@
 
 #include "config.h"
 #include "bindings/v8/ScriptController.h"
 
 #include "V8Event.h"
 #include "V8HTMLElement.h"
 #include "V8Window.h"
 #include "bindings/v8/BindingSecurity.h"
 #include "bindings/v8/NPV8Object.h"
 #include "bindings/v8/ScriptCallStackFactory.h"
+#include "bindings/v8/ScriptPreprocessor.h"
 #include "bindings/v8/ScriptSourceCode.h"
 #include "bindings/v8/ScriptValue.h"
 #include "bindings/v8/V8Binding.h"
 #include "bindings/v8/V8GCController.h"
 #include "bindings/v8/V8HiddenPropertyName.h"
 #include "bindings/v8/V8NPObject.h"
 #include "bindings/v8/V8PerContextData.h"
 #include "bindings/v8/V8ScriptRunner.h"
 #include "bindings/v8/V8WindowShell.h"
 #include "bindings/v8/npruntime_impl.h"
@@ skipping 457 matching lines @@
 
 void ScriptController::clearWindowShell()
 {
     double start = currentTime();
     // V8 binding expects ScriptController::clearWindowShell only be called
     // when a frame is loading a new page. This creates a new context for the new page.
     m_windowShell->clearForNavigation();
     for (IsolatedWorldMap::iterator iter = m_isolatedWorlds.begin(); iter != m_isolatedWorlds.end(); ++iter)
         iter->value->clearForNavigation();
     V8GCController::hintForCollectGarbage();
+    clearScriptPreprocessor();
     HistogramSupport::histogramCustomCounts("WebCore.ScriptController.clearWindowShell", (currentTime() - start) * 1000, 0, 10000, 50);
 }
 
 void ScriptController::setCaptureCallStackForUncaughtExceptions(bool value)
 {
     v8::V8::SetCaptureStackTraceForUncaughtExceptions(value, ScriptCallStack::maxCallStackSizeToCapture, stackTraceOptions);
 }
 
 void ScriptController::collectIsolatedContexts(Vector<std::pair<ScriptState*, SecurityOrigin*> >& result)
 {
@@ skipping 111 matching lines @@
 
     String scriptResult;
     if (!result.getString(scriptResult))
         return true;
 
     // We're still in a frame, so there should be a DocumentLoader.
     ASSERT(m_frame->document()->loader());
 
     if (!locationChangeBefore && m_frame->navigationScheduler()->locationChangePending())
         return true;
-        
+
     // DocumentWriter::replaceDocument can cause the DocumentLoader to get deref'ed and possible destroyed,
     // so protect it with a RefPtr.
     if (RefPtr<DocumentLoader> loader = m_frame->document()->loader())
         loader->replaceDocument(scriptResult, ownerDocument.get());
     return true;
 }
 
 ScriptValue ScriptController::executeScriptInMainWorld(const ScriptSourceCode& sourceCode)
 {
     String sourceURL = sourceCode.url();
     const String* savedSourceURL = m_sourceURL;
     m_sourceURL = &sourceURL;
 
     v8::HandleScope handleScope;
     v8::Handle<v8::Context> v8Context = ScriptController::mainWorldContext(m_frame);
     if (v8Context.IsEmpty())
         return ScriptValue();
 
+    String processedString = m_frame->script()->preprocess(sourceCode.source(), sourceURL);

[haraken, 2013/07/11 01:13:59]

What's the difference between preprocess() and m_frame->script()->preprocess() ?

[johnjbarton, 2013/07/11 19:14:42]

Done.

+    ScriptSourceCode processedSourceCode(processedString, sourceCode.url(), sourceCode.startPosition());
+
     v8::Context::Scope scope(v8Context);
     RefPtr<Frame> protect(m_frame);
-    v8::Local<v8::Value> object = compileAndRunScript(sourceCode);
+    v8::Local<v8::Value> object = compileAndRunScript(processedSourceCode);
 
     m_sourceURL = savedSourceURL;
 
     if (object.IsEmpty())
         return ScriptValue();
 
     return ScriptValue(object);
 }
 
 void ScriptController::executeScriptInIsolatedWorld(int worldID, const Vector<ScriptSourceCode>& sources, int extensionGroup, Vector<ScriptValue>* results)
@@ skipping 23 matching lines @@
 
         v8Results = evaluateHandleScope.Close(resultArray);
     }
 
     if (results && !v8Results.IsEmpty()) {
         for (size_t i = 0; i < v8Results->Length(); ++i)
             results->append(ScriptValue(v8Results->Get(i)));
     }
 }
 
+bool ScriptController::hasScriptPreprocessor()
+{
+    return m_scriptPreprocessor && m_scriptPreprocessor->hasPreprocessorFunction();
+}
+
+bool ScriptController::isPreprocessingScript()
+{
+    return hasScriptPreprocessor() && m_scriptPreprocessor->isPreprocessing();
+}
+
+void ScriptController::setScriptPreprocessor(const String& preprocessorBody)
+{
+    // We delay the creation of the preprocess until just before the first JS from the
+    // Web page to ensure that the debugger's console initialization code has completed.
+    m_preprocessorSource = preprocessorBody;
+}
+
+void ScriptController::clearScriptPreprocessor()
+{
+    m_scriptPreprocessor.clear();
+    m_preprocessorSource = String();
+}
+
+String ScriptController::preprocess(const String& scriptSource, const String& scriptName)

[haraken, 2013/07/11 01:13:59]

Would you add a comment here about the exact condition under which the
preprocessing is conducted?

[johnjbarton, 2013/07/11 19:14:42]

Done. (The comment was also in the .h file).

+{
+    if (m_preprocessorSource.isEmpty())
+        return scriptSource;
+
+    if (!m_frame->page())
+        return scriptSource;
+
+    if (!m_scriptPreprocessor)
+        m_scriptPreprocessor = adoptPtr(new ScriptPreprocessor(m_preprocessorSource, this, m_frame->page()->console()));
+
+    if (!m_scriptPreprocessor->hasPreprocessorFunction())
+        return scriptSource;
+
+    return m_scriptPreprocessor->preprocessSourceCode(scriptSource, scriptName);
+}

[haraken, 2013/07/11 01:13:59]

I'm not happy with having a lot of proxy methods to ScriptPreprocessor. Also the
methods are not well organized. (Do we really need all of hasScriptPreprocess,
isPreprocessing, m_preprocessor.isEmpty, m_scriptPreprocessor etc ?) It's very
confusing when we should check what. Please clean up the methods.

[johnjbarton, 2013/07/11 19:14:42]

Two objectives lead to proxy methods:
  1) encapsulate the ScriptPreprocessor to avoid distributing the logic for its
lazy creation (lazy creation motivated by avoiding entangling preprocessing and
console script injection).
  2) conditional access to the ScriptPreprocessor by ScriptDebugServer for
eval() processing. 

I think #1 is important. 

To avoid #2 we would have to call into the debugger-specific functions of
ScriptDebugServer from ScriptPreprocessor. I implemented this version for your
evaluation.

Of course my logic could be flawed or there may be another solution.

+
+
 } // namespace WebCore