Changeset 106706 in webkit

Timestamp:

Feb 3, 2012, 4:22:32 PM (15 years ago)

Author:

beidson@apple.com

Message:

2012-02-03 Brady Eidson <​beidson@apple.com>

<rdar://problem/10742441> and ​https://bugs.webkit.org/show_bug.cgi?id=77766
Need a WK2 API to filter which subframes go into WebArchives as they are created.

Reviewed by Darin Adler.

Source/WebCore:

This adds a filter callback object that allows clients to get called back for each
subframe that might be added to a WebArchive.

API only, No new layout tests.

• WebCore.exp.in:
• loader/archive/cf/LegacyWebArchive.cpp:

(WebCore::LegacyWebArchive::create):
(WebCore::LegacyWebArchive::createFromSelection):

• loader/archive/cf/LegacyWebArchive.h:

(FrameFilter):
(WebCore:: FrameFilter::~ FrameFilter):
(LegacyWebArchive):

Source/WebKit2:

Add a new WKBundleFrame API that takes a filter callback object to allow or reject
subframes from a WebArchive:

• WebProcess/InjectedBundle/API/c/WKBundleFrame.cpp:

(WKBundleFrameCopyWebArchive):
(WKBundleFrameCopyWebArchiveFilteringSubframes):

• WebProcess/InjectedBundle/API/c/WKBundleFrame.h:

Implement the above API by calling through to WebCore:

• WebProcess/WebPage/WebFrame.cpp:

(WebFrameFilter):
(WebKit::WebFrameFilter::WebFrameFilter):
(WebKit::WebFrameFilter::shouldIncludeSubframe):
(WebKit::WebFrame::webArchiveData):

• WebProcess/WebPage/WebFrame.h:

(WebFrame):

• WebProcess/WebPage/WebPage.cpp:

(WebKit::WebPage::getWebArchiveOfFrame):

Location:

trunk/Source

Files:

• WebCore/ChangeLog (modified) (1 diff)
• WebCore/WebCore.exp.in (modified) (1 diff)
• WebCore/loader/archive/cf/LegacyWebArchive.cpp (modified) (5 diffs)
• WebCore/loader/archive/cf/LegacyWebArchive.h (modified) (3 diffs)
• WebKit2/ChangeLog (modified) (1 diff)
• WebKit2/WebProcess/InjectedBundle/API/c/WKBundleFrame.cpp (modified) (1 diff)
• WebKit2/WebProcess/InjectedBundle/API/c/WKBundleFrame.h (modified) (1 diff)
• WebKit2/WebProcess/WebPage/WebFrame.cpp (modified) (2 diffs)
• WebKit2/WebProcess/WebPage/WebFrame.h (modified) (2 diffs)
• WebKit2/WebProcess/WebPage/WebPage.cpp (modified) (1 diff)

trunk/Source/WebCore/ChangeLog

@@ +1 @@
+2012-02-03  Brady Eidson  <beidson@apple.com>
+
+        <rdar://problem/10742441> and https://bugs.webkit.org/show_bug.cgi?id=77766
+        Need a WK2 API to filter which subframes go into WebArchives as they are created.
+
+        Reviewed by Darin Adler.
+
+        This adds a filter callback object that allows clients to get called back for each
+        subframe that might be added to a WebArchive.
+
+        API only, No new layout tests.
+
+        * WebCore.exp.in:
+        * loader/archive/cf/LegacyWebArchive.cpp:
+        (WebCore::LegacyWebArchive::create):
+        (WebCore::LegacyWebArchive::createFromSelection):
+        * loader/archive/cf/LegacyWebArchive.h:
+        (FrameFilter):
+        (WebCore:: FrameFilter::~ FrameFilter):
+        (LegacyWebArchive):
+
 2012-02-03  Joshua Bell  <jsbell@chromium.org>
 

trunk/Source/WebCore/WebCore.exp.in

@@ -495 +495 @@
 __ZN7WebCore16LegacyWebArchive6createEN3WTF10PassRefPtrINS_15ArchiveResourceEEERNS1_6VectorIS4_Lm0EEERNS5_INS2_IS0_EELm0EEE
 __ZN7WebCore16LegacyWebArchive6createEPNS_12SharedBufferE
-__ZN7WebCore16LegacyWebArchive6createEPNS_4NodeE
+__ZN7WebCore16LegacyWebArchive6createEPNS_4NodeEPNS_11FrameFilterE
 __ZN7WebCore16LegacyWebArchive6createEPNS_5FrameE
 __ZN7WebCore16LegacyWebArchive6createEPNS_5RangeE

trunk/Source/WebCore/loader/archive/cf/LegacyWebArchive.cpp

@@ -429 +429 @@
 #endif
 
-PassRefPtr<LegacyWebArchive> LegacyWebArchive::create(Node* node)
+PassRefPtr<LegacyWebArchive> LegacyWebArchive::create(Node* node, FrameFilter* filter)
 {
     ASSERT(node);
@@ -446 +446 @@
         markupString = frame->documentTypeString() + markupString;
 
-    return create(markupString, frame, nodeList);
+    return create(markupString, frame, nodeList, filter);
 }
 
