#ifndef PDF_PDF_VIEW_WEB_PLUGIN_H_
#define PDF_PDF_VIEW_WEB_PLUGIN_H_
#include <stdint.h>
#include <memory>
#include <string>
#include <vector>
#include "base/containers/flat_set.h"
#include "base/containers/queue.h"
#include "base/functional/callback_forward.h"
#include "base/i18n/rtl.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/weak_ptr.h"
#include "base/strings/string_piece_forward.h"
#include "base/values.h"
#include "cc/paint/paint_image.h"
#include "mojo/public/cpp/bindings/associated_remote.h"
#include "mojo/public/cpp/bindings/receiver.h"
#include "pdf/accessibility_structs.h"
#include "pdf/loader/url_loader.h"
#include "pdf/mojom/pdf.mojom.h"
#include "pdf/paint_manager.h"
#include "pdf/pdf_accessibility_action_handler.h"
#include "pdf/pdf_engine.h"
#include "pdf/pdfium/pdfium_form_filler.h"
#include "pdf/post_message_receiver.h"
#include "pdf/preview_mode_client.h"
#include "pdf/v8_value_converter.h"
#include "third_party/blink/public/platform/web_string.h"
#include "third_party/blink/public/platform/web_text_input_type.h"
#include "third_party/blink/public/web/web_plugin.h"
#include "third_party/blink/public/web/web_plugin_container.h"
#include "third_party/blink/public/web/web_plugin_params.h"
#include "third_party/blink/public/web/web_print_params.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/gfx/geometry/rect.h"
#include "ui/gfx/geometry/size.h"
#include "ui/gfx/geometry/vector2d_f.h"
#include "v8/include/v8.h"
namespace blink {
class WebAssociatedURLLoader;
class WebInputEvent;
class WebURL;
class WebURLRequest;
struct WebAssociatedURLLoaderOptions;
struct WebPrintPresetOptions;
}
namespace gfx {
class PointF;
class Range;
}
namespace net {
class SiteForCookies;
}
namespace printing {
class MetafileSkia;
}
namespace chrome_pdf {
class MetricsHandler;
class PDFiumEngine;
class PdfAccessibilityDataHandler;
class Thumbnail;
class PdfViewWebPlugin final : public PDFEngine::Client,
public blink::WebPlugin,
public pdf::mojom::PdfListener,
public UrlLoader::Client,
public PostMessageReceiver::Client,
public PaintManager::Client,
public PdfAccessibilityActionHandler,
public PreviewModeClient::Client {
public:
static constexpr size_t kMaximumSavedFileSize = 100 * 1000 * 1000;
enum class DocumentLoadState {
kLoading = 0,
kComplete,
kFailed,
};
enum class SaveRequestType {
kAnnotation = 0,
kOriginal = 1,
kEdited = 2,
};
class Client : public V8ValueConverter {
public:
virtual ~Client() = default;
virtual base::WeakPtr<Client> GetWeakPtr() = 0;
virtual std::unique_ptr<PDFiumEngine> CreateEngine(
PDFEngine::Client* client,
PDFiumFormFiller::ScriptOption script_option);
virtual void SetPluginContainer(blink::WebPluginContainer* container) = 0;
virtual blink::WebPluginContainer* PluginContainer() = 0;
virtual net::SiteForCookies SiteForCookies() const = 0;
virtual blink::WebURL CompleteURL(
const blink::WebString& partial_url) const = 0;
virtual void PostMessage(base::Value::Dict message) {}
virtual void Invalidate() = 0;
virtual void RequestTouchEventType(
blink::WebPluginContainer::TouchEventRequestType request_type) = 0;
virtual void ReportFindInPageMatchCount(int identifier,
int total,
bool final_update) = 0;
virtual void ReportFindInPageSelection(int identifier,
int index,
bool final_update) = 0;
virtual void ReportFindInPageTickmarks(
const std::vector<gfx::Rect>& tickmarks) = 0;
virtual float DeviceScaleFactor() = 0;
virtual gfx::PointF GetScrollPosition() = 0;
virtual void UsePluginAsFindHandler() = 0;
virtual void SetReferrerForRequest(blink::WebURLRequest& request,
const blink::WebURL& referrer_url) = 0;
virtual void Alert(const blink::WebString& message) = 0;
virtual bool Confirm(const blink::WebString& message) = 0;
virtual blink::WebString Prompt(const blink::WebString& message,
const blink::WebString& default_value) = 0;
virtual void TextSelectionChanged(const blink::WebString& selection_text,
uint32_t offset,
const gfx::Range& range) = 0;
virtual std::unique_ptr<blink::WebAssociatedURLLoader>
CreateAssociatedURLLoader(
const blink::WebAssociatedURLLoaderOptions& options) = 0;
virtual void UpdateTextInputState() = 0;
virtual void UpdateSelectionBounds() = 0;
virtual std::string GetEmbedderOriginString() = 0;
virtual bool HasFrame() const = 0;
virtual void DidStartLoading() = 0;
virtual void DidStopLoading() = 0;
virtual void Print() {}
virtual void RecordComputedAction(const std::string& action) {}
virtual std::unique_ptr<PdfAccessibilityDataHandler>
CreateAccessibilityDataHandler(
PdfAccessibilityActionHandler* action_handler);
};
PdfViewWebPlugin(std::unique_ptr<Client> client,
mojo::AssociatedRemote<pdf::mojom::PdfService> pdf_service,
const blink::WebPluginParams& params);
PdfViewWebPlugin(const PdfViewWebPlugin& other) = delete;
PdfViewWebPlugin& operator=(const PdfViewWebPlugin& other) = delete;
bool Initialize(blink::WebPluginContainer* container) override;
void Destroy() override;
blink::WebPluginContainer* Container() const override;
v8::Local<v8::Object> V8ScriptableObject(v8::Isolate* isolate) override;
bool SupportsKeyboardFocus() const override;
void UpdateAllLifecyclePhases(blink::DocumentUpdateReason reason) override;
void Paint(cc::PaintCanvas* canvas, const gfx::Rect& rect) override;
void UpdateGeometry(const gfx::Rect& window_rect,
const gfx::Rect& clip_rect,
const gfx::Rect& unobscured_rect,
bool is_visible) override;
void UpdateFocus(bool focused, blink::mojom::FocusType focus_type) override;
void UpdateVisibility(bool visibility) override;
blink::WebInputEventResult HandleInputEvent(
const blink::WebCoalescedInputEvent& event,
ui::Cursor* cursor) override;
void DidReceiveResponse(const blink::WebURLResponse& response) override;
void DidReceiveData(const char* data, size_t data_length) override;
void DidFinishLoading() override;
void DidFailLoading(const blink::WebURLError& error) override;
bool SupportsPaginatedPrint() override;
bool GetPrintPresetOptionsFromDocument(
blink::WebPrintPresetOptions* print_preset_options) override;
int PrintBegin(const blink::WebPrintParams& print_params) override;
void PrintPage(int page_number, cc::PaintCanvas* canvas) override;
void PrintEnd() override;
bool HasSelection() const override;
blink::WebString SelectionAsText() const override;
blink::WebString SelectionAsMarkup() const override;
bool CanEditText() const override;
bool HasEditableText() const override;
bool CanUndo() const override;
bool CanRedo() const override;
bool CanCopy() const override;
bool ExecuteEditCommand(const blink::WebString& name,
const blink::WebString& value) override;
blink::WebURL LinkAtPosition(const gfx::Point& ) const override;
bool StartFind(const blink::WebString& search_text,
bool case_sensitive,
int identifier) override;
void SelectFindResult(bool forward, int identifier) override;
void StopFind() override;
bool CanRotateView() override;
void RotateView(blink::WebPlugin::RotationType type) override;
bool ShouldDispatchImeEventsToPlugin() override;
blink::WebTextInputType GetPluginTextInputType() override;
gfx::Rect GetPluginCaretBounds() override;
void ImeSetCompositionForPlugin(
const blink::WebString& text,
const std::vector<ui::ImeTextSpan>& ime_text_spans,
const gfx::Range& replacement_range,
int selection_start,
int selection_end) override;
void ImeCommitTextForPlugin(
const blink::WebString& text,
const std::vector<ui::ImeTextSpan>& ime_text_spans,
const gfx::Range& replacement_range,
int relative_cursor_pos) override;
void ImeFinishComposingTextForPlugin(bool keep_selection) override;
void ProposeDocumentLayout(const DocumentLayout& layout) override;
void Invalidate(const gfx::Rect& rect) override;
void DidScroll(const gfx::Vector2d& offset) override;
void ScrollToX(int x_screen_coords) override;
void ScrollToY(int y_screen_coords) override;
void ScrollBy(const gfx::Vector2d& delta) override;
void ScrollToPage(int page) override;
void NavigateTo(const std::string& url,
WindowOpenDisposition disposition) override;
void NavigateToDestination(int page,
const float* x,
const float* y,
const float* zoom) override;
void UpdateCursor(ui::mojom::CursorType new_cursor_type) override;
void UpdateTickMarks(const std::vector<gfx::Rect>& tickmarks) override;
void NotifyNumberOfFindResultsChanged(int total, bool final_result) override;
void NotifySelectedFindResultChanged(int current_find_index,
bool final_result) override;
void NotifyTouchSelectionOccurred() override;
void GetDocumentPassword(
base::OnceCallback<void(const std::string&)> callback) override;
void Beep() override;
void Alert(const std::string& message) override;
bool Confirm(const std::string& message) override;
std::string Prompt(const std::string& question,
const std::string& default_answer) override;
std::string GetURL() override;
void Email(const std::string& to,
const std::string& cc,
const std::string& bcc,
const std::string& subject,
const std::string& body) override;
void Print() override;
void SubmitForm(const std::string& url,
const void* data,
int length) override;
std::unique_ptr<UrlLoader> CreateUrlLoader() override;
std::vector<SearchStringResult> SearchString(const char16_t* string,
const char16_t* term,
bool case_sensitive) override;
void DocumentLoadComplete() override;
void DocumentLoadFailed() override;
void DocumentHasUnsupportedFeature(const std::string& feature) override;
void DocumentLoadProgress(uint32_t available, uint32_t doc_size) override;
void FormFieldFocusChange(PDFEngine::FocusFieldType type) override;
bool IsPrintPreview() const override;
SkColor GetBackgroundColor() const override;
void SetIsSelecting(bool is_selecting) override;
void SelectionChanged(const gfx::Rect& left, const gfx::Rect& right) override;
void CaretChanged(const gfx::Rect& caret_rect) override;
void EnteredEditMode() override;
void DocumentFocusChanged(bool document_has_focus) override;
void SetSelectedText(const std::string& selected_text) override;
void SetLinkUnderCursor(const std::string& link_under_cursor) override;
bool IsValidLink(const std::string& url) override;
void SetCaretPosition(const gfx::PointF& position) override;
void MoveRangeSelectionExtent(const gfx::PointF& extent) override;
void SetSelectionBounds(const gfx::PointF& base,
const gfx::PointF& extent) override;
bool IsValid() const override;
blink::WebURL CompleteURL(const blink::WebString& partial_url) const override;
net::SiteForCookies SiteForCookies() const override;
void SetReferrerForRequest(blink::WebURLRequest& request,
const blink::WebURL& referrer_url) override;
std::unique_ptr<blink::WebAssociatedURLLoader> CreateAssociatedURLLoader(
const blink::WebAssociatedURLLoaderOptions& options) override;
void OnMessage(const base::Value::Dict& message) override;
void InvalidatePluginContainer() override;
void OnPaint(const std::vector<gfx::Rect>& paint_rects,
std::vector<PaintReadyRect>& ready,
std::vector<gfx::Rect>& pending) override;
void UpdateSnapshot(sk_sp<SkImage> snapshot) override;
void UpdateScale(float scale) override;
void UpdateLayerTransform(float scale,
const gfx::Vector2dF& translate) override;
void EnableAccessibility() override;
void HandleAccessibilityAction(
const AccessibilityActionData& action_data) override;
void PreviewDocumentLoadComplete() override;
void PreviewDocumentLoadFailed() override;
bool InitializeForTesting();
const gfx::Rect& GetPluginRectForTesting() const { return plugin_rect_; }
float GetDeviceScaleForTesting() const { return device_scale_; }
DocumentLoadState document_load_state_for_testing() const {
return document_load_state_;
}
int GetContentRestrictionsForTesting() const {
return GetContentRestrictions();
}
AccessibilityDocInfo GetAccessibilityDocInfoForTesting() const {
return GetAccessibilityDocInfo();
}
private:
using LoadUrlCallback =
base::OnceCallback<void(std::unique_ptr<UrlLoader> loader,
int32_t result)>;
enum class AccessibilityState {
kOff = 0,
kPending,
kLoaded,
};
struct BackgroundPart {
gfx::Rect location;
uint32_t color;
};
struct PreviewPageInfo {
std::string url;
int dest_page_index = -1;
};
~PdfViewWebPlugin() override;
bool InitializeCommon();
void SendSetSmoothScrolling();
void DidOpen(std::unique_ptr<UrlLoader> loader, int32_t result);
void UpdateScroll(const gfx::PointF& scroll_position);
void LoadUrl(base::StringPiece url, LoadUrlCallback callback);
void DidFormOpen(int32_t result);
void DidStartLoading();
void DidStopLoading();
int GetContentRestrictions() const;
void HandleDisplayAnnotationsMessage(const base::Value::Dict& message);
void HandleGetNamedDestinationMessage(const base::Value::Dict& message);
void HandleGetPageBoundingBoxMessage(const base::Value::Dict& message);
void HandleGetPasswordCompleteMessage(const base::Value::Dict& message);
void HandleGetSelectedTextMessage(const base::Value::Dict& message);
void HandleGetThumbnailMessage(const base::Value::Dict& message);
void HandlePrintMessage(const base::Value::Dict& );
void HandleRotateClockwiseMessage(const base::Value::Dict& );
void HandleRotateCounterclockwiseMessage(
const base::Value::Dict& );
void HandleSaveAttachmentMessage(const base::Value::Dict& message);
void HandleSaveMessage(const base::Value::Dict& message);
void HandleSelectAllMessage(const base::Value::Dict& );
void HandleSetBackgroundColorMessage(const base::Value::Dict& message);
void HandleSetPresentationModeMessage(const base::Value::Dict& message);
void HandleSetTwoUpViewMessage(const base::Value::Dict& message);
void HandleStopScrollingMessage(const base::Value::Dict& message);
void HandleViewportMessage(const base::Value::Dict& message);
void SaveToBuffer(const std::string& token);
void SaveToFile(const std::string& token);
gfx::PointF GetScrollPositionFromOffset(
const gfx::Vector2dF& scroll_offset) const;
void DoPaint(const std::vector<gfx::Rect>& paint_rects,
std::vector<PaintReadyRect>& ready,
std::vector<gfx::Rect>& pending);
void PrepareForFirstPaint(std::vector<PaintReadyRect>& ready);
void OnGeometryChanged(double old_zoom, float old_device_scale);
void RecalculateAreas(double old_zoom, float old_device_scale);
void CalculateBackgroundParts();
int GetDocumentPixelWidth() const;
int GetDocumentPixelHeight() const;
void InvalidateAfterPaintDone();
void ClearDeferredInvalidates();
void UpdateScaledValues();
void OnViewportChanged(const gfx::Rect& new_plugin_rect_in_css_pixel,
float new_device_scale);
bool SelectAll();
bool Cut();
bool Paste(const blink::WebString& value);
bool Undo();
bool Redo();
bool HandleWebInputEvent(const blink::WebInputEvent& event);
void HandleImeCommit(const blink::WebString& text);
void OnInvokePrintDialog();
void ResetRecentlySentFindUpdate();
void RecordDocumentMetrics();
void SendAttachments();
void SendBookmarks();
void SendMetadata();
void SendLoadingProgress(double percentage);
void HandleResetPrintPreviewModeMessage(const base::Value::Dict& message);
void HandleLoadPreviewPageMessage(const base::Value::Dict& message);
void LoadAvailablePreviewPage();
void DidOpenPreview(std::unique_ptr<UrlLoader> loader, int32_t result);
void LoadNextPreviewPage();
void SendPrintPreviewLoadedNotification();
void SendThumbnail(base::Value::Dict reply, Thumbnail thumbnail);
gfx::Point FrameToPdfCoordinates(const gfx::PointF& frame_coordinates) const;
AccessibilityDocInfo GetAccessibilityDocInfo() const;
void PrepareAndSetAccessibilityPageInfo(int32_t page_index);
void PrepareAndSetAccessibilityViewportInfo();
void LoadAccessibility();
bool initialized_ = false;
blink::WebString selected_text_;
std::unique_ptr<Client> const client_;
mojo::AssociatedRemote<pdf::mojom::PdfService> const pdf_service_;
mojo::Receiver<pdf::mojom::PdfListener> listener_receiver_{this};
std::unique_ptr<PDFiumEngine> engine_;
std::string url_;
base::OnceCallback<void(const std::string&)> password_callback_;
ui::mojom::CursorType cursor_type_ = ui::mojom::CursorType::kPointer;
blink::WebTextInputType text_input_type_ =
blink::WebTextInputType::kWebTextInputTypeNone;
gfx::Rect caret_rect_;
blink::WebString composition_text_;
bool has_focus_ = false;
blink::WebPluginParams initial_params_;
v8::Persistent<v8::Object> scriptable_receiver_;
PaintManager paint_manager_{this};
SkBitmap image_data_;
cc::PaintImage snapshot_;
gfx::Vector2dF snapshot_translate_;
float snapshot_scale_ = 1.0f;
float viewport_to_dip_scale_ = 1.0f;
gfx::Vector2dF total_translate_;
gfx::Rect css_plugin_rect_;
bool full_frame_ = false;
SkColor background_color_ = SK_ColorTRANSPARENT;
gfx::Size plugin_dip_size_;
gfx::Rect plugin_rect_;
gfx::Rect available_area_;
double zoom_ = 1.0;
float device_scale_ = 1.0f;
bool first_paint_ = true;
bool in_paint_ = false;
bool last_bitmap_smaller_ = false;
bool needs_reraster_ = true;
gfx::Size document_size_;
std::vector<BackgroundPart> background_parts_;
std::vector<gfx::Rect> deferred_invalidates_;
base::i18n::TextDirection ui_direction_ = base::i18n::UNKNOWN_DIRECTION;
gfx::Vector2dF scroll_offset_at_last_raster_;
bool stop_scrolling_ = false;
bool received_viewport_message_ = false;
bool did_call_start_loading_ = false;
double last_progress_sent_ = 0.0;
DocumentLoadState document_load_state_ = DocumentLoadState::kLoading;
AccessibilityState accessibility_state_ = AccessibilityState::kOff;
int32_t next_accessibility_page_index_ = 0;
std::unique_ptr<UrlLoader> form_loader_;
std::unique_ptr<PdfAccessibilityDataHandler> const
pdf_accessibility_data_handler_;
std::string link_under_cursor_;
int find_identifier_ = -1;
bool recently_sent_find_update_ = false;
std::vector<gfx::Rect> tickmarks_;
bool edit_mode_ = false;
std::unique_ptr<MetricsHandler> metrics_handler_;
base::flat_set<std::string> unsupported_features_reported_;
bool notified_browser_about_unsupported_feature_ = false;
raw_ptr<printing::MetafileSkia> printing_metafile_ = nullptr;
std::vector<int> pages_to_print_;
absl::optional<blink::WebPrintParams> print_params_;
bool print_pages_called_;
bool is_print_preview_ = false;
int print_preview_page_count_ = -1;
int print_preview_loaded_page_count_ = -1;
std::unique_ptr<PreviewModeClient> preview_client_;
std::unique_ptr<PDFiumEngine> preview_engine_;
DocumentLoadState preview_document_load_state_ = DocumentLoadState::kComplete;
base::queue<PreviewPageInfo> preview_pages_info_;
base::WeakPtrFactory<PdfViewWebPlugin> weak_factory_{this};
};
}
#endif