PDFPlugin: Support unlocking encrypted PDFs
[WebKit-https.git] / Source / WebKit2 / WebProcess / Plugins / PDF / PDFPlugin.h
1 /*
2  * Copyright (C) 2011, 2012 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef PDFPlugin_h
27 #define PDFPlugin_h
28
29 #if ENABLE(PDFKIT_PLUGIN)
30
31 #include "Plugin.h"
32 #include "SimplePDFPlugin.h"
33 #include "WebEvent.h"
34 #include <WebCore/AffineTransform.h>
35 #include <WebCore/FindOptions.h>
36 #include <WebCore/ScrollableArea.h>
37 #include <wtf/RetainPtr.h>
38
39 typedef const struct OpaqueJSContext* JSContextRef;
40 typedef struct OpaqueJSValue* JSObjectRef;
41 typedef const struct OpaqueJSValue* JSValueRef;
42
43 OBJC_CLASS NSArray;
44 OBJC_CLASS PDFAnnotation;
45 OBJC_CLASS PDFLayerController;
46 OBJC_CLASS PDFSelection;
47 OBJC_CLASS WKPDFLayerControllerDelegate;
48
49 namespace CoreIPC {
50 class DataReference;
51 }
52
53 namespace WebCore {
54 class Element;
55 struct PluginInfo;
56 }
57
58 namespace WebKit {
59
60 class PDFPluginAnnotation;
61 class PDFPluginPasswordField;
62 class PluginView;
63 class WebFrame;
64
65 class PDFPlugin : public SimplePDFPlugin {
66 public:
67     static PassRefPtr<PDFPlugin> create(WebFrame*);
68     ~PDFPlugin();
69
70     void paintControlForLayerInContext(CALayer *, CGContextRef);
71     void setActiveAnnotation(PDFAnnotation *);
72     
73     using ScrollableArea::notifyScrollPositionChanged;
74     void notifyContentScaleFactorChanged(CGFloat scaleFactor);
75     void notifyDisplayModeChanged(int);
76
77     void notifySelectionChanged(PDFSelection *);
78
79     void clickedLink(NSURL *);
80     void saveToPDF();
81     void openWithNativeApplication();
82     void writeItemsToPasteboard(NSArray *items, NSArray *types);
83     void showDefinitionForAttributedString(NSAttributedString *, CGPoint);
84     void performWebSearch(NSString *);
85     void performSpotlightSearch(NSString *);
86
87     void focusNextAnnotation();
88     void focusPreviousAnnotation();
89
90     void attemptToUnlockPDF(const String& password);
91
92 private:
93     explicit PDFPlugin(WebFrame*);
94
95     virtual void updateScrollbars() OVERRIDE;
96     virtual PassRefPtr<WebCore::Scrollbar> createScrollbar(WebCore::ScrollbarOrientation) OVERRIDE;
97     virtual void destroyScrollbar(WebCore::ScrollbarOrientation) OVERRIDE;
98     virtual void pdfDocumentDidLoad() OVERRIDE;
99     virtual void calculateSizes() OVERRIDE;
100
101     virtual void destroy() OVERRIDE;
102     virtual void paint(WebCore::GraphicsContext*, const WebCore::IntRect& dirtyRectInWindowCoordinates) OVERRIDE;
103     virtual PassRefPtr<ShareableBitmap> snapshot() OVERRIDE;
104     virtual PlatformLayer* pluginLayer() OVERRIDE;
105     virtual void geometryDidChange(const WebCore::IntSize& pluginSize, const WebCore::IntRect& clipRect, const WebCore::AffineTransform& pluginToRootViewTransform) OVERRIDE;
106     virtual void contentsScaleFactorChanged(float) OVERRIDE;
107     virtual bool handleMouseEvent(const WebMouseEvent&) OVERRIDE;
108     virtual bool handleContextMenuEvent(const WebMouseEvent&) OVERRIDE;
109     virtual bool handleKeyboardEvent(const WebKeyboardEvent&) OVERRIDE;
110     virtual bool handleEditingCommand(const String& commandName, const String& argument) OVERRIDE;
111     virtual bool isEditingCommandEnabled(const String&) OVERRIDE;
112     virtual bool handlesPageScaleFactor() OVERRIDE;
113
114     virtual unsigned countFindMatches(const String& target, WebCore::FindOptions, unsigned maxMatchCount) OVERRIDE;
115     virtual bool findString(const String& target, WebCore::FindOptions, unsigned maxMatchCount) OVERRIDE;
116
117     PDFSelection *nextMatchForString(const String& target, BOOL searchForward, BOOL caseSensitive, BOOL wrapSearch, PDFSelection *initialSelection, BOOL startInSelection);
118
119     virtual bool performDictionaryLookupAtLocation(const WebCore::FloatPoint&) OVERRIDE;
120     virtual String getSelectionString() const OVERRIDE;
121
122     virtual bool handleWheelEvent(const WebWheelEvent& event) OVERRIDE;
123
124     // ScrollableArea functions.
125     virtual void setScrollOffset(const WebCore::IntPoint&) OVERRIDE;
126     virtual void invalidateScrollbarRect(WebCore::Scrollbar*, const WebCore::IntRect&) OVERRIDE;
127     virtual void invalidateScrollCornerRect(const WebCore::IntRect&) OVERRIDE;
128     virtual WebCore::IntPoint lastKnownMousePosition() const OVERRIDE { return m_lastMousePositionInPluginCoordinates; }
129     
130     NSEvent *nsEventForWebMouseEvent(const WebMouseEvent&);
131     WebCore::IntPoint convertFromPluginToPDFView(const WebCore::IntPoint&) const;
132     WebCore::IntPoint convertFromRootViewToPlugin(const WebCore::IntPoint&) const;
133     
134     bool supportsForms();
135     bool isFullFramePlugin();
136
137     void updatePageAndDeviceScaleFactors();
138
139     void createPasswordEntryForm();
140
141     WebCore::IntPoint convertFromPDFViewToRootView(const WebCore::IntPoint&) const;
142
143     RetainPtr<CALayer> m_containerLayer;
144     RetainPtr<CALayer> m_contentLayer;
145     RetainPtr<CALayer> m_horizontalScrollbarLayer;
146     RetainPtr<CALayer> m_verticalScrollbarLayer;
147     RetainPtr<CALayer> m_scrollCornerLayer;
148     RetainPtr<PDFLayerController> m_pdfLayerController;
149     
150     RefPtr<PDFPluginAnnotation> m_activeAnnotation;
151     RefPtr<PDFPluginPasswordField> m_passwordField;
152     RefPtr<WebCore::Element> m_annotationContainer;
153
154     WebCore::AffineTransform m_rootViewToPluginTransform;
155     WebMouseEvent m_lastMouseEvent;
156     WebCore::IntPoint m_lastMousePositionInPluginCoordinates;
157
158     String m_temporaryPDFUUID;
159
160     String m_lastFoundString;
161     
162     RetainPtr<WKPDFLayerControllerDelegate> m_pdfLayerControllerDelegate;
163 };
164
165 } // namespace WebKit
166
167 #endif // ENABLE(PDFKIT_PLUGIN)
168
169 #endif // PDFPlugin_h