1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133
|
/*
* Copyright (C) 2011 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
* copyright notice, this list of conditions and the following disclaimer
* in the documentation and/or other materials provided with the
* distribution.
* * Neither the name of Google Inc. nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef THIRD_PARTY_BLINK_RENDERER_PLATFORM_MHTML_MHTML_ARCHIVE_H_
#define THIRD_PARTY_BLINK_RENDERER_PLATFORM_MHTML_MHTML_ARCHIVE_H_
#include "base/time/time.h"
#include "third_party/blink/public/mojom/loader/mhtml_load_result.mojom-blink-forward.h"
#include "third_party/blink/renderer/platform/heap/collection_support/heap_hash_map.h"
#include "third_party/blink/renderer/platform/heap/garbage_collected.h"
#include "third_party/blink/renderer/platform/weborigin/kurl.h"
#include "third_party/blink/renderer/platform/wtf/text/string_hash.h"
#include "third_party/blink/renderer/platform/wtf/vector.h"
namespace blink {
// When URIs use the "cid" (Content-ID) scheme, the resource refers to a
// specific body part in an MHTML multipart/related structure.
// See RFC n°2557, section-8.3: "Use of the Content-ID header and CID URLs".
const char kContentIdScheme[] = "cid";
class ArchiveResource;
class KURL;
struct SerializedResource;
class PLATFORM_EXPORT MHTMLArchive final
: public GarbageCollected<MHTMLArchive> {
public:
static MHTMLArchive* Create(const KURL&, scoped_refptr<const SharedBuffer>);
MHTMLArchive();
// Binary encoding results in smaller MHTML files but they might not work in
// other browsers.
enum EncodingPolicy { kUseDefaultEncoding, kUseBinaryEncoding };
// Generates an MHTML header and appends it to |outputBuffer|.
//
// Same |boundary| needs to be used for all generateMHTMLHeader and
// generateMHTMLPart and generateMHTMLFooter calls that belong to the same
// MHTML document (see also rfc1341, section 7.2.1, "boundary" description).
static void GenerateMHTMLHeader(const String& boundary,
const KURL&,
const String& title,
const String& mime_type,
base::Time date,
Vector<char>& output_buffer);
// Serializes SerializedResource as an MHTML part and appends it in
// |outputBuffer|.
//
// Same |boundary| needs to be used for all generateMHTMLHeader and
// generateMHTMLPart and generateMHTMLFooter calls that belong to the same
// MHTML document (see also rfc1341, section 7.2.1, "boundary" description).
//
// If |contentID| is non-empty, then it will be used as a Content-ID header.
// See rfc2557 - section 8.3 - "Use of the Content-ID header and CID URLs".
static void GenerateMHTMLPart(const String& boundary,
const String& content_id,
EncodingPolicy,
const SerializedResource&,
Vector<char>& output_buffer);
// Generates an MHTML footer and appends it to |outputBuffer| for testing
// purposes.
//
// Same |boundary| needs to be used for all generateMHTMLHeader and
// generateMHTMLPart and generateMHTMLFooter calls that belong to the same
// MHTML document (see also rfc1341, section 7.2.1, "boundary" description).
static void GenerateMHTMLFooterForTesting(const String& boundary,
Vector<char>& output_buffer);
typedef HeapHashMap<String, Member<ArchiveResource>> SubArchiveResources;
ArchiveResource* MainResource() const { return main_resource_.Get(); }
ArchiveResource* SubresourceForURL(const KURL&) const;
String GetCacheIdentifier() const;
// The purported creation date (as expressed by the Date: header).
base::Time Date() const { return date_; }
void Trace(Visitor*) const;
blink::mojom::MHTMLLoadResult LoadResult() const { return load_result_; }
private:
static MHTMLArchive* CreateArchive(const KURL&,
scoped_refptr<const SharedBuffer>);
static void ReportLoadResult(blink::mojom::MHTMLLoadResult result);
void SetMainResource(ArchiveResource*);
void AddSubresource(ArchiveResource*);
static bool CanLoadArchive(const KURL&);
// URL of the MHTML resource (e.g. file:///foo/bar.mhtml).
KURL archive_url_;
base::Time date_;
Member<ArchiveResource> main_resource_;
SubArchiveResources subresources_;
blink::mojom::MHTMLLoadResult load_result_;
};
} // namespace blink
#endif // THIRD_PARTY_BLINK_RENDERER_PLATFORM_MHTML_MHTML_ARCHIVE_H_
|