Google Git
Sign in
chromium / chromium / src / aef2881d5e51076d5256c21c3a673ce96aba8779 / . / pdf / pdfium / pdfium_engine.cc
blob: 063c12dff64b786504a2d233a790ca28753e32e0 [file] [log] [blame]
// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#if defined(UNSAFE_BUFFERS_BUILD)
// TODO(crbug.com/40284755): Remove this and spanify to fix the errors.
#pragma allow_unsafe_buffers
#endif
#include "pdf/pdfium/pdfium_engine.h"
#include <math.h>
#include <stddef.h>
#include <stdint.h>
#include <algorithm>
#include <limits>
#include <memory>
#include <set>
#include <string>
#include <utility>
#include "base/auto_reset.h"
#include "base/check_op.h"
#include "base/containers/contains.h"
#include "base/containers/flat_map.h"
#include "base/feature_list.h"
#include "base/functional/bind.h"
#include "base/location.h"
#include "base/metrics/histogram_functions.h"
#include "base/notreached.h"
#include "base/numerics/safe_conversions.h"
#include "base/strings/string_number_conversions.h"
#include "base/strings/string_util.h"
#include "base/strings/stringprintf.h"
#include "base/strings/utf_string_conversions.h"
#include "base/task/single_thread_task_runner.h"
#include "base/time/time.h"
#include "base/types/optional_util.h"
#include "build/build_config.h"
#include "gin/array_buffer.h"
#include "gin/public/gin_embedders.h"
#include "gin/public/isolate_holder.h"
#include "gin/public/v8_platform.h"
#include "pdf/accessibility_structs.h"
#include "pdf/buildflags.h"
#include "pdf/draw_utils/coordinates.h"
#include "pdf/draw_utils/shadow.h"
#include "pdf/input_utils.h"
#include "pdf/loader/document_loader_impl.h"
#include "pdf/loader/url_loader.h"
#include "pdf/loader/url_loader_wrapper_impl.h"
#include "pdf/pdf_features.h"
#include "pdf/pdf_transform.h"
#include "pdf/pdfium/pdfium_api_string_buffer_adapter.h"
#include "pdf/pdfium/pdfium_document.h"
#include "pdf/pdfium/pdfium_document_metadata.h"
#include "pdf/pdfium/pdfium_mem_buffer_file_write.h"
#include "pdf/pdfium/pdfium_permissions.h"
#include "pdf/pdfium/pdfium_unsupported_features.h"
#include "printing/mojom/print.mojom-shared.h"
#include "printing/units.h"
#include "third_party/blink/public/common/input/web_input_event.h"
#include "third_party/blink/public/common/input/web_keyboard_event.h"
#include "third_party/blink/public/common/input/web_mouse_event.h"
#include "third_party/blink/public/common/input/web_pointer_properties.h"
#include "third_party/blink/public/common/input/web_touch_event.h"
#include "third_party/blink/public/common/input/web_touch_point.h"
#include "third_party/blink/public/web/web_print_params.h"
#include "third_party/pdfium/public/cpp/fpdf_scopers.h"
#include "third_party/pdfium/public/fpdf_annot.h"
#include "third_party/pdfium/public/fpdf_attachment.h"
#include "third_party/pdfium/public/fpdf_catalog.h"
#include "third_party/pdfium/public/fpdf_ext.h"
#include "third_party/pdfium/public/fpdf_fwlevent.h"
#include "third_party/pdfium/public/fpdf_ppo.h"
#include "third_party/pdfium/public/fpdf_searchex.h"
#include "third_party/pdfium/public/fpdfview.h"
#include "third_party/skia/include/core/SkBitmap.h"
#include "third_party/skia/include/core/SkColor.h"
#include "ui/base/cursor/mojom/cursor_type.mojom-shared.h"
#include "ui/base/window_open_disposition_utils.h"
#include "ui/events/keycodes/keyboard_codes.h"
#include "ui/gfx/geometry/insets.h"
#include "ui/gfx/geometry/point.h"
#include "ui/gfx/geometry/point_conversions.h"
#include "ui/gfx/geometry/rect.h"
#include "ui/gfx/geometry/rect_f.h"
#include "ui/gfx/geometry/size.h"
#include "ui/gfx/geometry/vector2d.h"
#include "v8/include/v8.h"
#if defined(PDF_ENABLE_XFA)
#include "gin/public/cppgc.h"
#endif
#if BUILDFLAG(IS_LINUX) || BUILDFLAG(IS_CHROMEOS)
#include "pdf/pdfium/pdfium_font_linux.h"
#endif
#if BUILDFLAG(IS_WIN)
#include "pdf/pdfium/pdfium_font_win.h"
#endif
using printing::ConvertUnit;
using printing::ConvertUnitFloat;
using printing::kPixelsPerInch;
using printing::kPointsPerInch;
namespace chrome_pdf {
using FocusFieldType = PDFiumEngineClient::FocusFieldType;
namespace {
constexpr SkColor kHighlightColor = SkColorSetRGB(153, 193, 218);
constexpr uint32_t kPendingPageColor = 0xFFEEEEEE;
constexpr uint32_t kFormHighlightColor = 0xFFE4DD;
constexpr int32_t kFormHighlightAlpha = 100;
constexpr int kMaxPasswordTries = 3;
constexpr base::TimeDelta kTouchLongPressTimeout = base::Milliseconds(300);
// Windows has native panning capabilities. No need to use our own.
#if BUILDFLAG(IS_WIN)
constexpr bool kViewerImplementedPanning = false;
#else
constexpr bool kViewerImplementedPanning = true;
#endif
constexpr int32_t kLoadingTextVerticalOffset = 50;
// The maximum amount of time we'll spend doing a paint before we give back
// control of the thread.
constexpr base::TimeDelta kMaxProgressivePaintTime = base::Milliseconds(300);
// The maximum amount of time we'll spend doing the first paint. This is less
// than the above to keep things smooth if the user is scrolling quickly. This
// is set to 250 ms to give enough time for most PDFs to render, while avoiding
// adding too much latency to the display of the final image when the user
// stops scrolling.
// Setting a higher value has minimal benefit (scrolling at less than 4 fps will
// never be a great experience) and there is some cost, since when the user
// stops scrolling the in-progress painting has to complete or timeout before
// the final painting can start.
// The scrollbar will always be responsive since it is managed by a separate
// process.
constexpr base::TimeDelta kMaxInitialProgressivePaintTime =
base::Milliseconds(250);
FontMappingMode g_font_mapping_mode = FontMappingMode::kNoMapping;
template <class S>
bool IsAboveOrDirectlyLeftOf(const S& lhs, const S& rhs) {
return lhs.y() < rhs.y() || (lhs.y() == rhs.y() && lhs.x() < rhs.x());
}
int CalculateCenterForZoom(int center, int length, double zoom) {
int adjusted_center =
static_cast<int>(center * zoom) - static_cast<int>(length * zoom / 2);
return std::max(adjusted_center, 0);
}
// This formats a string with special 0xfffe end-of-line hyphens the same way
// as Adobe Reader. When a hyphen is encountered, the next non-CR/LF whitespace
// becomes CR+LF and the hyphen is erased. If there is no whitespace between
// two hyphens, the latter hyphen is erased and ignored.
void FormatStringWithHyphens(std::u16string* text) {
// First pass marks all the hyphen positions.
struct HyphenPosition {
HyphenPosition() : position(0), next_whitespace_position(0) {}
size_t position;
size_t next_whitespace_position; // 0 for none
};
std::vector<HyphenPosition> hyphen_positions;
HyphenPosition current_hyphen_position;
bool current_hyphen_position_is_valid = false;
constexpr char16_t kPdfiumHyphenEOL = 0xfffe;
for (size_t i = 0; i < text->size(); ++i) {
const char16_t& current_char = (*text)[i];
if (current_char == kPdfiumHyphenEOL) {
if (current_hyphen_position_is_valid)
hyphen_positions.push_back(current_hyphen_position);
current_hyphen_position = HyphenPosition();
current_hyphen_position.position = i;
current_hyphen_position_is_valid = true;
} else if (base::IsUnicodeWhitespace(current_char)) {
if (current_hyphen_position_is_valid) {
if (current_char != L'\r' && current_char != L'\n')
current_hyphen_position.next_whitespace_position = i;
hyphen_positions.push_back(current_hyphen_position);
current_hyphen_position_is_valid = false;
}
}
}
if (current_hyphen_position_is_valid)
hyphen_positions.push_back(current_hyphen_position);
// With all the hyphen positions, do the search and replace.
while (!hyphen_positions.empty()) {
static constexpr char16_t kCr[] = {L'\r', L'\0'};
const HyphenPosition& position = hyphen_positions.back();
if (position.next_whitespace_position != 0) {
(*text)[position.next_whitespace_position] = L'\n';
text->insert(position.next_whitespace_position, kCr);
}
text->erase(position.position, 1);
hyphen_positions.pop_back();
}
// Adobe Reader also get rid of trailing spaces right before a CRLF.
static constexpr char16_t kSpaceCrCn[] = {L' ', L'\r', L'\n', L'\0'};
static constexpr char16_t kCrCn[] = {L'\r', L'\n', L'\0'};
base::ReplaceSubstringsAfterOffset(text, 0, kSpaceCrCn, kCrCn);
}
// Replace CR/LF with just LF on POSIX and Fuchsia.
void FormatStringForOS(std::u16string* text) {
#if BUILDFLAG(IS_POSIX) || BUILDFLAG(IS_FUCHSIA)
static constexpr char16_t kCr[] = {L'\r', L'\0'};
static constexpr char16_t kBlank[] = {L'\0'};
base::ReplaceChars(*text, kCr, kBlank, text);
#elif BUILDFLAG(IS_WIN)
// Do nothing
#else
NOTIMPLEMENTED();
#endif
}
// Returns true if `cur` is a character to break on.
// For double clicks, look for work breaks.
// For triple clicks, look for line breaks.
// The actual algorithm used in Blink is much more complicated, so do a simple
// approximation.
bool FindMultipleClickBoundary(bool is_double_click, char16_t cur) {
if (!is_double_click)
return cur == '\n';
// Deal with ASCII characters.
if (base::IsAsciiAlpha(cur) || base::IsAsciiDigit(cur) || cur == '_')
return false;
if (cur < 128)
return true;
if (cur == kZeroWidthSpace)
return true;
return false;
}
#if defined(PDF_ENABLE_V8)
gin::IsolateHolder* g_isolate_holder = nullptr;
bool IsV8Initialized() {
return !!g_isolate_holder;
}
void SetUpV8() {
if (!gin::IsolateHolder::Initialized()) {
// TODO(crbug.com/40142415): V8 flags for the PDF Viewer need to be set up
// as soon as the renderer process is created in the constructor of
// `content::RenderProcessImpl`.
const char* recommended = FPDF_GetRecommendedV8Flags();
v8::V8::SetFlagsFromString(recommended, strlen(recommended));
// The isolate holder is already initialized in the renderer process.
gin::IsolateHolder::Initialize(gin::IsolateHolder::kNonStrictMode,
gin::ArrayBufferAllocator::SharedInstance());
}
DCHECK(!g_isolate_holder);
g_isolate_holder =
new gin::IsolateHolder(base::SingleThreadTaskRunner::GetCurrentDefault(),
gin::IsolateHolder::kSingleThread,
gin::IsolateHolder::IsolateType::kUtility);
#if defined(PDF_ENABLE_XFA)
gin::InitializeCppgcFromV8Platform();
#endif
}
void TearDownV8() {
#if defined(PDF_ENABLE_XFA)
gin::MaybeShutdownCppgc();
#endif
delete g_isolate_holder;
g_isolate_holder = nullptr;
}
#endif // defined(PDF_ENABLE_V8)
// Returns true if the given `area` and `form_type` combination from
// PDFiumEngine::GetCharIndex() indicates it is a form text area.
bool IsFormTextArea(PDFiumPage::Area area, int form_type) {
if (form_type == FPDF_FORMFIELD_UNKNOWN)
return false;
DCHECK_EQ(area, PDFiumPage::FormTypeToArea(form_type));
return area == PDFiumPage::FORM_TEXT_AREA;
}
// Checks whether or not focus is in an editable form text area given the
// form field annotation flags and form type.
bool CheckIfEditableFormTextArea(int flags, int form_type) {
if (!!(flags & FPDF_FORMFLAG_READONLY))
return false;
if (form_type == FPDF_FORMFIELD_TEXTFIELD)
return true;
if (form_type == FPDF_FORMFIELD_COMBOBOX &&
(!!(flags & FPDF_FORMFLAG_CHOICE_EDIT))) {
return true;
}
return false;
}
bool IsLinkArea(PDFiumPage::Area area) {
return area == PDFiumPage::WEBLINK_AREA || area == PDFiumPage::DOCLINK_AREA;
}
bool IsSelectableArea(PDFiumPage::Area area) {
return area == PDFiumPage::TEXT_AREA || IsLinkArea(area);
}
// These values are intended for the JS to handle, and it doesn't have access
// to the PDFDEST_VIEW_* defines.
std::string ConvertViewIntToViewString(unsigned long view_int) {
switch (view_int) {
case PDFDEST_VIEW_XYZ:
return "XYZ";
case PDFDEST_VIEW_FIT:
return "Fit";
case PDFDEST_VIEW_FITH:
return "FitH";
case PDFDEST_VIEW_FITV:
return "FitV";
case PDFDEST_VIEW_FITR:
return "FitR";
case PDFDEST_VIEW_FITB:
return "FitB";
case PDFDEST_VIEW_FITBH:
return "FitBH";
case PDFDEST_VIEW_FITBV:
return "FitBV";
case PDFDEST_VIEW_UNKNOWN_MODE:
return "";
default:
NOTREACHED();
}
}
// Simplify to \" for searching
constexpr wchar_t kHebrewPunctuationGershayimCharacter = 0x05F4;
constexpr wchar_t kLeftDoubleQuotationMarkCharacter = 0x201C;
constexpr wchar_t kRightDoubleQuotationMarkCharacter = 0x201D;
// Simplify \' for searching
constexpr wchar_t kHebrewPunctuationGereshCharacter = 0x05F3;
constexpr wchar_t kLeftSingleQuotationMarkCharacter = 0x2018;
constexpr wchar_t kRightSingleQuotationMarkCharacter = 0x2019;
wchar_t SimplifyForSearch(wchar_t c) {
switch (c) {
case kHebrewPunctuationGershayimCharacter:
case kLeftDoubleQuotationMarkCharacter:
case kRightDoubleQuotationMarkCharacter:
return L'\"';
case kHebrewPunctuationGereshCharacter:
case kLeftSingleQuotationMarkCharacter:
case kRightSingleQuotationMarkCharacter:
return L'\'';
default:
return c;
}
}
FocusObjectType GetAnnotationFocusType(FPDF_ANNOTATION_SUBTYPE annot_type) {
switch (annot_type) {
case FPDF_ANNOT_LINK:
return FocusObjectType::kLink;
case FPDF_ANNOT_HIGHLIGHT:
return FocusObjectType::kHighlight;
case FPDF_ANNOT_WIDGET:
return FocusObjectType::kTextField;
default:
return FocusObjectType::kNone;
}
}
std::u16string GetAttachmentAttribute(FPDF_ATTACHMENT attachment,
FPDF_BYTESTRING field) {
return CallPDFiumWideStringBufferApi(
base::BindRepeating(&FPDFAttachment_GetStringValue, attachment, field),
/*check_expected_size=*/true);
}
std::u16string GetAttachmentName(FPDF_ATTACHMENT attachment) {
return CallPDFiumWideStringBufferApi(
base::BindRepeating(&FPDFAttachment_GetName, attachment),
/*check_expected_size=*/true);
}
std::string GetXYZParamsString(FPDF_DEST dest, PDFiumPage* page) {
std::string xyz_params;
FPDF_BOOL has_x_coord;
FPDF_BOOL has_y_coord;
FPDF_BOOL has_zoom;
FS_FLOAT x;
FS_FLOAT y;
FS_FLOAT zoom;
if (!FPDFDest_GetLocationInPage(dest, &has_x_coord, &has_y_coord, &has_zoom,
&x, &y, &zoom)) {
return xyz_params;
}
// Generate a string of the parameters
if (has_x_coord) {
// Handle out-of-range page coordinates and convert in-page coordinates to
// in-screen coordinates.
xyz_params =
base::NumberToString(page->PreProcessAndTransformInPageCoordX(x)) + ",";
} else {
xyz_params = "null,";
}
if (has_y_coord) {
// Same conversions as x coordinates above.
xyz_params +=
base::NumberToString(page->PreProcessAndTransformInPageCoordY(y)) + ",";
} else {
xyz_params += "null,";
}
if (has_zoom) {
DCHECK_NE(zoom, 0);
xyz_params += base::NumberToString(zoom);
} else {
xyz_params += "null";
}
return xyz_params;
}
void SetXYZParamsInScreenCoords(PDFiumPage* page, float* params) {
gfx::PointF page_coords(params[0], params[1]);
gfx::PointF screen_coords = page->TransformPageToScreenXY(page_coords);
params[0] = screen_coords.x();
params[1] = screen_coords.y();
}
void SetFitRParamsInScreenCoords(PDFiumPage* page, float* params) {
gfx::PointF point_1 =
page->TransformPageToScreenXY(gfx::PointF(params[0], params[1]));
gfx::PointF point_2 =
page->TransformPageToScreenXY(gfx::PointF(params[2], params[3]));
params[0] = point_1.x();
params[1] = point_1.y();
params[2] = point_2.x();
params[3] = point_2.y();
}
// A helper function that transforms the in-page coordinates in `params` to
// in-screen coordinates depending on the view's fit type. `params` is both an
// input and a output parameter.
void ParamsTransformPageToScreen(unsigned long view_fit_type,
PDFiumPage* page,
float* params) {
switch (view_fit_type) {
case PDFDEST_VIEW_XYZ:
SetXYZParamsInScreenCoords(page, params);
break;
case PDFDEST_VIEW_FIT:
case PDFDEST_VIEW_FITB:
// No parameters for coordinates to be transformed.
break;
case PDFDEST_VIEW_FITBH:
case PDFDEST_VIEW_FITH:
// FitH/FitBH only has 1 parameter for y coordinate.
params[0] = page->TransformPageToScreenY(params[0]);
break;
case PDFDEST_VIEW_FITBV:
case PDFDEST_VIEW_FITV:
// FitV/FitBV only has 1 parameter for x coordinate.
params[0] = page->TransformPageToScreenX(params[0]);
break;
case PDFDEST_VIEW_FITR:
SetFitRParamsInScreenCoords(page, params);
break;
case PDFDEST_VIEW_UNKNOWN_MODE:
break;
default:
NOTREACHED();
}
}
} // namespace
void InitializeSDK(bool enable_v8,
bool use_skia,
FontMappingMode font_mapping_mode) {
FPDF_LIBRARY_CONFIG config;
config.version = 4;
config.m_pUserFontPaths = nullptr;
config.m_pIsolate = nullptr;
config.m_pPlatform = nullptr;
config.m_v8EmbedderSlot = gin::kEmbedderPDFium;
config.m_RendererType =
use_skia ? FPDF_RENDERERTYPE_SKIA : FPDF_RENDERERTYPE_AGG;
#if defined(PDF_ENABLE_V8)
if (enable_v8) {
SetUpV8();
config.m_pIsolate = g_isolate_holder->isolate();
// NOTE: static_cast<> prior to assigning to (void*) is safer since it
// will manipulate the pointer value should gin::V8Platform someday have
// multiple base classes.
config.m_pPlatform = static_cast<v8::Platform*>(gin::V8Platform::Get());
}
#endif // defined(PDF_ENABLE_V8)
FPDF_InitLibraryWithConfig(&config);
#if BUILDFLAG(IS_LINUX) || BUILDFLAG(IS_CHROMEOS)
g_font_mapping_mode = font_mapping_mode;
InitializeLinuxFontMapper();
#endif
#if BUILDFLAG(IS_WIN)
if (font_mapping_mode == FontMappingMode::kBlink) {
g_font_mapping_mode = font_mapping_mode;
InitializeWindowsFontMapper();
}
#endif
InitializeUnsupportedFeaturesHandler();
}
void ShutdownSDK() {
FPDF_DestroyLibrary();
#if defined(PDF_ENABLE_V8)
if (IsV8Initialized())
TearDownV8();
#endif // defined(PDF_ENABLE_V8)
}
PDFiumEngine::PDFiumEngine(PDFiumEngineClient* client,
PDFiumFormFiller::ScriptOption script_option)
: client_(client),
form_filler_(this, script_option),
mouse_down_state_(PDFiumPage::NONSELECTABLE_AREA,
PDFiumPage::LinkTarget()),
print_(this) {
#if defined(PDF_ENABLE_V8)
if (script_option != PDFiumFormFiller::ScriptOption::kNoJavaScript)
DCHECK(IsV8Initialized());
#endif // defined(PDF_ENABLE_V8)
IFSDK_PAUSE::version = 1;
IFSDK_PAUSE::user = nullptr;
IFSDK_PAUSE::NeedToPauseNow = Pause_NeedToPauseNow;
}
PDFiumEngine::~PDFiumEngine() {
// Clear all the containers that can prevent unloading.
find_results_.clear();
selection_.clear();
for (auto& page : pages_)
page->Unload();
if (doc())
FORM_DoDocumentAAction(form(), FPDFDOC_AACTION_WC);
}
void PDFiumEngine::SetDocumentLoaderForTesting(
std::unique_ptr<DocumentLoader> loader) {
DCHECK(loader);
DCHECK(!doc_loader_);
doc_loader_ = std::move(loader);
doc_loader_set_for_testing_ = true;
}
// static
FontMappingMode PDFiumEngine::GetFontMappingMode() {
return g_font_mapping_mode;
}
void PDFiumEngine::PageOffsetUpdated(const gfx::Vector2d& page_offset) {
page_offset_ = page_offset;
}
void PDFiumEngine::PluginSizeUpdated(const gfx::Size& size) {
CancelPaints();
plugin_size_ = size;
CalculateVisiblePages();
OnSelectionPositionChanged();
if (document_pending_) {
// This method may be called in a `blink::ScriptForbiddenScope` context,
// which imposes certain restrictions on clients. Complete the work
// asynchronously to avoid observable differences between this path and the
// normal loading path.
document_pending_ = false;
base::SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
FROM_HERE, base::BindOnce(&PDFiumEngine::FinishLoadingDocument,
weak_factory_.GetWeakPtr()));
}
}
void PDFiumEngine::ScrolledToXPosition(int position) {
CancelPaints();
gfx::Vector2d diff(position_.x() - position, 0);
position_.set_x(position);
CalculateVisiblePages();
client_->DidScroll(diff);
caret_rect_ += diff;
client_->CaretChanged(caret_rect_);
OnSelectionPositionChanged();
}
void PDFiumEngine::ScrolledToYPosition(int position) {
CancelPaints();
gfx::Vector2d diff(0, position_.y() - position);
position_.set_y(position);
CalculateVisiblePages();
client_->DidScroll(diff);
caret_rect_ += diff;
client_->CaretChanged(caret_rect_);
OnSelectionPositionChanged();
}
void PDFiumEngine::PrePaint() {
for (auto& paint : progressive_paints_)
paint.set_painted(false);
}
void PDFiumEngine::Paint(const gfx::Rect& rect,
SkBitmap& image_data,
std::vector<gfx::Rect>& ready,
std::vector<gfx::Rect>& pending) {
gfx::Rect leftover = rect;
// Set a timer here to check how long it takes to finish rendering and
// painting the visible pages.
base::TimeTicks begin_time = base::TimeTicks::Now();
for (size_t i = 0; i < visible_pages_.size(); ++i) {
int index = visible_pages_[i];
// Convert the current page's rectangle to screen rectangle. We do this
// instead of the reverse (converting the dirty rectangle from screen to
// page coordinates) because then we'd have to convert back to screen
// coordinates, and the rounding errors sometime leave pixels dirty or even
// move the text up or down a pixel when zoomed.
gfx::Rect page_rect_in_screen = GetPageScreenRect(index);
gfx::Rect dirty_in_screen =
gfx::IntersectRects(page_rect_in_screen, leftover);
if (dirty_in_screen.IsEmpty())
continue;
// Compute the leftover dirty region. The first page may have blank space
// above it, in which case we also need to subtract that space from the
// dirty region.
// If two-up view is enabled, we don't need to recompute `leftover` since
// subtracting `leftover` with a two-up view page won't result in a
// rectangle.
if (layout_.options().page_spread() == DocumentLayout::PageSpread::kOneUp) {
if (i == 0) {
gfx::Rect blank_space_in_screen = dirty_in_screen;
blank_space_in_screen.set_y(0);
blank_space_in_screen.set_height(dirty_in_screen.y());
leftover.Subtract(blank_space_in_screen);
}
leftover.Subtract(dirty_in_screen);
}
if (pages_[index]->available()) {
int progressive = GetProgressiveIndex(index);
if (progressive != -1) {
DCHECK_GE(progressive, 0);
DCHECK_LT(static_cast<size_t>(progressive), progressive_paints_.size());
if (progressive_paints_[progressive].rect() != dirty_in_screen) {
// The PDFium code can only handle one progressive paint at a time, so
// queue this up. Previously we used to merge the rects when this
// happened, but it made scrolling up on complex PDFs very slow since
// there would be a damaged rect at the top (from scroll) and at the
// bottom (from toolbar).
pending.push_back(dirty_in_screen);
continue;
}
}
if (progressive == -1) {
progressive = StartPaint(index, dirty_in_screen);
progressive_paint_timeout_ = kMaxInitialProgressivePaintTime;
} else {
progressive_paint_timeout_ = kMaxProgressivePaintTime;
}
progressive_paints_[progressive].set_painted(true);
if (ContinuePaint(progressive, image_data)) {
FinishPaint(progressive, image_data);
ready.push_back(dirty_in_screen);
} else {
pending.push_back(dirty_in_screen);
}
} else {
PaintUnavailablePage(index, dirty_in_screen, image_data);
ready.push_back(dirty_in_screen);
}
}
base::UmaHistogramMediumTimes("PDF.RenderAndPaintVisiblePagesTime",
base::TimeTicks::Now() - begin_time);
}
void PDFiumEngine::PostPaint() {
for (size_t i = 0; i < progressive_paints_.size(); ++i) {
if (progressive_paints_[i].painted())
continue;
// This rectangle must have been merged with another one, that's why we
// weren't asked to paint it. Remove it or otherwise we'll never finish
// painting.
FPDF_RenderPage_Close(
pages_[progressive_paints_[i].page_index()]->GetPage());
progressive_paints_.erase(progressive_paints_.begin() + i);
--i;
}
}
bool PDFiumEngine::HandleDocumentLoad(std::unique_ptr<UrlLoader> loader,
const std::string& original_url) {
password_tries_remaining_ = kMaxPasswordTries;
process_when_pending_request_complete_ =
base::FeatureList::IsEnabled(features::kPdfIncrementalLoading);
if (!doc_loader_set_for_testing_) {
doc_loader_ = std::make_unique<DocumentLoaderImpl>(this);
if (!doc_loader_->Init(
std::make_unique<URLLoaderWrapperImpl>(std::move(loader)),
original_url))
return false;
}
document_ = std::make_unique<PDFiumDocument>(doc_loader_.get());
// request initial data.
doc_loader_->RequestData(0, 1);
return true;
}
std::unique_ptr<URLLoaderWrapper> PDFiumEngine::CreateURLLoader() {
return std::make_unique<URLLoaderWrapperImpl>(client_->CreateUrlLoader());
}
void PDFiumEngine::AppendPage(PDFiumEngine* engine, int index) {
CHECK(engine);
CHECK(PageIndexInBounds(index));
// Unload and delete the blank page before appending.
pages_[index]->Unload();
pages_[index]->set_calculated_links(false);
gfx::Size curr_page_size = GetPageSize(index);
FPDFPage_Delete(doc(), index);
FPDF_ImportPages(doc(), static_cast<PDFiumEngine*>(engine)->doc(), "1",
index);
gfx::Size new_page_size = GetPageSize(index);
if (curr_page_size != new_page_size) {
DCHECK(document_loaded_);
LoadPageInfo();
}
client_->Invalidate(GetPageScreenRect(index));
}
std::vector<uint8_t> PDFiumEngine::GetSaveData() {
PDFiumMemBufferFileWrite output_file_write;
if (!FPDF_SaveAsCopy(doc(), &output_file_write, 0))
return std::vector<uint8_t>();
return output_file_write.TakeBuffer();
}
void PDFiumEngine::OnPendingRequestComplete() {
if (!process_when_pending_request_complete_)
return;
if (!fpdf_availability()) {
document_->file_access().m_FileLen = doc_loader_->GetDocumentSize();
document_->CreateFPDFAvailability();
// Currently engine does not deal efficiently with some non-linearized
// files.
// See http://code.google.com/p/chromium/issues/detail?id=59400
// To improve user experience we download entire file for non-linearized
// PDF.
if (!IsLinearized()) {
// Wait complete document.
process_when_pending_request_complete_ = false;
document_->ResetFPDFAvailability();
return;
}
}
if (!doc()) {
LoadDocument();
return;
}
if (pages_.empty()) {
LoadBody();
return;
}
// LoadDocument() will result in `pending_pages_` being reset so there's no
// need to run the code below in that case.
bool update_pages = false;
std::vector<int> still_pending;
for (int pending_page : pending_pages_) {
if (CheckPageAvailable(pending_page, &still_pending)) {
update_pages = true;
if (IsPageVisible(pending_page))
client_->Invalidate(GetPageScreenRect(pending_page));
}
}
pending_pages_.swap(still_pending);
if (update_pages) {
DCHECK(!document_loaded_);
LoadPageInfo();
}
}
void PDFiumEngine::OnNewDataReceived() {
client_->DocumentLoadProgress(doc_loader_->BytesReceived(),
doc_loader_->GetDocumentSize());
}
void PDFiumEngine::OnDocumentComplete() {
if (doc())
return FinishLoadingDocument();
document_->file_access().m_FileLen = doc_loader_->GetDocumentSize();
if (!fpdf_availability()) {
document_->CreateFPDFAvailability();
DCHECK(fpdf_availability());
}
LoadDocument();
}
void PDFiumEngine::OnDocumentCanceled() {
if (visible_pages_.empty())
client_->DocumentLoadFailed();
else
OnDocumentComplete();
}
void PDFiumEngine::FinishLoadingDocument() {
// Note that doc_loader_->IsDocumentComplete() may not be true here if
// called via `OnDocumentCanceled()`.
DCHECK(doc());
DCHECK(!document_pending_);
if (!plugin_size_.has_value()) {
// Don't finish loading until `plugin_size_` is initialized.
document_pending_ = true;
return;
}
LoadBody();
FX_DOWNLOADHINTS& download_hints = document_->download_hints();
bool need_update = false;
for (size_t i = 0; i < pages_.size(); ++i) {
if (pages_[i]->available())
continue;
pages_[i]->MarkAvailable();
// We still need to call IsPageAvail() even if the whole document is
// already downloaded.
FPDFAvail_IsPageAvail(fpdf_availability(), i, &download_hints);
need_update = true;
if (IsPageVisible(i))
client_->Invalidate(GetPageScreenRect(i));
}
// Transition `document_loaded_` to true after finishing any calls to
// FPDFAvail_IsPageAvail(), since we no longer need to defer calls to this
// function from LoadPageInfo(). Note that LoadBody() calls LoadPageInfo()
// indirectly, so we cannot make this transition earlier.
document_loaded_ = true;
if (need_update)
LoadPageInfo();
LoadDocumentAttachmentInfoList();
LoadDocumentMetadata();
if (called_do_document_action_)
return;
called_do_document_action_ = true;
// These can only be called now, as the JS might end up needing a page.
FORM_DoDocumentJSAction(form());
FORM_DoDocumentOpenAction(form());
if (most_visible_page_ != -1) {
FPDF_PAGE new_page = pages_[most_visible_page_]->GetPage();
FORM_DoPageAAction(new_page, form(), FPDFPAGE_AACTION_OPEN);
}
client_->DocumentLoadComplete();
}
void PDFiumEngine::UnsupportedFeature(const std::string& feature) {
client_->DocumentHasUnsupportedFeature(feature);
}
FPDF_AVAIL PDFiumEngine::fpdf_availability() const {
return document_ ? document_->fpdf_availability() : nullptr;
}
FPDF_DOCUMENT PDFiumEngine::doc() const {
return document_ ? document_->doc() : nullptr;
}
FPDF_FORMHANDLE PDFiumEngine::form() const {
return document_ ? document_->form() : nullptr;
}
PDFiumPage* PDFiumEngine::GetPage(size_t index) {
return index < pages_.size() ? pages_[index].get() : nullptr;
}
bool PDFiumEngine::IsValidLink(const std::string& url) {
return client_->IsValidLink(url);
}
void PDFiumEngine::SetFormHighlight(bool enable_form) {
// Restore form highlights.
if (enable_form) {
FPDF_SetFormFieldHighlightAlpha(form(), kFormHighlightAlpha);
return;
}
// Hide form highlights.
FPDF_SetFormFieldHighlightAlpha(form(), /*alpha=*/0);
KillFormFocus();
}
void PDFiumEngine::ClearTextSelection() {
SelectionChangeInvalidator selection_invalidator(this);
selection_.clear();
}
void PDFiumEngine::ContinueFind(bool case_sensitive) {
StartFind(current_find_text_, case_sensitive);
}
bool PDFiumEngine::HandleInputEvent(const blink::WebInputEvent& event) {
DCHECK(!defer_page_unload_);
defer_page_unload_ = true;
bool rv = false;
switch (event.GetType()) {
case blink::WebInputEvent::Type::kMouseDown:
rv = OnMouseDown(static_cast<const blink::WebMouseEvent&>(event));
break;
case blink::WebInputEvent::Type::kMouseUp:
rv = OnMouseUp(static_cast<const blink::WebMouseEvent&>(event));
break;
case blink::WebInputEvent::Type::kMouseMove:
rv = OnMouseMove(static_cast<const blink::WebMouseEvent&>(event));
break;
case blink::WebInputEvent::Type::kMouseEnter:
OnMouseEnter(static_cast<const blink::WebMouseEvent&>(event));
break;
case blink::WebInputEvent::Type::kKeyDown:
// Blink mostly sends `kRawKeyDown`, but sometimes generates `kKeyDown`,
// such as when tabbing between frames. Pepper treats them equivalently
// (see content/renderer/pepper/event_conversion.cc), so we will, too.
case blink::WebInputEvent::Type::kRawKeyDown:
rv = OnKeyDown(static_cast<const blink::WebKeyboardEvent&>(event));
break;
case blink::WebInputEvent::Type::kKeyUp:
rv = OnKeyUp(static_cast<const blink::WebKeyboardEvent&>(event));
break;
case blink::WebInputEvent::Type::kChar:
rv = OnChar(static_cast<const blink::WebKeyboardEvent&>(event));
break;
case blink::WebInputEvent::Type::kTouchStart: {
KillTouchTimer();
const auto& touch_event = static_cast<const blink::WebTouchEvent&>(event);
if (touch_event.touches_length == 1)
ScheduleTouchTimer(touch_event);
break;
}
case blink::WebInputEvent::Type::kTouchEnd:
KillTouchTimer();
break;
case blink::WebInputEvent::Type::kTouchMove:
// TODO(dsinclair): This should allow a little bit of movement (up to the
// touch radii) to account for finger jiggle.
KillTouchTimer();
break;
default:
break;
}
DCHECK(defer_page_unload_);
defer_page_unload_ = false;
// Store the pages to unload away because the act of unloading pages can cause
// there to be more pages to unload. We leave those extra pages to be unloaded
// on the next go around.
std::vector<int> pages_to_unload;
std::swap(pages_to_unload, deferred_page_unloads_);
for (int page_index : pages_to_unload)
pages_[page_index]->Unload();
return rv;
}
void PDFiumEngine::PrintBegin() {
FORM_DoDocumentAAction(form(), FPDFDOC_AACTION_WP);
}
std::vector<uint8_t> PDFiumEngine::PrintPages(
const std::vector<int>& page_indices,
const blink::WebPrintParams& print_params) {
if (page_indices.empty()) {
return std::vector<uint8_t>();
}
return print_params.rasterize_pdf
? PrintPagesAsRasterPdf(page_indices, print_params)
: PrintPagesAsPdf(page_indices, print_params);
}
std::vector<uint8_t> PDFiumEngine::PrintPagesAsRasterPdf(
const std::vector<int>& page_indices,
const blink::WebPrintParams& print_params) {
DCHECK(HasPermission(DocumentPermission::kPrintLowQuality));
// If document is not downloaded yet, disable printing.
if (doc() && !doc_loader_->IsDocumentComplete())
return std::vector<uint8_t>();
KillFormFocus();
return print_.PrintPagesAsPdf(page_indices, print_params);
}
std::vector<uint8_t> PDFiumEngine::PrintPagesAsPdf(
const std::vector<int>& page_indices,
const blink::WebPrintParams& print_params) {
DCHECK(HasPermission(DocumentPermission::kPrintHighQuality));
DCHECK(doc());
KillFormFocus();
for (int page_index : page_indices) {
pages_[page_index]->GetPage();
if (!IsPageVisible(page_index)) {
pages_[page_index]->Unload();
}
}
return print_.PrintPagesAsPdf(page_indices, print_params);
}
void PDFiumEngine::KillFormFocus() {
FORM_ForceToKillFocus(form());
SetFieldFocus(FocusFieldType::kNoFocus);
}
void PDFiumEngine::UpdateFocus(bool has_focus) {
bool can_focus = !IsReadOnly();
#if BUILDFLAG(ENABLE_PDF_INK2)
can_focus = can_focus && !client_->IsInAnnotationMode();
#endif // BUILDFLAG(ENABLE_PDF_INK2)
base::AutoReset<bool> updating_focus_guard(&updating_focus_, true);
if (has_focus && can_focus) {
UpdateFocusElementType(last_focused_element_type_);
if (focus_element_type_ == FocusElementType::kPage &&
PageIndexInBounds(last_focused_page_) &&
last_focused_annot_index_ != -1) {
ScopedFPDFAnnotation last_focused_annot(FPDFPage_GetAnnot(
pages_[last_focused_page_]->GetPage(), last_focused_annot_index_));
if (last_focused_annot) {
FPDF_BOOL ret = FORM_SetFocusedAnnot(form(), last_focused_annot.get());
DCHECK(ret);
}
}
} else {
last_focused_element_type_ = focus_element_type_;
if (focus_element_type_ == FocusElementType::kDocument) {
UpdateFocusElementType(FocusElementType::kNone);
} else if (focus_element_type_ == FocusElementType::kPage) {
FPDF_ANNOTATION last_focused_annot = nullptr;
FPDF_BOOL ret = FORM_GetFocusedAnnot(form(), &last_focused_page_,
&last_focused_annot);
if (ret && PageIndexInBounds(last_focused_page_) && last_focused_annot) {
last_focused_annot_index_ = FPDFPage_GetAnnotIndex(
pages_[last_focused_page_]->GetPage(), last_focused_annot);
} else {
last_focused_annot_index_ = -1;
}
FPDFPage_CloseAnnot(last_focused_annot);
}
KillFormFocus();
}
}
AccessibilityFocusInfo PDFiumEngine::GetFocusInfo() {
AccessibilityFocusInfo focus_info = {FocusObjectType::kNone, 0, 0};
switch (focus_element_type_) {
case FocusElementType::kNone: {
break;
}
case FocusElementType::kPage: {
int page_index = -1;
FPDF_ANNOTATION focused_annot = nullptr;
FPDF_BOOL ret = FORM_GetFocusedAnnot(form(), &page_index, &focused_annot);
DCHECK(ret);
if (PageIndexInBounds(page_index) && focused_annot) {
FocusObjectType type =
GetAnnotationFocusType(FPDFAnnot_GetSubtype(focused_annot));
int annot_index = FPDFPage_GetAnnotIndex(pages_[page_index]->GetPage(),
focused_annot);
if (type != FocusObjectType::kNone && annot_index >= 0) {
focus_info.focused_object_type = type;
focus_info.focused_object_page_index = page_index;
focus_info.focused_annotation_index_in_page = annot_index;
}
}
FPDFPage_CloseAnnot(focused_annot);
break;
}
case FocusElementType::kDocument: {
focus_info.focused_object_type = FocusObjectType::kDocument;
break;
}
}
return focus_info;
}
bool PDFiumEngine::IsPDFDocTagged() {
return FPDFCatalog_IsTagged(doc());
}
uint32_t PDFiumEngine::GetLoadedByteSize() {
return doc_loader_->GetDocumentSize();
}
bool PDFiumEngine::ReadLoadedBytes(uint32_t length, void* buffer) {
DCHECK_LE(length, GetLoadedByteSize());
return doc_loader_->GetBlock(0, length, buffer);
}
void PDFiumEngine::SetFormSelectedText(FPDF_FORMHANDLE form_handle,
FPDF_PAGE page) {
std::u16string selected_form_text16 = CallPDFiumWideStringBufferApi(
base::BindRepeating(&FORM_GetSelectedText, form_handle, page),
/*check_expected_size=*/false);
// If form selected text is empty and there was no previous form text
// selection, exit early because nothing has changed.
if (selected_form_text16.empty() && selected_form_text_.empty())
return;
// Update previous and current selections, then compare them to check if
// selection has changed. If so, set plugin text selection.
std::string selected_form_text = selected_form_text_;
selected_form_text_ = base::UTF16ToUTF8(selected_form_text16);
if (selected_form_text != selected_form_text_) {
DCHECK_EQ(focus_field_type_, FocusFieldType::kText);
client_->SetSelectedText(selected_form_text_);
}
}
void PDFiumEngine::PrintEnd() {
FORM_DoDocumentAAction(form(), FPDFDOC_AACTION_DP);
}
PDFiumPage::Area PDFiumEngine::GetCharIndex(const gfx::Point& point,
int* page_index,
int* char_index,
int* form_type,
PDFiumPage::LinkTarget* target) {
int page = -1;
const gfx::Point point_in_page = DeviceToScreen(point);
for (int visible_page : visible_pages_) {
if (pages_[visible_page]->rect().Contains(point_in_page)) {
page = visible_page;
break;
}
}
if (page == -1)
return PDFiumPage::NONSELECTABLE_AREA;
// If the page hasn't finished rendering, calling into the page sometimes
// leads to hangs.
for (const auto& paint : progressive_paints_) {
if (paint.page_index() == page)
return PDFiumPage::NONSELECTABLE_AREA;
}
*page_index = page;
PDFiumPage::Area result = pages_[page]->GetCharIndex(
point_in_page, layout_.options().default_page_orientation(), char_index,
form_type, target);
return (client_->IsPrintPreview() && result == PDFiumPage::WEBLINK_AREA)
? PDFiumPage::NONSELECTABLE_AREA
: result;
}
bool PDFiumEngine::OnMouseDown(const blink::WebMouseEvent& event) {
blink::WebMouseEvent normalized_event = NormalizeMouseEvent(event);
switch (normalized_event.button) {
case blink::WebPointerProperties::Button::kLeft:
return OnLeftMouseDown(normalized_event);
case blink::WebPointerProperties::Button::kMiddle:
return OnMiddleMouseDown(normalized_event);
case blink::WebPointerProperties::Button::kRight:
return OnRightMouseDown(normalized_event);
default:
return false;
}
}
void PDFiumEngine::OnSingleClick(int page_index, int char_index) {
SetSelecting(true);
selection_.push_back(PDFiumRange(pages_[page_index].get(), char_index, 0));
}
void PDFiumEngine::OnMultipleClick(int click_count,
int page_index,
int char_index) {
DCHECK_GE(click_count, 2);
bool is_double_click = click_count == 2;
// It would be more efficient if the SDK could support finding a space, but
// now it doesn't.
int start_index = char_index;
do {
char16_t cur = pages_[page_index]->GetCharAtIndex(start_index);
if (FindMultipleClickBoundary(is_double_click, cur))
break;
} while (--start_index >= 0);
if (start_index)
start_index++;
int end_index = char_index;
const int total = pages_[page_index]->GetCharCount();
for (; end_index < total; ++end_index) {
char16_t cur = pages_[page_index]->GetCharAtIndex(end_index);
if (FindMultipleClickBoundary(is_double_click, cur))
break;
}
selection_.push_back(PDFiumRange(pages_[page_index].get(), start_index,
end_index - start_index));
if (handling_long_press_)
client_->NotifyTouchSelectionOccurred();
}
bool PDFiumEngine::OnLeftMouseDown(const blink::WebMouseEvent& event) {
DCHECK_EQ(blink::WebPointerProperties::Button::kLeft, event.button);
SetMouseLeftButtonDown(true);
auto selection_invalidator =
std::make_unique<SelectionChangeInvalidator>(this);
selection_.clear();
int page_index = -1;
int char_index = -1;
int form_type = FPDF_FORMFIELD_UNKNOWN;
PDFiumPage::LinkTarget target;
const gfx::Point point = gfx::ToRoundedPoint(event.PositionInWidget());
PDFiumPage::Area area =
GetCharIndex(point, &page_index, &char_index, &form_type, &target);
DCHECK_GE(form_type, FPDF_FORMFIELD_UNKNOWN);
mouse_down_state_.Set(area, target);
// Decide whether to open link or not based on user action in mouse up and
// mouse move events.
if (IsLinkArea(area))
return true;
if (page_index != -1) {
UpdateFocusElementType(FocusElementType::kPage);
last_focused_page_ = page_index;
double page_x;
double page_y;
DeviceToPage(page_index, point, &page_x, &page_y);
if (form_type != FPDF_FORMFIELD_UNKNOWN) {
// FORM_OnLButton*() will trigger a callback to
// OnFocusedAnnotationUpdated(), which will call SetFieldFocus().
// Destroy SelectionChangeInvalidator object before SetFieldFocus()
// changes plugin's focus to be `FocusFieldType::kText`. This way, regular
// text selection can be cleared when a user clicks into a form text area
// because the pp::PDF::SetSelectedText() call in
// ~SelectionChangeInvalidator() still goes to the Mimehandler
// (not the Renderer).
selection_invalidator.reset();
}
FPDF_PAGE page = pages_[page_index]->GetPage();
if (event.ClickCount() == 1) {
FORM_OnLButtonDown(form(), page, event.GetModifiers(), page_x, page_y);
} else if (event.ClickCount() == 2) {
FORM_OnLButtonDoubleClick(form(), page, event.GetModifiers(), page_x,
page_y);
}
if (form_type != FPDF_FORMFIELD_UNKNOWN)
return true; // Return now before we get into the selection code.
}
SetFieldFocus(FocusFieldType::kNoFocus);
if (area != PDFiumPage::TEXT_AREA)
return true; // Return true so WebKit doesn't do its own highlighting.
if (event.ClickCount() == 1)
OnSingleClick(page_index, char_index);
else if (event.ClickCount() == 2 || event.ClickCount() == 3)
OnMultipleClick(event.ClickCount(), page_index, char_index);
return true;
}
bool PDFiumEngine::OnMiddleMouseDown(const blink::WebMouseEvent& event) {
DCHECK_EQ(blink::WebPointerProperties::Button::kMiddle, event.button);
SetMouseLeftButtonDown(false);
mouse_middle_button_down_ = true;
mouse_middle_button_last_position_ =
gfx::ToRoundedPoint(event.PositionInWidget());
ClearTextSelection();
int unused_page_index = -1;
int unused_char_index = -1;
int unused_form_type = FPDF_FORMFIELD_UNKNOWN;
PDFiumPage::LinkTarget target;
PDFiumPage::Area area =
GetCharIndex(mouse_middle_button_last_position_, &unused_page_index,
&unused_char_index, &unused_form_type, &target);
mouse_down_state_.Set(area, target);
// Decide whether to open link or not based on user action in mouse up and
// mouse move events.
if (IsLinkArea(area))
return true;
if (kViewerImplementedPanning) {
// Switch to hand cursor when panning.
client_->UpdateCursor(ui::mojom::CursorType::kHand);
}
// Prevent middle mouse button from selecting texts.
return false;
}
bool PDFiumEngine::OnRightMouseDown(const blink::WebMouseEvent& event) {
DCHECK_EQ(blink::WebPointerProperties::Button::kRight, event.button);
const gfx::Point point = gfx::ToRoundedPoint(event.PositionInWidget());
int page_index = -1;
int char_index = -1;
int form_type = FPDF_FORMFIELD_UNKNOWN;
PDFiumPage::LinkTarget target;
PDFiumPage::Area area =
GetCharIndex(point, &page_index, &char_index, &form_type, &target);
DCHECK_GE(form_type, FPDF_FORMFIELD_UNKNOWN);
bool is_form_text_area = IsFormTextArea(area, form_type);
double page_x = -1;
double page_y = -1;
FPDF_PAGE page = nullptr;
if (is_form_text_area) {
DCHECK_NE(page_index, -1);
DeviceToPage(page_index, point, &page_x, &page_y);
page = pages_[page_index]->GetPage();
}
// Handle the case when focus starts inside a form text area.
if (focus_field_type_ == FocusFieldType::kText) {
if (is_form_text_area) {
FORM_OnFocus(form(), page, 0, page_x, page_y);
} else {
// Transition out of a form text area.
KillFormFocus();
}
return true;
}
// Handle the case when focus starts outside a form text area and transitions
// into a form text area.
if (is_form_text_area) {
FORM_OnFocus(form(), page, 0, page_x, page_y);
return true;
}
// Before examining the selection, first refresh the link. Due to keyboard
// events and possibly other events, the saved link info may be stale.
UpdateLinkUnderCursor(GetLinkAtPosition(point));
// Handle the case when focus starts outside a form text area and stays
// outside.
if (selection_.empty()) {
return false;
}
std::vector<gfx::Rect> selection_rect_vector =
GetAllScreenRectsUnion(selection_, GetVisibleRect().origin());
for (const auto& rect : selection_rect_vector) {
if (rect.Contains(point))
return false;
}
ClearTextSelection();
return true;
}
bool PDFiumEngine::NavigateToLinkDestination(
PDFiumPage::Area area,
const PDFiumPage::LinkTarget& target,
WindowOpenDisposition disposition) {
if (area == PDFiumPage::WEBLINK_AREA) {
client_->NavigateTo(target.url, disposition);
SetFieldFocus(FocusFieldType::kNoFocus);
return true;
}
if (area == PDFiumPage::DOCLINK_AREA) {
if (!PageIndexInBounds(target.page))
return true;
if (disposition == WindowOpenDisposition::CURRENT_TAB) {
client_->NavigateToDestination(target.page,
base::OptionalToPtr(target.x_in_pixels),
base::OptionalToPtr(target.y_in_pixels),
base::OptionalToPtr(target.zoom));
} else {
std::string parameters = base::StringPrintf("#page=%d", target.page + 1);
parameters += base::StringPrintf(
"&zoom=%d,%d,%d", static_cast<int>(target.zoom.value_or(1.0) * 100),
static_cast<int>(target.x_in_pixels.value_or(0)),
static_cast<int>(target.y_in_pixels.value_or(0)));
client_->NavigateTo(parameters, disposition);
}
SetFieldFocus(FocusFieldType::kNoFocus);
return true;
}
return false;
}
bool PDFiumEngine::OnMouseUp(const blink::WebMouseEvent& event) {
if (event.button != blink::WebPointerProperties::Button::kLeft &&
event.button != blink::WebPointerProperties::Button::kMiddle) {
return false;
}
if (event.button == blink::WebPointerProperties::Button::kLeft)
SetMouseLeftButtonDown(false);
else if (event.button == blink::WebPointerProperties::Button::kMiddle)
mouse_middle_button_down_ = false;
int page_index = -1;
int char_index = -1;
int form_type = FPDF_FORMFIELD_UNKNOWN;
PDFiumPage::LinkTarget target;
gfx::Point point = gfx::ToRoundedPoint(event.PositionInWidget());
PDFiumPage::Area area =
GetCharIndex(point, &page_index, &char_index, &form_type, &target);
// Open link on mouse up for same link for which mouse down happened earlier.
if (mouse_down_state_.Matches(area, target)) {
int modifiers = event.GetModifiers();
bool middle_button =
!!(modifiers & blink::WebInputEvent::Modifiers::kMiddleButtonDown);
bool alt_key = !!(modifiers & blink::WebInputEvent::Modifiers::kAltKey);
bool ctrl_key =
!!(modifiers & blink::WebInputEvent::Modifiers::kControlKey);
bool meta_key = !!(modifiers & blink::WebInputEvent::Modifiers::kMetaKey);
bool shift_key = !!(modifiers & blink::WebInputEvent::Modifiers::kShiftKey);
WindowOpenDisposition disposition = ui::DispositionFromClick(
middle_button, alt_key, ctrl_key, meta_key, shift_key);
if (NavigateToLinkDestination(area, target, disposition))
return true;
}
if (event.button == blink::WebPointerProperties::Button::kMiddle) {
if (kViewerImplementedPanning) {
// Update the cursor when panning stops.
client_->UpdateCursor(DetermineCursorType(area, form_type));
}
// Prevent middle mouse button from selecting texts.
return false;
}
if (page_index != -1) {
double page_x;
double page_y;
DeviceToPage(page_index, point, &page_x, &page_y);
FORM_OnLButtonUp(form(), pages_[page_index]->GetPage(),
event.GetModifiers(), page_x, page_y);
}
if (!selecting_)
return false;
SetSelecting(false);
return true;
}
bool PDFiumEngine::OnMouseMove(const blink::WebMouseEvent& event) {
int page_index = -1;
int char_index = -1;
int form_type = FPDF_FORMFIELD_UNKNOWN;
PDFiumPage::LinkTarget target;
const gfx::Point point = gfx::ToRoundedPoint(event.PositionInWidget());
PDFiumPage::Area area =
GetCharIndex(point, &page_index, &char_index, &form_type, &target);
// Clear `mouse_down_state_` if mouse moves away from where the mouse down
// happened.
if (!mouse_down_state_.Matches(area, target))
mouse_down_state_.Reset();
if (!selecting_) {
client_->UpdateCursor(DetermineCursorType(area, form_type));
if (page_index != -1) {
double page_x;
double page_y;
DeviceToPage(page_index, point, &page_x, &page_y);
FORM_OnMouseMove(form(), pages_[page_index]->GetPage(), 0, page_x,
page_y);
}
UpdateLinkUnderCursor(GetLinkAtPosition(point));
// If in form text area while left mouse button is held down, check if form
// text selection needs to be updated.
if (mouse_left_button_down_ && area == PDFiumPage::FORM_TEXT_AREA &&
PageIndexInBounds(last_focused_page_)) {
SetFormSelectedText(form(), pages_[last_focused_page_]->GetPage());
}
if (kViewerImplementedPanning && mouse_middle_button_down_) {
// Subtract (origin - destination) so delta is already the delta for
// moving the page, rather than the delta the mouse moved.
// `event.movement_x` and `event.movement_y` do not work here, as small
// mouse movements are considered zero.
gfx::Vector2d page_position_delta =
mouse_middle_button_last_position_ - point;
if (page_position_delta.x() != 0 || page_position_delta.y() != 0) {
client_->ScrollBy(page_position_delta);
mouse_middle_button_last_position_ = point;
}
}
// No need to swallow the event, since this might interfere with the
// scrollbars if the user is dragging them.
return false;
}
// We're selecting but right now we're not over text, so don't change the
// current selection.
if (page_index < 0 || char_index < 0)
return false;
// Similarly, do not select if `area` is not a selectable type. This can occur
// even if there is text in the area. e.g. When print previewing.
if (!IsSelectableArea(area))
return false;
SelectionChangeInvalidator selection_invalidator(this);
return ExtendSelection(page_index, char_index);
}
ui::mojom::CursorType PDFiumEngine::DetermineCursorType(PDFiumPage::Area area,
int form_type) const {
if (kViewerImplementedPanning && mouse_middle_button_down_)
return ui::mojom::CursorType::kHand;
switch (area) {
case PDFiumPage::TEXT_AREA:
return ui::mojom::CursorType::kIBeam;
case PDFiumPage::WEBLINK_AREA:
case PDFiumPage::DOCLINK_AREA:
return ui::mojom::CursorType::kHand;
case PDFiumPage::NONSELECTABLE_AREA:
case PDFiumPage::FORM_TEXT_AREA:
default:
switch (form_type) {
case FPDF_FORMFIELD_PUSHBUTTON:
case FPDF_FORMFIELD_CHECKBOX:
case FPDF_FORMFIELD_RADIOBUTTON:
case FPDF_FORMFIELD_COMBOBOX:
case FPDF_FORMFIELD_LISTBOX:
return ui::mojom::CursorType::kHand;
case FPDF_FORMFIELD_TEXTFIELD:
return ui::mojom::CursorType::kIBeam;
#if defined(PDF_ENABLE_XFA)
case FPDF_FORMFIELD_XFA_CHECKBOX:
case FPDF_FORMFIELD_XFA_COMBOBOX:
case FPDF_FORMFIELD_XFA_IMAGEFIELD:
case FPDF_FORMFIELD_XFA_LISTBOX:
case FPDF_FORMFIELD_XFA_PUSHBUTTON:
case FPDF_FORMFIELD_XFA_SIGNATURE:
return ui::mojom::CursorType::kHand;
case FPDF_FORMFIELD_XFA_TEXTFIELD:
return ui::mojom::CursorType::kIBeam;
#endif
default:
return ui::mojom::CursorType::kPointer;
}
}
}
void PDFiumEngine::OnMouseEnter(const blink::WebMouseEvent& event) {
if (event.GetModifiers() &
blink::WebInputEvent::Modifiers::kMiddleButtonDown) {
if (!mouse_middle_button_down_) {
mouse_middle_button_down_ = true;
mouse_middle_button_last_position_ =
gfx::ToRoundedPoint(event.PositionInWidget());
}
} else {
if (mouse_middle_button_down_) {
mouse_middle_button_down_ = false;
}
}
}
bool PDFiumEngine::ExtendSelection(int page_index, int char_index) {
DCHECK_GE(page_index, 0);
DCHECK_GE(char_index, 0);
// Check if the user has decreased their selection area and we need to remove
// pages from `selection_`.
for (size_t i = 0; i < selection_.size(); ++i) {
if (selection_[i].page_index() == page_index) {
// There should be no other pages after this.
selection_.erase(selection_.begin() + i + 1, selection_.end());
break;
}
}
if (selection_.empty())
return false;
const int last_page_index = selection_.back().page_index();
const int last_char_index = selection_.back().char_index();
if (last_page_index == page_index) {
// Selecting within a page.
int count = char_index - last_char_index;
if (count >= 0) {
// Selecting forward.
++count;
} else {
--count;
}
selection_.back().SetCharCount(count);
} else if (last_page_index < page_index) {
// Selecting into the next page.
// Save the current last selection for use below.
// Warning: Do not use references / pointers into `selection_`, as the code
// below can modify `selection_` and invalidate those references / pointers.
const size_t last_selection_index = selection_.size() - 1;
// First make sure that there are no gaps in selection, i.e. if mousedown on
// page one but we only get mousemove over page three, we want page two.
for (int i = last_page_index + 1; i < page_index; ++i) {
selection_.push_back(
PDFiumRange(pages_[i].get(), 0, pages_[i]->GetCharCount()));
}
int count = pages_[last_page_index]->GetCharCount();
selection_[last_selection_index].SetCharCount(count - last_char_index);
selection_.push_back(PDFiumRange(pages_[page_index].get(), 0, char_index));
} else {
// Selecting into the previous page.
// The selection's char_index is 0-based, so the character count is one
// more than the index. The character count needs to be negative to
// indicate a backwards selection.
selection_.back().SetCharCount(-last_char_index - 1);
// First make sure that there are no gaps in selection, i.e. if mousedown on
// page three but we only get mousemove over page one, we want page two.
for (int i = last_page_index - 1; i > page_index; --i) {
selection_.push_back(
PDFiumRange(pages_[i].get(), 0, pages_[i]->GetCharCount()));
}
int count = pages_[page_index]->GetCharCount();
selection_.emplace_back(pages_[page_index].get(), count - 1,
char_index - count);
}
return true;
}
bool PDFiumEngine::OnKeyDown(const blink::WebKeyboardEvent& event) {
// Handle tab events first as we might need to transition focus to an
// annotation in PDF.
if (event.windows_key_code == FWL_VKEY_Tab)
return HandleTabEvent(event.GetModifiers());
if (!PageIndexInBounds(last_focused_page_))
return false;
bool rv = !!FORM_OnKeyDown(form(), pages_[last_focused_page_]->GetPage(),
event.windows_key_code, event.GetModifiers());
if (!event.IsCharacterKey()) {
// Blink does not send char events for backspace or escape keys, see
// `blink::WebKeyboardEvent::IsCharacterKey()` and b/961192 for more
// information. So just fake one since PDFium uses it.
blink::WebKeyboardEvent synthesized(blink::WebInputEvent::Type::kChar,
event.GetModifiers(),
event.TimeStamp());
synthesized.windows_key_code = event.windows_key_code;
synthesized.text[0] = synthesized.windows_key_code;
synthesized.text[1] = L'\0';
OnChar(synthesized);
}
#if !BUILDFLAG(IS_MAC)
// macOS doesn't have keyboard-triggered context menus.
// Scroll focused annotation into view when context menu is invoked through
// keyboard <Shift-F10>.
if (event.windows_key_code == FWL_VKEY_F10 &&
(event.GetModifiers() & blink::WebInputEvent::Modifiers::kShiftKey)) {
DCHECK(!rv);
ScrollFocusedAnnotationIntoView();
}
#endif
return rv;
}
bool PDFiumEngine::OnKeyUp(const blink::WebKeyboardEvent& event) {
if (!PageIndexInBounds(last_focused_page_))
return false;
// Check if form text selection needs to be updated.
FPDF_PAGE page = pages_[last_focused_page_]->GetPage();
if (focus_field_type_ == FocusFieldType::kText)
SetFormSelectedText(form(), page);
return !!FORM_OnKeyUp(form(), page, event.windows_key_code,
event.GetModifiers());
}
bool PDFiumEngine::OnChar(const blink::WebKeyboardEvent& event) {
if (!PageIndexInBounds(last_focused_page_))
return false;
bool rv = !!FORM_OnChar(form(), pages_[last_focused_page_]->GetPage(),
event.text[0], event.GetModifiers());
// Scroll editable form text into view on char events. We should not scroll
// focused annotation on escape char event since escape char is used to
// dismiss focus from form controls.
if (rv && editable_form_text_area_ &&
event.windows_key_code != ui::VKEY_ESCAPE) {
ScrollFocusedAnnotationIntoView();
}
return rv;
}
void PDFiumEngine::StartFind(const std::u16string& text, bool case_sensitive) {
// If the caller asks StartFind() to search for no text, then this is an
// error on the part of the caller. The `blink::FindInPage` code guarantees it
// is not empty, so this should never happen.
DCHECK(!text.empty());
// If StartFind() gets called before we have any page information (i.e.
// before the first call to LoadDocument has happened). Handle this case.
if (pages_.empty()) {
client_->NotifyNumberOfFindResultsChanged(0, true);
return;
}
bool first_search = (current_find_text_ != text);
int character_to_start_searching_from = 0;
if (first_search) {
std::vector<PDFiumRange> old_selection = selection_;
StopFind();
current_find_text_ = text;
if (old_selection.empty()) {
// Start searching from the beginning of the document.
next_page_to_search_ = 0;
last_page_to_search_ = pages_.size() - 1;
last_character_index_to_search_ = -1;
} else {
// There's a current selection, so start from it.
next_page_to_search_ = old_selection[0].page_index();
last_character_index_to_search_ = old_selection[0].char_index();
character_to_start_searching_from = old_selection[0].char_index();
last_page_to_search_ = next_page_to_search_;
}
search_in_progress_ = true;
}
int current_page = next_page_to_search_;
if (pages_[current_page]->available()) {
// Don't use PDFium to search for now, since it doesn't support unicode
// text. Leave the code for now to avoid bit-rot, in case it's fixed later.
// The extra parens suppress a -Wunreachable-code warning.
if ((false)) {
SearchUsingPDFium(text, case_sensitive, first_search,
character_to_start_searching_from, current_page);
} else {
SearchUsingICU(text, case_sensitive, first_search,
character_to_start_searching_from, current_page);
}
if (!IsPageVisible(current_page))
pages_[current_page]->Unload();
}
if (next_page_to_search_ != last_page_to_search_ ||
(first_search && last_character_index_to_search_ != -1)) {
++next_page_to_search_;
}
if (next_page_to_search_ == static_cast<int>(pages_.size()))
next_page_to_search_ = 0;
// If there's only one page in the document and we start searching midway,
// then we'll want to search the page one more time.
bool end_of_search =
next_page_to_search_ == last_page_to_search_ &&
// Only one page but didn't start midway.
((pages_.size() == 1 && last_character_index_to_search_ == -1) ||
// Started midway, but only 1 page and we already looped around.
(pages_.size() == 1 && !first_search) ||
// Started midway, and we've just looped around.
(pages_.size() > 1 && current_page == next_page_to_search_));
if (end_of_search) {
search_in_progress_ = false;
// Send the final notification.
client_->NotifyNumberOfFindResultsChanged(find_results_.size(), true);
return;
}
// In unit tests, just call ContinueFind() directly for simplicity and reduce
// the need to use RunLoops.
if (doc_loader_set_for_testing_) {
ContinueFind(case_sensitive);
} else {
base::SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
FROM_HERE,
base::BindOnce(&PDFiumEngine::ContinueFind,
find_weak_factory_.GetWeakPtr(), case_sensitive));
}
}
void PDFiumEngine::SearchUsingPDFium(const std::u16string& term,
bool case_sensitive,
bool first_search,
int character_to_start_searching_from,
int current_page) {
// Find all the matches in the current page.
unsigned long flags = case_sensitive ? FPDF_MATCHCASE : 0;
FPDF_SCHHANDLE find =
FPDFText_FindStart(pages_[current_page]->GetTextPage(),
reinterpret_cast<const unsigned short*>(term.c_str()),
flags, character_to_start_searching_from);
// Note: since we search one page at a time, we don't find matches across
// page boundaries. We could do this manually ourself, but it seems low
// priority since Reader itself doesn't do it.
while (FPDFText_FindNext(find)) {
PDFiumRange result(pages_[current_page].get(),
FPDFText_GetSchResultIndex(find),
FPDFText_GetSchCount(find));
if (!first_search && last_character_index_to_search_ != -1 &&
result.page_index() == last_page_to_search_ &&
result.char_index() >= last_character_index_to_search_) {
break;
}
AddFindResult(result);
}
FPDFText_FindClose(find);
}
void PDFiumEngine::SearchUsingICU(const std::u16string& term,
bool case_sensitive,
bool first_search,
int character_to_start_searching_from,
int current_page) {
DCHECK(!term.empty());
// Various types of quotions marks need to be converted to the simple ASCII
// version for searching to get better matching.
std::u16string adjusted_term = term;
for (char16_t& c : adjusted_term)
c = SimplifyForSearch(c);
const int original_text_length = pages_[current_page]->GetCharCount();
int text_length = original_text_length;
if (character_to_start_searching_from) {
text_length -= character_to_start_searching_from;
} else if (!first_search && last_character_index_to_search_ != -1 &&
current_page == last_page_to_search_) {
text_length = last_character_index_to_search_;
}
if (text_length <= 0)
return;
std::u16string page_text;
PDFiumAPIStringBufferAdapter<std::u16string> api_string_adapter(
&page_text, text_length, false);
unsigned short* data =
reinterpret_cast<unsigned short*>(api_string_adapter.GetData());
int written =
FPDFText_GetText(pages_[current_page]->GetTextPage(),
character_to_start_searching_from, text_length, data);
api_string_adapter.Close(written);
const gfx::RectF page_bounds = pages_[current_page]->GetCroppedRect();
std::u16string adjusted_page_text;
adjusted_page_text.reserve(page_text.size());
// Values in `removed_indices` are in the adjusted text index space and
// indicate a character was removed from the page text before the given
// index. If multiple characters are removed in a row then there will be
// multiple entries with the same value.
std::vector<size_t> removed_indices;
// When walking through the page text collapse any whitespace regions,
// including \r and \n, down to a single ' ' character. This code does
// not use base::CollapseWhitespace(), because that function does not
// return where the collapsing occurs, but uses the same underlying list of
// whitespace characters. Calculating where the collapsed regions are after
// the fact is as complex as collapsing them manually.
for (size_t i = 0; i < page_text.size(); i++) {
// Filter out characters outside the page bounds, which are semantically not
// part of the page.
if (!pages_[current_page]->IsCharInPageBounds(
character_to_start_searching_from + i, page_bounds)) {
removed_indices.push_back(adjusted_page_text.size());
continue;
}
char16_t c = page_text[i];
// Collapse whitespace regions by inserting a ' ' into the
// adjusted text and recording any removed whitespace indices as preceding
// it.
if (base::IsUnicodeWhitespace(c)) {
size_t whitespace_region_begin = i;
while (i < page_text.size() && base::IsUnicodeWhitespace(page_text[i]))
++i;
size_t count = i - whitespace_region_begin - 1;
removed_indices.insert(removed_indices.end(), count,
adjusted_page_text.size());
adjusted_page_text.push_back(' ');
if (i >= page_text.size())
break;
c = page_text[i];
}
if (IsIgnorableCharacter(c))
removed_indices.push_back(adjusted_page_text.size());
else
adjusted_page_text.push_back(SimplifyForSearch(c));
}
if (adjusted_page_text.empty())
return;
std::vector<PDFiumEngineClient::SearchStringResult> results =
client_->SearchString(adjusted_page_text.c_str(), adjusted_term.c_str(),
case_sensitive);
for (const auto& result : results) {
// Need to convert from adjusted page text start to page text start, by
// incrementing for all the characters adjusted before it in the string.
auto removed_indices_begin = std::upper_bound(
removed_indices.begin(), removed_indices.end(), result.start_index);
size_t page_text_result_start_index =
result.start_index +
std::distance(removed_indices.begin(), removed_indices_begin);
// Need to convert the adjusted page length into a page text length, since
// the matching range may have adjusted characters within it. This
// conversion only cares about skipped characters in the result interval.
auto removed_indices_end =
std::upper_bound(removed_indices_begin, removed_indices.end(),
result.start_index + result.length);
int term_removed_count =
std::distance(removed_indices_begin, removed_indices_end);
int page_text_result_length = result.length + term_removed_count;
// Need to map the indexes from the page text, which may have generated
// characters like space etc, to character indices from the page.
int text_to_start_searching_from = FPDFText_GetTextIndexFromCharIndex(
pages_[current_page]->GetTextPage(), character_to_start_searching_from);
int temp_start =
page_text_result_start_index + text_to_start_searching_from;
int start = FPDFText_GetCharIndexFromTextIndex(
pages_[current_page]->GetTextPage(), temp_start);
int end = FPDFText_GetCharIndexFromTextIndex(
pages_[current_page]->GetTextPage(),
temp_start + page_text_result_length);
// If `term` occurs at the end of a page, then `end` will be -1 due to the
// index being out of bounds. Compensate for this case so the range
// character count calculation below works out.
if (temp_start + page_text_result_length == original_text_length) {
DCHECK_EQ(-1, end);
end = original_text_length;
}
DCHECK_LT(start, end);
DCHECK_EQ(term.size() + term_removed_count,
static_cast<size_t>(end - start));
AddFindResult(PDFiumRange(pages_[current_page].get(), start, end - start));
}
}
void PDFiumEngine::AddFindResult(const PDFiumRange& result) {
// Figure out where to insert the new location, since we could have
// started searching midway and now we wrapped.
size_t result_index;
int page_index = result.page_index();
int char_index = result.char_index();
for (result_index = 0; result_index < find_results_.size(); ++result_index) {
if (find_results_[result_index].page_index() > page_index ||
(find_results_[result_index].page_index() == page_index &&
find_results_[result_index].char_index() > char_index)) {
break;
}
}
find_results_.insert(find_results_.begin() + result_index, result);
UpdateTickMarks();
client_->NotifyNumberOfFindResultsChanged(find_results_.size(), false);
}
bool PDFiumEngine::SelectFindResult(bool forward) {
if (find_results_.empty())
return false;
SelectionChangeInvalidator selection_invalidator(this);
// Move back/forward through the search locations we previously found.
size_t new_index;
const size_t last_index = find_results_.size() - 1;
if (resume_find_index_) {
new_index = resume_find_index_.value();
resume_find_index_.reset();
} else if (current_find_index_) {
size_t current_index = current_find_index_.value();
if ((forward && current_index >= last_index) ||
(!forward && current_index == 0)) {
current_find_index_.reset();
client_->NotifySelectedFindResultChanged(-1, /*final_result=*/false);
client_->NotifyNumberOfFindResultsChanged(find_results_.size(),
/*final_result=*/true);
return true;
}
int increment = forward ? 1 : -1;
new_index = current_index + increment;
} else {
new_index = forward ? 0 : last_index;
}
current_find_index_ = new_index;
// Update the selection before telling the client to scroll, since it could
// paint then.
selection_.clear();
selection_.push_back(find_results_[current_find_index_.value()]);
// If the result is not in view, scroll to it.
gfx::Rect bounding_rect;
gfx::Rect visible_rect = GetVisibleRect();
// Use zoom of 1.0 since `visible_rect` is without zoom.
const std::vector<gfx::Rect>& rects =
find_results_[current_find_index_.value()].GetScreenRects(
gfx::Point(), 1.0, layout_.options().default_page_orientation());
for (const auto& rect : rects)
bounding_rect.Union(rect);
if (!visible_rect.Contains(bounding_rect)) {
gfx::Point center = bounding_rect.CenterPoint();
// Make the page centered.
int new_y = CalculateCenterForZoom(center.y(), visible_rect.height(),
current_zoom_);
client_->ScrollToY(new_y);
// Only move horizontally if it's not visible.
if (center.x() < visible_rect.x() || center.x() > visible_rect.right()) {
int new_x = CalculateCenterForZoom(center.x(), visible_rect.width(),
current_zoom_);
client_->ScrollToX(new_x);
}
}
client_->NotifySelectedFindResultChanged(
current_find_index_.value(), /*final_result=*/!search_in_progress_);
return true;
}
void PDFiumEngine::StopFind() {
SelectionChangeInvalidator selection_invalidator(this);
selection_.clear();
selecting_ = false;
find_results_.clear();
next_page_to_search_ = -1;
last_page_to_search_ = -1;
last_character_index_to_search_ = -1;
current_find_index_.reset();
current_find_text_.clear();
UpdateTickMarks();
find_weak_factory_.InvalidateWeakPtrs();
}
std::vector<gfx::Rect> PDFiumEngine::GetAllScreenRectsUnion(
const std::vector<PDFiumRange>& rect_range,
const gfx::Point& point) const {
std::vector<gfx::Rect> rect_vector;
rect_vector.reserve(rect_range.size());
for (const auto& range : rect_range) {
gfx::Rect result_rect;
const std::vector<gfx::Rect>& rects = range.GetScreenRects(
point, current_zoom_, layout_.options().default_page_orientation());
for (const auto& rect : rects)
result_rect.Union(rect);
rect_vector.push_back(result_rect);
}
return rect_vector;
}
void PDFiumEngine::UpdateTickMarks() {
std::vector<gfx::Rect> tickmarks =
GetAllScreenRectsUnion(find_results_, gfx::Point());
client_->UpdateTickMarks(tickmarks);
}
void PDFiumEngine::ZoomUpdated(double new_zoom_level) {
CancelPaints();
current_zoom_ = new_zoom_level;
CalculateVisiblePages();
UpdateTickMarks();
}
void PDFiumEngine::RotateClockwise() {
SaveSelection();
desired_layout_options_.RotatePagesClockwise();
ProposeNextDocumentLayout();
}
void PDFiumEngine::RotateCounterclockwise() {
SaveSelection();
desired_layout_options_.RotatePagesCounterclockwise();
ProposeNextDocumentLayout();
}
bool PDFiumEngine::IsReadOnly() const {
return read_only_;
}
void PDFiumEngine::SetReadOnly(bool read_only) {
read_only_ = read_only;
SetFormHighlight(!read_only_);
ClearTextSelection();
}
void PDFiumEngine::SetDocumentLayout(DocumentLayout::PageSpread page_spread) {
SaveSelection();
desired_layout_options_.set_page_spread(page_spread);
ProposeNextDocumentLayout();
}
void PDFiumEngine::DisplayAnnotations(bool display) {
if (render_annots_ == display)
return;
render_annots_ = display;
InvalidateAllPages();
}
void PDFiumEngine::InvalidateAllPages() {
CancelPaints();
StopFind();
DCHECK(document_loaded_);
RefreshCurrentDocumentLayout();
client_->Invalidate(gfx::Rect(plugin_size()));
}
std::string PDFiumEngine::GetSelectedText() {
std::u16string result;
for (size_t i = 0; i < selection_.size(); ++i) {
std::u16string current_selection_text = selection_[i].GetText();
if (i != 0) {
if (selection_[i - 1].page_index() > selection_[i].page_index())
std::swap(current_selection_text, result);
#if BUILDFLAG(IS_WIN)
result.push_back(L'\r');
#endif
result.push_back(L'\n');
}
result.append(current_selection_text);
}
FormatStringWithHyphens(&result);
FormatStringForOS(&result);
return base::UTF16ToUTF8(result);
}
bool PDFiumEngine::CanEditText() const {
return editable_form_text_area_;
}
bool PDFiumEngine::HasEditableText() const {
DCHECK(CanEditText());
if (!PageIndexInBounds(last_focused_page_))
return false;
FPDF_PAGE page = pages_[last_focused_page_]->GetPage();
// If the return value is 2, that corresponds to "\0\0".
return FORM_GetFocusedText(form(), page, nullptr, 0) > 2;
}
void PDFiumEngine::ReplaceSelection(const std::string& text) {
DCHECK(CanEditText());
if (!PageIndexInBounds(last_focused_page_))
return;
std::u16string text_wide = base::UTF8ToUTF16(text);
FORM_ReplaceSelection(form(), pages_[last_focused_page_]->GetPage(),
reinterpret_cast<FPDF_WIDESTRING>(text_wide.c_str()));
}
bool PDFiumEngine::CanUndo() const {
return PageIndexInBounds(last_focused_page_) &&
FORM_CanUndo(form(), pages_[last_focused_page_]->GetPage());
}
bool PDFiumEngine::CanRedo() const {
return PageIndexInBounds(last_focused_page_) &&
FORM_CanRedo(form(), pages_[last_focused_page_]->GetPage());
}
void PDFiumEngine::Undo() {
if (!PageIndexInBounds(last_focused_page_))
return;
FORM_Undo(form(), pages_[last_focused_page_]->GetPage());
}
void PDFiumEngine::Redo() {
if (!PageIndexInBounds(last_focused_page_))
return;
FORM_Redo(form(), pages_[last_focused_page_]->GetPage());
}
void PDFiumEngine::HandleAccessibilityAction(
const AccessibilityActionData& action_data) {
switch (action_data.action) {
case AccessibilityAction::kScrollToMakeVisible: {
ScrollBasedOnScrollAlignment(action_data.target_rect,
action_data.horizontal_scroll_alignment,
action_data.vertical_scroll_alignment);
return;
}
case AccessibilityAction::kDoDefaultAction: {
if (PageIndexInBounds(action_data.page_index)) {
if (action_data.annotation_type == AccessibilityAnnotationType::kLink) {
PDFiumPage::LinkTarget target;
PDFiumPage::Area area =
pages_[action_data.page_index]->GetLinkTargetAtIndex(
action_data.annotation_index, &target);
NavigateToLinkDestination(area, target,
WindowOpenDisposition::CURRENT_TAB);
}
}
return;
}
case AccessibilityAction::kScrollToGlobalPoint: {
ScrollToGlobalPoint(action_data.target_rect, action_data.target_point);
return;
}
case AccessibilityAction::kSetSelection: {
if (IsPageCharacterIndexInBounds(action_data.selection_start_index) &&
IsPageCharacterIndexInBounds(action_data.selection_end_index)) {
SetSelection(action_data.selection_start_index,
action_data.selection_end_index);
gfx::Rect target_rect = action_data.target_rect;
if (!GetVisibleRect().Contains(target_rect)) {
client_->ScrollBy(GetScreenRect(target_rect).OffsetFromOrigin());
}
}
return;
}
case AccessibilityAction::kNone:
NOTREACHED();
}
NOTREACHED();
}
std::string PDFiumEngine::GetLinkAtPosition(const gfx::Point& point) {
std::string url;
int temp;
int page_index = -1;
int form_type = FPDF_FORMFIELD_UNKNOWN;
PDFiumPage::LinkTarget target;
PDFiumPage::Area area =
GetCharIndex(point, &page_index, &temp, &form_type, &target);
if (area == PDFiumPage::WEBLINK_AREA)
url = target.url;
return url;
}
bool PDFiumEngine::HasPermission(DocumentPermission permission) const {
// No `permissions_` means no restrictions.
if (!permissions_)
return true;
return permissions_->HasPermission(permission);
}
void PDFiumEngine::SelectAll() {
if (IsReadOnly())
return;
#if BUILDFLAG(ENABLE_PDF_INK2)
if (client_->IsInAnnotationMode()) {
return;
}
#endif // BUILDFLAG(ENABLE_PDF_INK2)
if (focus_field_type_ == FocusFieldType::kText) {
if (PageIndexInBounds(last_focused_page_))
FORM_SelectAllText(form(), pages_[last_focused_page_]->GetPage());
return;
}
SelectionChangeInvalidator selection_invalidator(this);
selection_.clear();
for (const auto& page : pages_) {
if (page->available())
selection_.push_back(PDFiumRange(page.get(), 0, page->GetCharCount()));
}
}
const std::vector<DocumentAttachmentInfo>&
PDFiumEngine::GetDocumentAttachmentInfoList() const {
DCHECK(document_loaded_);
return doc_attachment_info_list_;
}
std::vector<uint8_t> PDFiumEngine::GetAttachmentData(size_t index) {
DCHECK_LT(index, doc_attachment_info_list_.size());
DCHECK(doc_attachment_info_list_[index].is_readable);
unsigned long length_bytes = doc_attachment_info_list_[index].size_bytes;
DCHECK_NE(length_bytes, 0u);
FPDF_ATTACHMENT attachment = FPDFDoc_GetAttachment(doc(), index);
std::vector<uint8_t> content_buf(length_bytes);
unsigned long data_size_bytes;
bool is_attachment_readable = FPDFAttachment_GetFile(
attachment, content_buf.data(), length_bytes, &data_size_bytes);
DCHECK(is_attachment_readable);
DCHECK_EQ(length_bytes, data_size_bytes);
return content_buf;
}
const DocumentMetadata& PDFiumEngine::GetDocumentMetadata() const {
DCHECK(document_loaded_);
return doc_metadata_;
}
int PDFiumEngine::GetNumberOfPages() const {
return pages_.size();
}
base::Value::List PDFiumEngine::GetBookmarks() {
base::Value::Dict dict = TraverseBookmarks(nullptr, 0);
// The root bookmark contains no useful information.
base::Value::List* children = dict.FindList("children");
return std::move(*children);
}
base::Value::Dict PDFiumEngine::TraverseBookmarks(FPDF_BOOKMARK bookmark,
unsigned int depth) {
base::Value::Dict dict;
std::u16string title = CallPDFiumWideStringBufferApi(
base::BindRepeating(&FPDFBookmark_GetTitle, bookmark),
/*check_expected_size=*/true);
dict.Set("title", title);
FPDF_DEST dest = FPDFBookmark_GetDest(doc(), bookmark);
// Some bookmarks don't have a page to select.
if (dest) {
int page_index = FPDFDest_GetDestPageIndex(doc(), dest);
if (PageIndexInBounds(page_index)) {
dict.Set("page", page_index);
std::optional<float> x;
std::optional<float> y;
std::optional<float> zoom;
pages_[page_index]->GetPageDestinationTarget(dest, &x, &y, &zoom);
if (x)
dict.Set("x", static_cast<int>(x.value()));
if (y)
dict.Set("y", static_cast<int>(y.value()));
if (zoom)
dict.Set("zoom", static_cast<double>(zoom.value()));
}
} else {
// Extract URI for bookmarks linking to an external page.
FPDF_ACTION action = FPDFBookmark_GetAction(bookmark);
std::string uri = CallPDFiumStringBufferApi(
base::BindRepeating(&FPDFAction_GetURIPath, doc(), action),
/*check_expected_size=*/true);
if (!uri.empty() && base::IsStringUTF8AllowingNoncharacters(uri))
dict.Set("uri", uri);
}
base::Value::List children;
// Don't trust PDFium to handle circular bookmarks.
constexpr unsigned int kMaxDepth = 128;
if (depth < kMaxDepth) {
std::set<FPDF_BOOKMARK> seen_bookmarks;
for (FPDF_BOOKMARK child_bookmark =
FPDFBookmark_GetFirstChild(doc(), bookmark);
child_bookmark;
child_bookmark = FPDFBookmark_GetNextSibling(doc(), child_bookmark)) {
if (base::Contains(seen_bookmarks, child_bookmark))
break;
seen_bookmarks.insert(child_bookmark);
children.Append(TraverseBookmarks(child_bookmark, depth + 1));
}
}
dict.Set("children", std::move(children));
return dict;
}
void PDFiumEngine::ScrollBasedOnScrollAlignment(
const gfx::Rect& scroll_rect,
const AccessibilityScrollAlignment& horizontal_scroll_alignment,
const AccessibilityScrollAlignment& vertical_scroll_alignment) {
gfx::Vector2d scroll_offset = GetScreenRect(scroll_rect).OffsetFromOrigin();
switch (horizontal_scroll_alignment) {
case AccessibilityScrollAlignment::kRight:
scroll_offset.set_x(scroll_offset.x() - plugin_size().width());
break;
case AccessibilityScrollAlignment::kCenter:
scroll_offset.set_x(scroll_offset.x() - (plugin_size().width() / 2));
break;
case AccessibilityScrollAlignment::kClosestToEdge: {
scroll_offset.set_x((std::abs(scroll_offset.x()) <=
std::abs(scroll_offset.x() - plugin_size().width()))
? scroll_offset.x()
: scroll_offset.x() - plugin_size().width());
break;
}
case AccessibilityScrollAlignment::kNone:
scroll_offset.set_x(0);
break;
case AccessibilityScrollAlignment::kLeft:
case AccessibilityScrollAlignment::kTop:
case AccessibilityScrollAlignment::kBottom:
default:
break;
}
switch (vertical_scroll_alignment) {
case AccessibilityScrollAlignment::kBottom:
scroll_offset.set_y(scroll_offset.y() - plugin_size().height());
break;
case AccessibilityScrollAlignment::kCenter:
scroll_offset.set_y(scroll_offset.y() - (plugin_size().height() / 2));
break;
case AccessibilityScrollAlignment::kClosestToEdge: {
scroll_offset.set_y((std::abs(scroll_offset.y()) <=
std::abs(scroll_offset.y() - plugin_size().height()))
? scroll_offset.y()
: scroll_offset.y() - plugin_size().height());
break;
}
case AccessibilityScrollAlignment::kNone:
scroll_offset.set_y(0);
break;
case AccessibilityScrollAlignment::kTop:
case AccessibilityScrollAlignment::kLeft:
case AccessibilityScrollAlignment::kRight:
default:
break;
}
client_->ScrollBy(scroll_offset);
}
void PDFiumEngine::ScrollToGlobalPoint(const gfx::Rect& target_rect,
const gfx::Point& global_point) {
gfx::Point scroll_offset = GetScreenRect(target_rect).origin();
client_->ScrollBy(scroll_offset - global_point);
}
std::optional<PDFiumEngine::NamedDestination> PDFiumEngine::GetNamedDestination(
const std::string& destination) {
// Look for the destination.
FPDF_DEST dest = FPDF_GetNamedDestByName(doc(), destination.c_str());
if (!dest) {
// Look for a bookmark with the same name.
std::u16string destination_wide = base::UTF8ToUTF16(destination);
FPDF_WIDESTRING destination_pdf_wide =
reinterpret_cast<FPDF_WIDESTRING>(destination_wide.c_str());
FPDF_BOOKMARK bookmark = FPDFBookmark_Find(doc(), destination_pdf_wide);
if (bookmark)
dest = FPDFBookmark_GetDest(doc(), bookmark);
}
if (!dest)
return {};
int page = FPDFDest_GetDestPageIndex(doc(), dest);
if (!PageIndexInBounds(page))
return {};
NamedDestination result;
result.page = page;
unsigned long view_int =
FPDFDest_GetView(dest, &result.num_params, result.params);
// FPDFDest_GetView() gets the in-page coordinates directly from the PDF
// document. The in-page coordinates need to be transformed into in-screen
// coordinates before getting sent to the viewport.
PDFiumPage* page_ptr = pages_[page].get();
ParamsTransformPageToScreen(view_int, page_ptr, result.params);
if (view_int == PDFDEST_VIEW_XYZ)
result.xyz_params = GetXYZParamsString(dest, page_ptr);
result.view = ConvertViewIntToViewString(view_int);
return result;
}
int PDFiumEngine::GetMostVisiblePage() {
if (in_flight_visible_page_)
return *in_flight_visible_page_;
// We can call GetMostVisiblePage through a callback from PDFium. We have
// to defer the page deletion otherwise we could potentially delete the page
// that originated the calling JS request and destroy the objects that are
// currently being used.
base::AutoReset<bool> defer_page_unload_guard(&defer_page_unload_, true);
CalculateVisiblePages();
return most_visible_page_;
}
gfx::Rect PDFiumEngine::GetPageBoundsRect(int index) {
return pages_[index]->rect();
}
gfx::Rect PDFiumEngine::GetPageContentsRect(int index) {
return GetScreenRect(pages_[index]->rect());
}
void PDFiumEngine::SetGrayscale(bool grayscale) {
render_grayscale_ = grayscale;
}
void PDFiumEngine::HandleLongPress(const blink::WebTouchEvent& event) {
base::AutoReset<bool> handling_long_press_guard(&handling_long_press_, true);
// Only consider the first touch point.
DCHECK_GT(event.touches_length, 0u);
// Send a fake mouse down to trigger the multi-click selection code.
blink::WebMouseEvent mouse_event(blink::WebInputEvent::Type::kMouseDown,
event.GetModifiers(), event.TimeStamp());
mouse_event.button = blink::WebPointerProperties::Button::kLeft;
mouse_event.click_count = 2;
mouse_event.SetPositionInWidget(event.touches[0].PositionInWidget());
OnMouseDown(mouse_event);
}
int PDFiumEngine::GetCharCount(int page_index) {
DCHECK(PageIndexInBounds(page_index));
return pages_[page_index]->GetCharCount();
}
gfx::RectF PDFiumEngine::GetCharBounds(int page_index, int char_index) {
DCHECK(PageIndexInBounds(page_index));
return pages_[page_index]->GetCharBounds(char_index);
}
uint32_t PDFiumEngine::GetCharUnicode(int page_index, int char_index) {
DCHECK(PageIndexInBounds(page_index));
return pages_[page_index]->GetCharUnicode(char_index);
}
std::optional<AccessibilityTextRunInfo> PDFiumEngine::GetTextRunInfo(
int page_index,
int start_char_index) {
DCHECK(PageIndexInBounds(page_index));
return pages_[page_index]->GetTextRunInfo(start_char_index);
}
std::vector<AccessibilityLinkInfo> PDFiumEngine::GetLinkInfo(
int page_index,
const std::vector<AccessibilityTextRunInfo>& text_runs) {
DCHECK(PageIndexInBounds(page_index));
return pages_[page_index]->GetLinkInfo(text_runs);
}
std::vector<AccessibilityImageInfo> PDFiumEngine::GetImageInfo(
int page_index,
uint32_t text_run_count) {
DCHECK(PageIndexInBounds(page_index));
return pages_[page_index]->GetImageInfo(text_run_count);
}
SkBitmap PDFiumEngine::GetImageForOcr(int page_index, int image_index) {
DCHECK(PageIndexInBounds(page_index));
return pages_[page_index]->GetImageForOcr(image_index);
}
std::vector<AccessibilityHighlightInfo> PDFiumEngine::GetHighlightInfo(
int page_index,
const std::vector<AccessibilityTextRunInfo>& text_runs) {
DCHECK(PageIndexInBounds(page_index));
return pages_[page_index]->GetHighlightInfo(text_runs);
}
std::vector<AccessibilityTextFieldInfo> PDFiumEngine::GetTextFieldInfo(
int page_index,
uint32_t text_run_count) {
DCHECK(PageIndexInBounds(page_index));
return pages_[page_index]->GetTextFieldInfo(text_run_count);
}
bool PDFiumEngine::GetPrintScaling() {
return !!FPDF_VIEWERREF_GetPrintScaling(doc());
}
int PDFiumEngine::GetCopiesToPrint() {
return FPDF_VIEWERREF_GetNumCopies(doc());
}
printing::mojom::DuplexMode PDFiumEngine::GetDuplexMode() {
switch (FPDF_VIEWERREF_GetDuplex(doc())) {
case Simplex:
return printing::mojom::DuplexMode::kSimplex;
case DuplexFlipShortEdge:
return printing::mojom::DuplexMode::kShortEdge;
case DuplexFlipLongEdge:
return printing::mojom::DuplexMode::kLongEdge;
default:
return printing::mojom::DuplexMode::kUnknownDuplexMode;
}
}
std::optional<gfx::Size> PDFiumEngine::GetUniformPageSizePoints() {
if (pages_.empty())
return std::nullopt;
gfx::Size page_size = GetPageSize(0);
for (size_t i = 1; i < pages_.size(); ++i) {
if (page_size != GetPageSize(i))
return std::nullopt;
}
// Convert `page_size` back to points.
return gfx::Size(
ConvertUnit(page_size.width(), kPixelsPerInch, kPointsPerInch),
ConvertUnit(page_size.height(), kPixelsPerInch, kPointsPerInch));
}
void PDFiumEngine::AppendBlankPages(size_t num_pages) {
DCHECK_GT(num_pages, 0U);
if (!doc())
return;
selection_.clear();
pending_pages_.clear();
// Delete all pages except the first one.
while (pages_.size() > 1) {
pages_.pop_back();
FPDFPage_Delete(doc(), pages_.size());
}
// Create blank pages with the same size as the first page.
gfx::Size page_0_size = GetPageSize(0);
float page_0_width_in_points =
ConvertUnitFloat(page_0_size.width(), kPixelsPerInch, kPointsPerInch);
float page_0_height_in_points =
ConvertUnitFloat(page_0_size.height(), kPixelsPerInch, kPointsPerInch);
for (size_t i = 1; i < num_pages; ++i) {
{
// Add a new page to the document, but delete the FPDF_PAGE object.
ScopedFPDFPage temp_page(FPDFPage_New(doc(), i, page_0_width_in_points,
page_0_height_in_points));
}
auto page = std::make_unique<PDFiumPage>(this, i);
page->MarkAvailable();
pages_.push_back(std::move(page));
}
DCHECK(document_loaded_);
LoadPageInfo();
}
gfx::Size PDFiumEngine::plugin_size() const {
if (plugin_size_.has_value()) {
return plugin_size_.value();
}
// TODO(crbug.com/40193305): Fix call sites and inline this getter again.
DUMP_WILL_BE_NOTREACHED();
return gfx::Size();
}
void PDFiumEngine::LoadDocument() {
// Check if the document is ready for loading. If it isn't just bail for now,
// we will call LoadDocument() again later.
if (!doc() && !doc_loader_->IsDocumentComplete()) {
FX_DOWNLOADHINTS& download_hints = document_->download_hints();
if (!FPDFAvail_IsDocAvail(fpdf_availability(), &download_hints))
return;
}
// If we're in the middle of getting a password, just return. We will retry
// loading the document after we get the password anyway.
if (getting_password_)
return;
bool needs_password = false;
if (TryLoadingDoc(std::string(), &needs_password)) {
ContinueLoadingDocument(std::string());
return;
}
if (needs_password)
GetPasswordAndLoad();
else
client_->DocumentLoadFailed();
}
bool PDFiumEngine::TryLoadingDoc(const std::string& password,
bool* needs_password) {
*needs_password = false;
if (doc()) {
// This is probably not necessary, because it should have already been
// called below in the `doc_` initialization path. However, the previous
// call may have failed, so call it again for good measure.
FX_DOWNLOADHINTS& download_hints = document_->download_hints();
FPDFAvail_IsDocAvail(fpdf_availability(), &download_hints);
return true;
}
if (!password.empty())
password_tries_remaining_--;
{
ScopedUnsupportedFeature scoped_unsupported_feature(this);
document_->LoadDocument(password);
}
if (!doc()) {
if (FPDF_GetLastError() == FPDF_ERR_PASSWORD)
*needs_password = true;
return false;
}
// Always call FPDFAvail_IsDocAvail() so PDFium initializes internal data
// structures.
FX_DOWNLOADHINTS& download_hints = document_->download_hints();
FPDFAvail_IsDocAvail(fpdf_availability(), &download_hints);
return true;
}
void PDFiumEngine::GetPasswordAndLoad() {
getting_password_ = true;
DCHECK(!doc());
DCHECK_EQ(static_cast<unsigned long>(FPDF_ERR_PASSWORD), FPDF_GetLastError());
client_->GetDocumentPassword(base::BindOnce(
&PDFiumEngine::OnGetPasswordComplete, weak_factory_.GetWeakPtr()));
}
void PDFiumEngine::OnGetPasswordComplete(const std::string& password) {
getting_password_ = false;
ContinueLoadingDocument(password);
}
void PDFiumEngine::ContinueLoadingDocument(const std::string& password) {
bool needs_password = false;
bool loaded = TryLoadingDoc(password, &needs_password);
bool password_incorrect = !loaded && needs_password && !password.empty();
if (password_incorrect && password_tries_remaining_ > 0) {
GetPasswordAndLoad();
return;
}
if (!doc()) {
client_->DocumentLoadFailed();
return;
}
if (FPDFDoc_GetPageMode(doc()) == PAGEMODE_USEOUTLINES)
client_->DocumentHasUnsupportedFeature("Bookmarks");
permissions_ = std::make_unique<PDFiumPermissions>(doc());
LoadBody();
if (doc_loader_->IsDocumentComplete())
FinishLoadingDocument();
}
void PDFiumEngine::LoadPageInfo() {
RefreshCurrentDocumentLayout();
// TODO(crbug.com/40652841): RefreshCurrentDocumentLayout() should send some
// sort of "current layout changed" notification, instead of proposing a new
// layout. Proposals are never rejected currently, so this is OK for now.
ProposeNextDocumentLayout();
}
void PDFiumEngine::RefreshCurrentDocumentLayout() {
UpdateDocumentLayout(&layout_);
if (!layout_.dirty())
return;
DCHECK_EQ(pages_.size(), layout_.page_count());
for (size_t i = 0; i < layout_.page_count(); ++i) {
// TODO(kmoon): This should be the only place that sets `PDFiumPage::rect_`.
pages_[i]->set_rect(layout_.page_bounds_rect(i));
}
layout_.clear_dirty();
CalculateVisiblePages();
}
void PDFiumEngine::ProposeNextDocumentLayout() {
DocumentLayout next_layout;
next_layout.SetOptions(desired_layout_options_);
UpdateDocumentLayout(&next_layout);
// The time windows between proposal and application may overlap, so we must
// always propose a new layout, regardless of the current layout state.
client_->ProposeDocumentLayout(next_layout);
}
void PDFiumEngine::UpdateDocumentLayout(DocumentLayout* layout) {
layout->ComputeLayout(LoadPageSizes(layout->options()));
}
std::vector<gfx::Size> PDFiumEngine::LoadPageSizes(
const DocumentLayout::Options& layout_options) {
std::vector<gfx::Size> page_sizes;
if (!doc_loader_)
return page_sizes;
if (pages_.empty() && document_loaded_)
return page_sizes;
pending_pages_.clear();
size_t new_page_count = FPDF_GetPageCount(doc());
const bool doc_complete = doc_loader_->IsDocumentComplete();
const bool is_linear = IsLinearized();
for (size_t i = 0; i < new_page_count; ++i) {
// Get page availability. If `document_loaded_` == true and the page is not
// new, then the page has been constructed already. Get page availability
// flag from already existing PDFiumPage object. If `document_loaded_` ==
// false or the page is new, then the page may not be fully loaded yet.
bool page_available;
if (document_loaded_ && i < pages_.size()) {
page_available = pages_[i]->available();
} else if (is_linear) {
FX_DOWNLOADHINTS& download_hints = document_->download_hints();
int linear_page_avail =
FPDFAvail_IsPageAvail(fpdf_availability(), i, &download_hints);
page_available = linear_page_avail == PDF_DATA_AVAIL;
} else {
page_available = doc_complete;
}
// TODO(crbug.com/40652841): It'd be better if page size were independent of
// layout options, and handled in the layout code.
gfx::Size size = page_available ? GetPageSizeForLayout(i, layout_options)
: default_page_size_;
page_sizes.push_back(size +
GetInsets(layout_options, i, new_page_count).size());
}
// Add new pages. If `document_loaded_` == false, do not mark page as
// available even if `doc_complete` is true because FPDFAvail_IsPageAvail()
// still has to be called for this page, which will be done in
// FinishLoadingDocument().
for (size_t i = pages_.size(); i < new_page_count; ++i) {
auto page = std::make_unique<PDFiumPage>(this, i);
if (document_loaded_ &&
FPDFAvail_IsPageAvail(fpdf_availability(), i, nullptr))
page->MarkAvailable();
pages_.push_back(std::