Changeset 104377 in webkit

Timestamp:

Jan 6, 2012 10:57:32 PM (12 years ago)

Author:

mrowe@apple.com

Message:

REGRESSION (WebKit2): Save as PDF no longer generates links to URLs
<​http://webkit.org/b/65076> / <rdar://problem/9606246>

WebKit2 printing works by having the web process render the page content to a PDF. The PDF
data is then shipped to the UI process which will render it in to the printing graphics context.
Links were being lost because the API used to do the rendering of the PDF in to the printing
graphics context, CGContextDrawPDFPage, did not preserve the links that were present in the
PDF content received from the web process.

To fix this we switch to using PDFKit for drawing the PDF in to the printing graphics context.
PDFKit provides the ability for us to iterate over the links in the PDF content ourselves and
add links in to the printing graphics context.

Reviewed by Alexey Proskuryakov.

• UIProcess/API/mac/WKPrintingView.h:
• UIProcess/API/mac/WKPrintingView.mm:

(pdfAnnotationLinkClass): Look up the PDFAnnotationLink class from PDFKit as WebKit2 loads PDFKit lazily.
(pdfDocumentClass): Ditto.
(-[WKPrintingView _drawPDFDocument:page:atPoint:]): Switch to using the PDFKit equivalents of several types.
Iterate over the annotations present in the PDFPage, calling CGPDFContextSetURLForRect for each PDFAnnotationLink
that we find.
(-[WKPrintingView _drawPreview:]): Create an NSData to feed to PDFDocument.
(-[WKPrintingView drawRect:]): Ditto.

• WebKit2Prefix.h: Add the usual workaround to make Objective-C exceptions compile when C++ exception handling is disabled.

Location:

trunk/Source/WebKit2

Files:

• ChangeLog (modified) (1 diff)
• UIProcess/API/mac/WKPrintingView.h (modified) (2 diffs)
• UIProcess/API/mac/WKPrintingView.mm (modified) (6 diffs)
• WebKit2Prefix.h (modified) (1 diff)

trunk/Source/WebKit2/ChangeLog

@@ +1 @@
+2012-01-06  Mark Rowe  <mrowe@apple.com>
+
+        REGRESSION (WebKit2): Save as PDF no longer generates links to URLs
+        <http://webkit.org/b/65076> / <rdar://problem/9606246>
+
+        WebKit2 printing works by having the web process render the page content to a PDF. The PDF
+        data is then shipped to the UI process which will render it in to the printing graphics context.
+        Links were being lost because the API used to do the rendering of the PDF in to the printing
+        graphics context, CGContextDrawPDFPage, did not preserve the links that were present in the
+        PDF content received from the web process.
+
+        To fix this we switch to using PDFKit for drawing the PDF in to the printing graphics context.
+        PDFKit provides the ability for us to iterate over the links in the PDF content ourselves and
+        add links in to the printing graphics context.
+
+        Reviewed by Alexey Proskuryakov.
+
+        * UIProcess/API/mac/WKPrintingView.h:
+        * UIProcess/API/mac/WKPrintingView.mm:
+        (pdfAnnotationLinkClass): Look up the PDFAnnotationLink class from PDFKit as WebKit2 loads PDFKit lazily.
+        (pdfDocumentClass): Ditto.
+        (-[WKPrintingView _drawPDFDocument:page:atPoint:]): Switch to using the PDFKit equivalents of several types.
+        Iterate over the annotations present in the PDFPage, calling CGPDFContextSetURLForRect for each PDFAnnotationLink
+        that we find.
+        (-[WKPrintingView _drawPreview:]): Create an NSData to feed to PDFDocument.
+        (-[WKPrintingView drawRect:]): Ditto.
+        * WebKit2Prefix.h: Add the usual workaround to make Objective-C exceptions compile when C++ exception handling is disabled.
+
 2012-01-06  Viatcheslav Ostapenko  <ostapenko.viatcheslav@nokia.com>
 

trunk/Source/WebKit2/UIProcess/API/mac/WKPrintingView.h

@@ -28 +28 @@
 
 @class WKPrintingViewData;
+@class PDFDocument;
 
 namespace WebKit {
@@ -44 +45 @@
 
     Vector<uint8_t> _printedPagesData;
-    RetainPtr<CGPDFDocumentRef> _printedPagesPDFDocument;
+    RetainPtr<PDFDocument> _printedPagesPDFDocument;
 
     uint64_t _expectedComputedPagesCallback;

trunk/Source/WebKit2/UIProcess/API/mac/WKPrintingView.mm

@@ -31 +31 @@
 #import "WebData.h"
 #import "WebPageProxy.h"
+#import <PDFKit/PDFKit.h>
 #import <WebCore/WebCoreObjCExtras.h>
 #import <wtf/MainThread.h>
@@ -411 +412 @@
 }
 
