Adds a feature to MHTML serialization that omits subframes and subresources marked no-store.

third_party/WebKit/Source/web/WebFrameSerializer.cpp

 /*
  * Copyright (C) 2009 Google 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.
  *     * Redistributions in binary form must reproduce the above
@@ skipping 29 matching lines @@
 #include "core/html/HTMLAllCollection.h"
 #include "core/html/HTMLFrameElementBase.h"
 #include "core/html/HTMLFrameOwnerElement.h"
 #include "core/html/HTMLInputElement.h"
 #include "core/html/HTMLTableElement.h"
 #include "core/loader/DocumentLoader.h"
 #include "platform/SerializedResource.h"
 #include "platform/SharedBuffer.h"
 #include "platform/mhtml/MHTMLArchive.h"
 #include "platform/mhtml/MHTMLParser.h"
+#include "platform/network/ResourceRequest.h"
 #include "platform/network/ResourceResponse.h"
 #include "platform/weborigin/KURL.h"
 #include "public/platform/WebString.h"
 #include "public/platform/WebURL.h"
 #include "public/platform/WebURLResponse.h"
 #include "public/platform/WebVector.h"
 #include "public/web/WebDataSource.h"
 #include "public/web/WebDocument.h"
 #include "public/web/WebFrame.h"
 #include "public/web/WebFrameSerializerCacheControlPolicy.h"
@@ skipping 11 matching lines @@
 namespace blink {
 
 namespace {
 
 class MHTMLFrameSerializerDelegate final : public FrameSerializer::Delegate {
     WTF_MAKE_NONCOPYABLE(MHTMLFrameSerializerDelegate);
 public:
     explicit MHTMLFrameSerializerDelegate(WebFrameSerializer::MHTMLPartsGenerationDelegate&);
     bool shouldIgnoreAttribute(const Attribute&) override;
     bool rewriteLink(const Element&, String& rewrittenLink) override;
-    bool shouldSkipResource(const KURL&) override;
+    bool shouldSkipResourceWithURL(const KURL&) override;
+    bool shouldSkipResource(Resource*) override;
 
 private:
     WebFrameSerializer::MHTMLPartsGenerationDelegate& m_webDelegate;
+    WebFrameSerializerCacheControlPolicy m_cacheControlPolicy = WebFrameSerializerCacheControlPolicy::None;
 };
 
 MHTMLFrameSerializerDelegate::MHTMLFrameSerializerDelegate(
     WebFrameSerializer::MHTMLPartsGenerationDelegate& webDelegate)
     : m_webDelegate(webDelegate)
 {
 }
 
 bool MHTMLFrameSerializerDelegate::shouldIgnoreAttribute(const Attribute& attribute)
 {
@@ skipping 33 matching lines @@
             || doc->isXHTMLDocument() || doc->isImageDocument();
         if (isHandledBySerializer) {
             rewrittenLink = cidURI.getString();
             return true;
         }
     }
 
     return false;
 }
 
-bool MHTMLFrameSerializerDelegate::shouldSkipResource(const KURL& url)
+bool MHTMLFrameSerializerDelegate::shouldSkipResourceWithURL(const KURL& url)
 {
     return m_webDelegate.shouldSkipResource(url);
 }
 
+bool MHTMLFrameSerializerDelegate::shouldSkipResource(Resource* resource)
+{
+    DCHECK(resource);
+    return m_cacheControlPolicy == WebFrameSerializerCacheControlPolicy::SkipAnyFrameOrResourceMarkedNoStore && resource->hasCacheControlNoStoreHeader();
+}
+
+bool cacheControlNoStoreHeaderPresent(WebLocalFrameImpl* webLocalFrameImpl)

[Dmitry Titov, 2016/05/18 00:18:47]

It's probably better to just inline this function since it's only used once.

[dewittj, 2016/05/19 04:13:17]

To me it was confusing when written inline.  This makes it clear what the return
value depends on (no-store header present) and how to calculate that value.  Do
you mind if I leave this as-is?

+{
+    const ResourceResponse& response = webLocalFrameImpl->dataSource()->response().toResourceResponse();
+    if (response.cacheControlContainsNoStore())
+        return true;
+
+    const ResourceRequest& request = webLocalFrameImpl->dataSource()->request().toResourceRequest();
+    return request.cacheControlContainsNoStore();
+}
+
 } // namespace
 
-bool WebFrameSerializer::generateMHTMLHeader(
-    const WebString& boundary, WebFrameSerializerCacheControlPolicy cacheControlPolicy,
-    WebLocalFrame* frame, WebData* data)
+bool WebFrameSerializer::frameShouldBeSerializedAsMHTML(
+    WebLocalFrame* frame, MHTMLPartsGenerationDelegate* delegate)
 {
+    DCHECK(delegate);
+    DCHECK(frame);
+
     WebLocalFrameImpl* webLocalFrameImpl = toWebLocalFrameImpl(frame);
     DCHECK(webLocalFrameImpl);
 
-    if (cacheControlPolicy == WebFrameSerializerCacheControlPolicy::FailForNoStoreMainFrame) {
-        const ResourceResponse& response = webLocalFrameImpl->dataSource()->response().toResourceResponse();
-        if (response.cacheControlContainsNoStore())
-            return false;
-    }
+    WebFrameSerializerCacheControlPolicy cacheControlPolicy = delegate->cacheControlPolicy();
+    if (cacheControlPolicy == WebFrameSerializerCacheControlPolicy::None)
+        return true;
+
+    bool needToCheckNoStore = cacheControlPolicy == WebFrameSerializerCacheControlPolicy::SkipAnyFrameOrResourceMarkedNoStore
+        || (!frame->parent() && cacheControlPolicy == WebFrameSerializerCacheControlPolicy::FailForNoStoreMainFrame);
+
+    if (!needToCheckNoStore)
+        return true;
+
+    return !cacheControlNoStoreHeaderPresent(webLocalFrameImpl);
+}
+
+WebData WebFrameSerializer::generateMHTMLHeader(
+    const WebString& boundary, WebLocalFrame* frame, MHTMLPartsGenerationDelegate* delegate)
+{
+    DCHECK(frameShouldBeSerializedAsMHTML(frame, delegate));
+
+    WebLocalFrameImpl* webLocalFrameImpl = toWebLocalFrameImpl(frame);
+    DCHECK(webLocalFrameImpl);
 
     Document* document = webLocalFrameImpl->frame()->document();
 
     RefPtr<SharedBuffer> buffer = SharedBuffer::create();
     MHTMLArchive::generateMHTMLHeader(
         boundary, document->title(), document->suggestedMIMEType(),
         *buffer);
-    *data = buffer.release();
-    return true;
+    return buffer.release();
 }
 
 WebData WebFrameSerializer::generateMHTMLParts(
-    const WebString& boundary, WebLocalFrame* webFrame, bool useBinaryEncoding,
-    MHTMLPartsGenerationDelegate* webDelegate)
+    const WebString& boundary, WebLocalFrame* webFrame, MHTMLPartsGenerationDelegate* webDelegate)
 {
     DCHECK(webFrame);
     DCHECK(webDelegate);
+    DCHECK(frameShouldBeSerializedAsMHTML(webFrame, webDelegate));

[Dmitry Titov, 2016/05/18 00:18:47]

These DCHECKS look complex and might not add any safety since it's mostly
(only?) tests that run debug build... I'd remove for clarity, but your call.

[dewittj, 2016/05/19 04:13:17]

Done.

 
     // Translate arguments from public to internal blink APIs.
     LocalFrame* frame = toWebLocalFrameImpl(webFrame)->frame();
-    MHTMLArchive::EncodingPolicy encodingPolicy = useBinaryEncoding
+    MHTMLArchive::EncodingPolicy encodingPolicy = webDelegate->useBinaryEncoding()
         ? MHTMLArchive::EncodingPolicy::UseBinaryEncoding
         : MHTMLArchive::EncodingPolicy::UseDefaultEncoding;
 
     // Serialize.
     Vector<SerializedResource> resources;
     MHTMLFrameSerializerDelegate coreDelegate(*webDelegate);
     FrameSerializer serializer(resources, coreDelegate);
     serializer.serializeFrame(*frame);
 
     // Get Content-ID for the frame being serialized.
@@ skipping 50 matching lines @@
 WebString WebFrameSerializer::generateBaseTagDeclaration(const WebString& baseTarget)
 {
     // TODO(yosin) We should call |FrameSerializer::baseTagDeclarationOf()|.
     if (baseTarget.isEmpty())
         return String("<base href=\".\">");
     String baseString = "<base href=\".\" target=\"" + static_cast<const String&>(baseTarget) + "\">";
     return baseString;
 }
 
 } // namespace blink