@@ -495 +495 @@
     String markupString = frame->documentTypeString() + createMarkup(range, &nodeList, AnnotateForInterchange);
 
-    return create(markupString, frame, nodeList);
-}
-
-PassRefPtr<LegacyWebArchive> LegacyWebArchive::create(const String& markupString, Frame* frame, const Vector<Node*>& nodes)
+    return create(markupString, frame, nodeList, 0);
+}
+
+PassRefPtr<LegacyWebArchive> LegacyWebArchive::create(const String& markupString, Frame* frame, const Vector<Node*>& nodes, FrameFilter* frameFilter)
 {
     ASSERT(frame);
@@ -522 +522 @@
         if ((node->hasTagName(HTMLNames::frameTag) || node->hasTagName(HTMLNames::iframeTag) || node->hasTagName(HTMLNames::objectTag)) &&
              (childFrame = static_cast<HTMLFrameOwnerElement*>(node)->contentFrame())) {
-            RefPtr<LegacyWebArchive> subframeArchive = create(childFrame->document());
+            if (frameFilter && !frameFilter->shouldIncludeSubframe(childFrame))
+                continue;
+                
+            RefPtr<LegacyWebArchive> subframeArchive = create(childFrame->document(), frameFilter);
             
             if (subframeArchive)
@@ -585 +588 @@
     String markupString = frame->documentTypeString() + createMarkup(selectionRange.get(), &nodeList, AnnotateForInterchange);
     
-    RefPtr<LegacyWebArchive> archive = create(markupString, frame, nodeList);
+    RefPtr<LegacyWebArchive> archive = create(markupString, frame, nodeList, 0);
     
     if (!frame->document() || !frame->document()->isFrameSet())

trunk/Source/WebCore/loader/archive/cf/LegacyWebArchive.h

@@ -38 +38 @@
 class Range;
 
+class FrameFilter {
+public:
+    virtual ~FrameFilter() { }
+    virtual bool shouldIncludeSubframe(Frame*) const = 0;
+};
+
 class LegacyWebArchive : public Archive {
 public:
@@ -44 +50 @@
     static PassRefPtr<LegacyWebArchive> create(const KURL&, SharedBuffer*);
     static PassRefPtr<LegacyWebArchive> create(PassRefPtr<ArchiveResource> mainResource, Vector<PassRefPtr<ArchiveResource> >& subresources, Vector<PassRefPtr<LegacyWebArchive> >& subframeArchives);
-    static PassRefPtr<LegacyWebArchive> create(Node*);
+    static PassRefPtr<LegacyWebArchive> create(Node*, FrameFilter* = 0);
     static PassRefPtr<LegacyWebArchive> create(Frame*);
     static PassRefPtr<LegacyWebArchive> createFromSelection(Frame*);
@@ -58 +64 @@
     enum MainResourceStatus { Subresource, MainResource };
 
-    static PassRefPtr<LegacyWebArchive> create(const String& markupString, Frame*, const Vector<Node*>& nodes);
+    static PassRefPtr<LegacyWebArchive> create(const String& markupString, Frame*, const Vector<Node*>& nodes, FrameFilter*);
     static PassRefPtr<ArchiveResource> createResource(CFDictionaryRef);
     static ResourceResponse createResourceResponseFromMacArchivedData(CFDataRef);

trunk/Source/WebKit2/ChangeLog

@@ +1 @@
+2012-02-03  Brady Eidson  <beidson@apple.com>
+
+        <rdar://problem/10742441> and https://bugs.webkit.org/show_bug.cgi?id=77766
+        Need a WK2 API to filter which subframes go into WebArchives as they are created.
+
+        Reviewed by Darin Adler.
+
+        Add a new WKBundleFrame API that takes a filter callback object to allow or reject
+        subframes from a WebArchive:
+        * WebProcess/InjectedBundle/API/c/WKBundleFrame.cpp:
+        (WKBundleFrameCopyWebArchive):
+        (WKBundleFrameCopyWebArchiveFilteringSubframes):
+        * WebProcess/InjectedBundle/API/c/WKBundleFrame.h:
+
+        Implement the above API by calling through to WebCore:
+        * WebProcess/WebPage/WebFrame.cpp:
+        (WebFrameFilter):
+        (WebKit::WebFrameFilter::WebFrameFilter):
+        (WebKit::WebFrameFilter::shouldIncludeSubframe):
+        (WebKit::WebFrame::webArchiveData):
+        * WebProcess/WebPage/WebFrame.h:
+        (WebFrame):
+
+        * WebProcess/WebPage/WebPage.cpp:
+        (WebKit::WebPage::getWebArchiveOfFrame):
+
 2012-02-03  Alexey Proskuryakov  <ap@apple.com>
 

trunk/Source/WebKit2/WebProcess/InjectedBundle/API/c/WKBundleFrame.cpp

@@ -250 +250 @@
 WKDataRef WKBundleFrameCopyWebArchive(WKBundleFrameRef frameRef)
 {
+    return WKBundleFrameCopyWebArchiveFilteringSubframes(frameRef, 0, 0);
+}
+
+WKDataRef WKBundleFrameCopyWebArchiveFilteringSubframes(WKBundleFrameRef frameRef, WKBundleFrameFrameFilterCallback frameFilterCallback, void* context)
+{
 #if PLATFORM(MAC) || PLATFORM(WIN)
-    RetainPtr<CFDataRef> data = toImpl(frameRef)->webArchiveData();
+    RetainPtr<CFDataRef> data = toImpl(frameRef)->webArchiveData(frameFilterCallback, context);
     if (data)
         return WKDataCreate(CFDataGetBytePtr(data.get()), CFDataGetLength(data.get()));

trunk/Source/WebKit2/WebProcess/InjectedBundle/API/c/WKBundleFrame.h

@@ -72 +72 @@
 WK_EXPORT WKStringRef WKBundleFrameCopySuggestedFilenameForResourceWithURL(WKBundleFrameRef frame, WKURLRef url);
 WK_EXPORT WKStringRef WKBundleFrameCopyMIMETypeForResourceWithURL(WKBundleFrameRef frame, WKURLRef url);
-    
+
 WK_EXPORT WKDataRef WKBundleFrameCopyWebArchive(WKBundleFrameRef frame);
+
+typedef bool (*WKBundleFrameFrameFilterCallback)(WKBundleFrameRef frame, WKBundleFrameRef subframe, void* context);
+WK_EXPORT WKDataRef WKBundleFrameCopyWebArchiveFilteringSubframes(WKBundleFrameRef frame, WKBundleFrameFrameFilterCallback frameFilterCallback, void* context);
 
 #ifdef __cplusplus

trunk/Source/WebKit2/WebProcess/WebPage/WebFrame.cpp

@@ -31 +31 @@
 #include "InjectedBundleRangeHandle.h"
 #include "InjectedBundleScriptWorld.h"
+#include "WKAPICast.h"
+#include "WKBundleAPICast.h"
 #include "WebChromeClient.h"
 #include "WebPage.h"
@@ -735 +737 @@
 
 #if PLATFORM(MAC) || PLATFORM(WIN)
-RetainPtr<CFDataRef> WebFrame::webArchiveData() const
-{
-    if (RefPtr<LegacyWebArchive> archive = LegacyWebArchive::create(coreFrame()->document()))
+
+class WebFrameFilter : public FrameFilter {
+public:
+    WebFrameFilter(WebFrame*, WebFrame::FrameFilterFunction, void* context);
+        
+private:
+    virtual bool shouldIncludeSubframe(Frame*) const OVERRIDE;
+
+    WebFrame* m_topLevelWebFrame;
+    WebFrame::FrameFilterFunction m_callback;
+    void* m_context;
+};
+
+WebFrameFilter::WebFrameFilter(WebFrame* topLevelWebFrame, WebFrame::FrameFilterFunction callback, void* context)
+    : m_topLevelWebFrame(topLevelWebFrame)
+    , m_callback(callback)
+    , m_context(context)
+{
+}
+
+bool WebFrameFilter::shouldIncludeSubframe(Frame* frame) const
+{
+    if (!m_callback)
+        return true;
+        
+    WebFrame* webFrame = static_cast<WebFrameLoaderClient*>(frame->loader()->client())->webFrame();
+    return m_callback(toAPI(m_topLevelWebFrame), toAPI(webFrame), m_context);
+}
+
+RetainPtr<CFDataRef> WebFrame::webArchiveData(FrameFilterFunction callback, void* context)
+{
+    WebFrameFilter filter(this, callback, context);
+
+    if (RefPtr<LegacyWebArchive> archive = LegacyWebArchive::create(coreFrame()->document(), &filter))
         return archive->rawDataRepresentation();
     

trunk/Source/WebKit2/WebProcess/WebPage/WebFrame.h

@@ -29 +29 @@
 #include "APIObject.h"
 #include "ImmutableArray.h"
+#include "WKBase.h"
 #include "WebFrameLoaderClient.h"
 #include <JavaScriptCore/JSBase.h>
@@ -138 +139 @@
     
 #if PLATFORM(MAC) || PLATFORM(WIN)
-    RetainPtr<CFDataRef> webArchiveData() const;
+    typedef bool (*FrameFilterFunction)(WKBundleFrameRef, WKBundleFrameRef subframe, void* context);
+    RetainPtr<CFDataRef> webArchiveData(FrameFilterFunction, void* context);
 #endif
 

trunk/Source/WebKit2/WebProcess/WebPage/WebPage.cpp

@@ -1798 +1798 @@
     RetainPtr<CFDataRef> data;
     if (WebFrame* frame = WebProcess::shared().webFrame(frameID)) {
-        if ((data = frame->webArchiveData()))
+        if ((data = frame->webArchiveData(0, 0)))
             dataReference = CoreIPC::DataReference(CFDataGetBytePtr(data.get()), CFDataGetLength(data.get()));
     }