-- (void)_drawPDFDocument:(CGPDFDocumentRef)pdfDocument page:(unsigned)page atPoint:(NSPoint)point
+static Class pdfAnnotationLinkClass()
+{
+    static Class pdfAnnotationLinkClass = NSClassFromString(@"PDFAnnotationLink");
+    return pdfAnnotationLinkClass;
+}
+
+static Class pdfDocumentClass()
+{
+    static Class pdfDocumentClass = NSClassFromString(@"PDFDocument");
+    return pdfDocumentClass;
+}
+
+- (void)_drawPDFDocument:(PDFDocument *)pdfDocument page:(unsigned)page atPoint:(NSPoint)point
 {
     if (!pdfDocument) {
@@ -418 +431 @@
     }
 
-    CGPDFPageRef pdfPage = CGPDFDocumentGetPage(pdfDocument, page);
-    if (!pdfPage) {
-        LOG_ERROR("Preview data doesn't have page %d", page);
+    PDFPage *pdfPage;
+    @try {
+        pdfPage = [pdfDocument pageAtIndex:page];
+    } @catch (id exception) {
+        LOG_ERROR("Preview data doesn't have page %d: %@", page, exception);
         return;
     }
@@ -430 +445 @@
     CGContextTranslateCTM(context, point.x, point.y);
     CGContextScaleCTM(context, _totalScaleFactorForPrinting, -_totalScaleFactorForPrinting);
-    CGContextTranslateCTM(context, 0, -CGPDFPageGetBoxRect(pdfPage, kCGPDFMediaBox).size.height);
-    CGContextDrawPDFPage(context, pdfPage);
+    CGContextTranslateCTM(context, 0, -[pdfPage boundsForBox:kPDFDisplayBoxMediaBox].size.height);
+    [pdfPage drawWithBox:kPDFDisplayBoxMediaBox];
+
+    CGAffineTransform transform = CGContextGetCTM(context);
+
+    for (PDFAnnotation *annotation in [pdfPage annotations]) {
+        if (![annotation isKindOfClass:pdfAnnotationLinkClass()])
+            continue;
+
+        PDFAnnotationLink *linkAnnotation = (PDFAnnotationLink *)annotation;
+        NSURL *url = [linkAnnotation URL];
+        if (!url)
+            continue;
+
+        CGRect urlRect = NSRectToCGRect([linkAnnotation bounds]);
+        CGRect transformedRect = CGRectApplyAffineTransform(urlRect, transform);
+        CGPDFContextSetURLForRect(context, (CFURLRef)url, transformedRect);
+    }
+
     CGContextRestoreGState(context);
 }
@@ -474 +506 @@
     }
 
-    const Vector<uint8_t>& pdfData = pagePreviewIterator->second;
-    RetainPtr<CGDataProviderRef> pdfDataProvider(AdoptCF, CGDataProviderCreateWithData(0, pdfData.data(), pdfData.size(), 0));
-    RetainPtr<CGPDFDocumentRef> pdfDocument(AdoptCF, CGPDFDocumentCreateWithProvider(pdfDataProvider.get()));
-
-    [self _drawPDFDocument:pdfDocument.get() page:1 atPoint:NSMakePoint(nsRect.origin.x, nsRect.origin.y)];
+    const Vector<uint8_t>& pdfDataBytes = pagePreviewIterator->second;
+    RetainPtr<NSData> pdfData(AdoptNS, [[NSData alloc] initWithBytes:pdfDataBytes.data() length:pdfDataBytes.size()]);
+    RetainPtr<PDFDocument> pdfDocument(AdoptNS, [[pdfDocumentClass() alloc] initWithData:pdfData.get()]);
+
+    [self _drawPDFDocument:pdfDocument.get() page:0 atPoint:NSMakePoint(nsRect.origin.x, nsRect.origin.y)];
 }
 
@@ -499 +531 @@
 
     if (!_printedPagesPDFDocument) {
-        RetainPtr<CGDataProviderRef> pdfDataProvider(AdoptCF, CGDataProviderCreateWithData(0, _printedPagesData.data(), _printedPagesData.size(), 0));
-        _printedPagesPDFDocument.adoptCF(CGPDFDocumentCreateWithProvider(pdfDataProvider.get()));
-    }
-
-    unsigned printedPageNumber = [self _pageForRect:nsRect] - [self _firstPrintedPageNumber] + 1;
+        RetainPtr<NSData> pdfData(AdoptNS, [[NSData alloc] initWithBytes:_printedPagesData.data() length:_printedPagesData.size()]);
+        _printedPagesPDFDocument.adoptNS([[pdfDocumentClass() alloc] initWithData:pdfData.get()]);
+    }
+
+    unsigned printedPageNumber = [self _pageForRect:nsRect] - [self _firstPrintedPageNumber];
     [self _drawPDFDocument:_printedPagesPDFDocument.get() page:printedPageNumber atPoint:NSMakePoint(nsRect.origin.x, nsRect.origin.y)];
 }

trunk/Source/WebKit2/WebKit2Prefix.h

@@ -29 +29 @@
 #endif
 
+/* When C++ exceptions are disabled, the C++ library defines |try| and |catch|
+* to allow C++ code that expects exceptions to build. These definitions
+* interfere with Objective-C++ uses of Objective-C exception handlers, which
+* use |@try| and |@catch|. As a workaround, undefine these macros. */
+
+#ifdef __cplusplus
+#include <algorithm> // needed for exception_defines.h
+#endif
+
+#ifdef __OBJC__
+#undef try
+#undef catch
+#endif
+
 #ifdef __cplusplus
 #define new ("if you use new/delete make sure to include config.h at the top of the file"())