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