pdf/out_of_process_instance.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef PDF_OUT_OF_PROCESS_INSTANCE_H_
   6 #define PDF_OUT_OF_PROCESS_INSTANCE_H_
   7
   8 #include <queue>
   9 #include <set>
  10 #include <string>
  11 #include <utility>
  12 #include <vector>
  13
  14 #include "base/memory/scoped_ptr.h"
  15 #include "pdf/paint_manager.h"
  16 #include "pdf/pdf_engine.h"
  17 #include "pdf/preview_mode_client.h"
  18
  19 #include "ppapi/c/private/ppb_pdf.h"
  20 #include "ppapi/c/private/ppp_pdf.h"
  21 #include "ppapi/cpp/dev/printing_dev.h"
  22 #include "ppapi/cpp/dev/scriptable_object_deprecated.h"
  23 #include "ppapi/cpp/graphics_2d.h"
  24 #include "ppapi/cpp/image_data.h"
  25 #include "ppapi/cpp/input_event.h"
  26 #include "ppapi/cpp/instance.h"
  27 #include "ppapi/cpp/private/find_private.h"
  28 #include "ppapi/cpp/private/uma_private.h"
  29 #include "ppapi/cpp/url_loader.h"
  30 #include "ppapi/utility/completion_callback_factory.h"
  31
  32 namespace pp {
  33 class TextInput_Dev;
  34 }
  35
  36 namespace chrome_pdf {
  37
  38 class OutOfProcessInstance : public pp::Instance,
  39                              public pp::Find_Private,
  40                              public pp::Printing_Dev,
  41                              public PaintManager::Client,
  42                              public PDFEngine::Client,
  43                              public PreviewModeClient::Client {
  44  public:
  45   explicit OutOfProcessInstance(PP_Instance instance);
  46   ~OutOfProcessInstance() override;
  47
  48   // pp::Instance implementation.
  49   bool Init(uint32_t argc, const char* argn[], const char* argv[]) override;
  50   void HandleMessage(const pp::Var& message) override;
  51   bool HandleInputEvent(const pp::InputEvent& event) override;
  52   void DidChangeView(const pp::View& view) override;
  53
  54   // pp::Find_Private implementation.
  55   bool StartFind(const std::string& text, bool case_sensitive) override;
  56   void SelectFindResult(bool forward) override;
  57   void StopFind() override;
  58
  59   // pp::PaintManager::Client implementation.
  60   void OnPaint(const std::vector<pp::Rect>& paint_rects,
  61                std::vector<PaintManager::ReadyRect>* ready,
  62                std::vector<pp::Rect>* pending) override;
  63
  64   // pp::Printing_Dev implementation.
  65   uint32_t QuerySupportedPrintOutputFormats() override;
  66   int32_t PrintBegin(const PP_PrintSettings_Dev& print_settings) override;
  67   pp::Resource PrintPages(
  68       const PP_PrintPageNumberRange_Dev* page_ranges,
  69       uint32_t page_range_count) override;
  70   void PrintEnd() override;
  71   bool IsPrintScalingDisabled() override;
  72
  73   // pp::Private implementation.
  74   virtual pp::Var GetLinkAtPosition(const pp::Point& point);
  75   virtual void GetPrintPresetOptionsFromDocument(
  76       PP_PdfPrintPresetOptions_Dev* options);
  77
  78   void FlushCallback(int32_t result);
  79   void DidOpen(int32_t result);
  80   void DidOpenPreview(int32_t result);
  81
  82   // Called when the timer is fired.
  83   void OnClientTimerFired(int32_t id);
  84
  85   // Called to print without re-entrancy issues.
  86   void OnPrint(int32_t);
  87
  88   // PDFEngine::Client implementation.
  89   void DocumentSizeUpdated(const pp::Size& size) override;
  90   void Invalidate(const pp::Rect& rect) override;
  91   void Scroll(const pp::Point& point) override;
  92   void ScrollToX(int position) override;
  93   void ScrollToY(int position) override;
  94   void ScrollToPage(int page) override;
  95   void NavigateTo(const std::string& url, bool open_in_new_tab) override;
  96   void UpdateCursor(PP_CursorType_Dev cursor) override;
  97   void UpdateTickMarks(const std::vector<pp::Rect>& tickmarks) override;
  98   void NotifyNumberOfFindResultsChanged(int total, bool final_result) override;
  99   void NotifySelectedFindResultChanged(int current_find_index) override;
 100   void GetDocumentPassword(
 101       pp::CompletionCallbackWithOutput<pp::Var> callback) override;
 102   void Alert(const std::string& message) override;
 103   bool Confirm(const std::string& message) override;
 104   std::string Prompt(const std::string& question,
 105                      const std::string& default_answer) override;
 106   std::string GetURL() override;
 107   void Email(const std::string& to,
 108              const std::string& cc,
 109              const std::string& bcc,
 110              const std::string& subject,
 111              const std::string& body) override;
 112   void Print() override;
 113   void SubmitForm(const std::string& url,
 114                   const void* data,
 115                   int length) override;
 116   std::string ShowFileSelectionDialog() override;
 117   pp::URLLoader CreateURLLoader() override;
 118   void ScheduleCallback(int id, int delay_in_ms) override;
 119   void SearchString(const base::char16* string,
 120                     const base::char16* term,
 121                     bool case_sensitive,
 122                     std::vector<SearchStringResult>* results) override;
 123   void DocumentPaintOccurred() override;
 124   void DocumentLoadComplete(int page_count) override;
 125   void DocumentLoadFailed() override;
 126   pp::Instance* GetPluginInstance() override;
 127   void DocumentHasUnsupportedFeature(const std::string& feature) override;
 128   void DocumentLoadProgress(uint32 available, uint32 doc_size) override;
 129   void FormTextFieldFocusChange(bool in_focus) override;
 130   bool IsPrintPreview() override;
 131   uint32 GetBackgroundColor() override;
 132   void IsSelectingChanged(bool is_selecting) override;
 133
 134   // PreviewModeClient::Client implementation.
 135   void PreviewDocumentLoadComplete() override;
 136   void PreviewDocumentLoadFailed() override;
 137
 138   // Helper functions for implementing PPP_PDF.
 139   void RotateClockwise();
 140   void RotateCounterclockwise();
 141
 142  private:
 143   void ResetRecentlySentFindUpdate(int32_t);
 144
 145   // Called whenever the plugin geometry changes to update the location of the
 146   // background parts, and notifies the pdf engine.
 147   void OnGeometryChanged(double old_zoom, float old_device_scale);
 148
 149   // Figures out the location of any background rectangles (i.e. those that
 150   // aren't painted by the PDF engine).
 151   void CalculateBackgroundParts();
 152
 153   // Computes document width/height in device pixels, based on current zoom and
 154   // device scale
 155   int GetDocumentPixelWidth() const;
 156   int GetDocumentPixelHeight() const;
 157
 158   // Draws a rectangle with the specified dimensions and color in our buffer.
 159   void FillRect(const pp::Rect& rect, uint32 color);
 160
 161   void LoadUrl(const std::string& url);
 162   void LoadPreviewUrl(const std::string& url);
 163   void LoadUrlInternal(const std::string& url, pp::URLLoader* loader,
 164                        void (OutOfProcessInstance::* method)(int32_t));
 165
 166   // Creates a URL loader and allows it to access all urls, i.e. not just the
 167   // frame's origin.
 168   pp::URLLoader CreateURLLoaderInternal();
 169
 170   void FormDidOpen(int32_t result);
 171
 172   std::string GetLocalizedString(PP_ResourceString id);
 173
 174   void UserMetricsRecordAction(const std::string& action);
 175
 176   enum DocumentLoadState {
 177     LOAD_STATE_LOADING,
 178     LOAD_STATE_COMPLETE,
 179     LOAD_STATE_FAILED,
 180   };
 181
 182   // Set new zoom scale.
 183   void SetZoom(double scale);
 184
 185   // Reduces the document to 1 page and appends |print_preview_page_count_|
 186   // blank pages to the document for print preview.
 187   void AppendBlankPrintPreviewPages();
 188
 189   // Process the preview page data information. |src_url| specifies the preview
 190   // page data location. The |src_url| is in the format:
 191   // chrome://print/id/page_number/print.pdf
 192   // |dst_page_index| specifies the blank page index that needs to be replaced
 193   // with the new page data.
 194   void ProcessPreviewPageInfo(const std::string& src_url, int dst_page_index);
 195   // Load the next available preview page into the blank page.
 196   void LoadAvailablePreviewPage();
 197
 198   // Bound the given scroll offset to the document.
 199   pp::FloatPoint BoundScrollOffsetToDocument(
 200       const pp::FloatPoint& scroll_offset);
 201
 202   pp::ImageData image_data_;
 203   // Used when the plugin is embedded in a page and we have to create the loader
 204   // ourself.
 205   pp::CompletionCallbackFactory<OutOfProcessInstance> loader_factory_;
 206   pp::URLLoader embed_loader_;
 207   pp::URLLoader embed_preview_loader_;
 208
 209   PP_CursorType_Dev cursor_;  // The current cursor.
 210
 211   pp::CompletionCallbackFactory<OutOfProcessInstance> timer_factory_;
 212
 213   // Size, in pixels, of plugin rectangle.
 214   pp::Size plugin_size_;
 215   // Size, in DIPs, of plugin rectangle.
 216   pp::Size plugin_dip_size_;
 217   // Remaining area, in pixels, to render the pdf in after accounting for
 218   // horizontal centering.
 219   pp::Rect available_area_;
 220   // Size of entire document in pixels (i.e. if each page is 800 pixels high and
 221   // there are 10 pages, the height will be 8000).
 222   pp::Size document_size_;
 223
 224   double zoom_;  // Current zoom factor.
 225
 226   float device_scale_;  // Current device scale factor.
 227   // True if the plugin is full-page.
 228   bool full_;
 229
 230   PaintManager paint_manager_;
 231
 232   struct BackgroundPart {
 233     pp::Rect location;
 234     uint32 color;
 235   };
 236   std::vector<BackgroundPart> background_parts_;
 237
 238   struct PrintSettings {
 239     PrintSettings() {
 240       Clear();
 241     }
 242     void Clear() {
 243       is_printing = false;
 244       print_pages_called_ = false;
 245       memset(&pepper_print_settings, 0, sizeof(pepper_print_settings));
 246     }
 247     // This is set to true when PrintBegin is called and false when PrintEnd is
 248     // called.
 249     bool is_printing;
 250     // To know whether this was an actual print operation, so we don't double
 251     // count UMA logging.
 252     bool print_pages_called_;
 253     PP_PrintSettings_Dev pepper_print_settings;
 254   };
 255
 256   PrintSettings print_settings_;
 257
 258   scoped_ptr<PDFEngine> engine_;
 259
 260   // The PreviewModeClient used for print preview. Will be passed to
 261   // |preview_engine_|.
 262   scoped_ptr<PreviewModeClient> preview_client_;
 263
 264   // This engine is used to render the individual preview page data. This is
 265   // used only in print preview mode. This will use |PreviewModeClient|
 266   // interface which has very limited access to the pp::Instance.
 267   scoped_ptr<PDFEngine> preview_engine_;
 268
 269   std::string url_;
 270
 271   // Used for submitting forms.
 272   pp::CompletionCallbackFactory<OutOfProcessInstance> form_factory_;
 273   pp::URLLoader form_loader_;
 274
 275   // Used for printing without re-entrancy issues.
 276   pp::CompletionCallbackFactory<OutOfProcessInstance> print_callback_factory_;
 277
 278   // The callback for receiving the password from the page.
 279   scoped_ptr<pp::CompletionCallbackWithOutput<pp::Var> > password_callback_;
 280
 281   // True if we haven't painted the plugin viewport yet.
 282   bool first_paint_;
 283
 284   DocumentLoadState document_load_state_;
 285   DocumentLoadState preview_document_load_state_;
 286
 287   // A UMA resource for histogram reporting.
 288   pp::UMAPrivate uma_;
 289
 290   // Used so that we only tell the browser once about an unsupported feature, to
 291   // avoid the infobar going up more than once.
 292   bool told_browser_about_unsupported_feature_;
 293
 294   // Keeps track of which unsupported features we reported, so we avoid spamming
 295   // the stats if a feature shows up many times per document.
 296   std::set<std::string> unsupported_features_reported_;
 297
 298   // Number of pages in print preview mode, 0 if not in print preview mode.
 299   int print_preview_page_count_;
 300   std::vector<int> print_preview_page_numbers_;
 301
 302   // Used to manage loaded print preview page information. A |PreviewPageInfo|
 303   // consists of data source url string and the page index in the destination
 304   // document.
 305   typedef std::pair<std::string, int> PreviewPageInfo;
 306   std::queue<PreviewPageInfo> preview_pages_info_;
 307
 308   // Used to signal the browser about focus changes to trigger the OSK.
 309   // TODO(abodenha@chromium.org) Implement full IME support in the plugin.
 310   // http://crbug.com/132565
 311   scoped_ptr<pp::TextInput_Dev> text_input_;
 312
 313   // The last document load progress value sent to the web page.
 314   double last_progress_sent_;
 315
 316   // Whether an update to the number of find results found was sent less than
 317   // |kFindResultCooldownMs| milliseconds ago.
 318   bool recently_sent_find_update_;
 319
 320   // The tickmarks.
 321   std::vector<pp::Rect> tickmarks_;
 322
 323   // Whether the plugin has received a viewport changed message. Nothing should
 324   // be painted until this is received.
 325   bool received_viewport_message_;
 326
 327   // If true, this means we told the RenderView that we're starting a network
 328   // request so that it can start the throbber. We will tell it again once the
 329   // document finishes loading.
 330   bool did_call_start_loading_;
 331
 332   // If this is true, then don't scroll the plugin in response to DidChangeView
 333   // messages. This will be true when the extension page is in the process of
 334   // zooming the plugin so that flickering doesn't occur while zooming.
 335   bool stop_scrolling_;
 336
 337   // The background color of the PDF viewer.
 338   uint32 background_color_;
 339
 340   // The blank space above the first page of the document reserved for the
 341   // toolbar.
 342   int top_toolbar_height_;
 343
 344   DISALLOW_COPY_AND_ASSIGN(OutOfProcessInstance);
 345 };
 346
 347 }  // namespace chrome_pdf
 348
 349 #endif  // PDF_OUT_OF_PROCESS_INSTANCE_H_