blob: c7ca49c3aa9785eef6bf3c01c1bdd5b99c035f69 [file] [log] [blame]
// Copyright 2015 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include <stdint.h>
#include <map>
#include <string>
#include "base/callback.h"
#include "base/macros.h"
#include "base/memory/ref_counted.h"
#include "base/memory/weak_ptr.h"
#include "components/offline_pages/core/offline_page_archiver.h"
#include "content/public/common/page_type.h"
namespace base {
class FilePath;
} // namespace base
namespace content {
class WebContents;
} // namespace content
namespace offline_pages {
// Class implementing an offline page archiver using MHTML as an archive format.
// To generate an MHTML archiver for a given URL, a WebContents instance should
// have that URL loaded.
// Example:
// void SavePageOffline(content::WebContents* web_contents) {
// const GURL& url = web_contents->GetLastCommittedURL();
// std::unique_ptr<OfflinePageMHTMLArchiver> archiver(
// new OfflinePageMHTMLArchiver(
// web_contents, archive_dir));
// // Callback is of type OfflinePageModel::SavePageCallback.
// model->SavePage(url, std::move(archiver), callback);
// }
// TODO( turn this into a singleton.
class OfflinePageMHTMLArchiver : public OfflinePageArchiver {
~OfflinePageMHTMLArchiver() override;
// OfflinePageArchiver implementation:
void CreateArchive(const base::FilePath& archives_dir,
const CreateArchiveParams& create_archive_params,
content::WebContents* web_contents,
CreateArchiveCallback callback) override;
// Try to generate MHTML.
// Might be overridden for testing purpose.
virtual void GenerateMHTML(const base::FilePath& archives_dir,
content::WebContents* web_contents,
const CreateArchiveParams& create_archive_params);
// Callback for Generating MHTML.
void OnGenerateMHTMLDone(const GURL& url,
const base::FilePath& file_path,
const base::string16& title,
int64_t file_size);
void OnComputeDigestDone(const GURL& url,
const base::FilePath& file_path,
const base::string16& title,
int64_t file_size,
const std::string& digest);
// Checks whether the page to be saved has security error when loaded over
// HTTPS. Saving a page will fail if that is the case. HTTP connections are
// not affected.
virtual bool HasConnectionSecurityError(content::WebContents* web_contents);
// Returns the page type of the page being saved.
virtual content::PageType GetPageType(content::WebContents* web_contents);
// Reports failure to create archive a page to the client that requested it.
void ReportFailure(ArchiverResult result);
void DeleteFileAndReportFailure(const base::FilePath& file_path,
ArchiverResult result);
CreateArchiveCallback callback_;
base::WeakPtrFactory<OfflinePageMHTMLArchiver> weak_ptr_factory_;
} // namespace offline_pages