Changeset 159042 in webkit

Timestamp:

Nov 11, 2013 12:30:06 AM (10 years ago)

Author:

Carlos Garcia Campos

Message:

[GTK] Crash when printing via javascript in WebKit2
​https://bugs.webkit.org/show_bug.cgi?id=124043

Reviewed by Martin Robinson.

It happens because the print operation when started by the
WebProcess due to a DOM operation is supposed to be synchronous
and our print operation is always asynchronous. This is currently
handled only in the UI process because other ports print
synchronously in the WebProcess. In the GTK+ port we need to
notify the WebProcess that the print operation should run
synchronously when request by a DOM operation. Together with the
print settings and page setup we now send a print mode that can be
sync or async. When printing in sync mode we run a nested main loop
for the print operation, making sure that print sources have a
higher priority.

• Shared/PrintInfo.cpp:

(WebKit::PrintInfo::encode): Encode the print mode.
(WebKit::PrintInfo::decode): Decode the print mode.

• Shared/PrintInfo.h: Add PrintMode enum.
• Shared/gtk/PrintInfoGtk.cpp:

(WebKit::PrintInfo::PrintInfo): Initialize print mode.

• UIProcess/API/gtk/WebKitPrintOperation.cpp:

(drawPagesForPrintingCompleted): Do not call endPrinting() when
printing synchronously because WebPageProxy already calls it right
after sending the message to the WebProcess.
(webkitPrintOperationPrintPagesForFrame): Create the PrintInfo
struct with a print mode.
(webkitPrintOperationSetPrintMode): Helper private function to set
the print mode of the print operation.

• UIProcess/API/gtk/WebKitPrintOperationPrivate.h:
• UIProcess/API/gtk/WebKitWebView.cpp:

(webkitWebViewPrintFrame): Set sync print mode when printing due
to a UIClient request.

• WebProcess/WebPage/gtk/WebPrintOperationGtk.cpp:

(WebKit::PrintPagesData::PrintPagesData): Create a main loop when
printing synchronously.
(WebKit::WebPrintOperationGtk::WebPrintOperationGtk): Initialize
print mode.
(WebKit::WebPrintOperationGtk::printPagesIdleDone): Finish the
nested main loop when printing synchronously.
(WebKit::WebPrintOperationGtk::print): Run a nested main loop when
printing synchronously.

• WebProcess/WebPage/gtk/WebPrintOperationGtk.h:

(WebKit::WebPrintOperationGtk::printMode): Return the print mode.

Location:

trunk/Source/WebKit2

Files:

• ChangeLog (modified) (1 diff)
• Shared/PrintInfo.cpp (modified) (2 diffs)
• Shared/PrintInfo.h (modified) (2 diffs)
• Shared/gtk/PrintInfoGtk.cpp (modified) (2 diffs)
• UIProcess/API/gtk/WebKitPrintOperation.cpp (modified) (5 diffs)
• UIProcess/API/gtk/WebKitPrintOperationPrivate.h (modified) (1 diff)
• UIProcess/API/gtk/WebKitWebView.cpp (modified) (1 diff)
• WebProcess/WebPage/gtk/WebPrintOperationGtk.cpp (modified) (6 diffs)
• WebProcess/WebPage/gtk/WebPrintOperationGtk.h (modified) (2 diffs)

trunk/Source/WebKit2/ChangeLog

@@ +1 @@
+2013-11-11  Carlos Garcia Campos  <cgarcia@igalia.com>
+
+        [GTK] Crash when printing via javascript in WebKit2
+        https://bugs.webkit.org/show_bug.cgi?id=124043
+
+        Reviewed by Martin Robinson.
+
+        It happens because the print operation when started by the
+        WebProcess due to a DOM operation is supposed to be synchronous
+        and our print operation is always asynchronous. This is currently
+        handled only in the UI process because other ports print
+        synchronously in the WebProcess. In the GTK+ port we need to
+        notify the WebProcess that the print operation should run
+        synchronously when request by a DOM operation. Together with the
+        print settings and page setup we now send a print mode that can be
+        sync or async. When printing in sync mode we run a nested main loop
+        for the print operation, making sure that print sources have a
+        higher priority.
+
+        * Shared/PrintInfo.cpp:
+        (WebKit::PrintInfo::encode): Encode the print mode.
+        (WebKit::PrintInfo::decode): Decode the print mode.
+        * Shared/PrintInfo.h: Add PrintMode enum.
+        * Shared/gtk/PrintInfoGtk.cpp:
+        (WebKit::PrintInfo::PrintInfo): Initialize print mode.
+        * UIProcess/API/gtk/WebKitPrintOperation.cpp:
+        (drawPagesForPrintingCompleted): Do not call endPrinting() when
+        printing synchronously because WebPageProxy already calls it right
+        after sending the message to the WebProcess.
+        (webkitPrintOperationPrintPagesForFrame): Create the PrintInfo
+        struct with a print mode.
+        (webkitPrintOperationSetPrintMode): Helper private function to set
+        the print mode of the print operation.
+        * UIProcess/API/gtk/WebKitPrintOperationPrivate.h:
+        * UIProcess/API/gtk/WebKitWebView.cpp:
+        (webkitWebViewPrintFrame): Set sync print mode when printing due
+        to a UIClient request.
+        * WebProcess/WebPage/gtk/WebPrintOperationGtk.cpp:
+        (WebKit::PrintPagesData::PrintPagesData): Create a main loop when
+        printing synchronously.
+        (WebKit::WebPrintOperationGtk::WebPrintOperationGtk): Initialize
+        print mode.
+        (WebKit::WebPrintOperationGtk::printPagesIdleDone): Finish the
+        nested main loop when printing synchronously.
+        (WebKit::WebPrintOperationGtk::print): Run a nested main loop when
+        printing synchronously.
+        * WebProcess/WebPage/gtk/WebPrintOperationGtk.h:
+        (WebKit::WebPrintOperationGtk::printMode): Return the print mode.
+
 2013-11-10  Carlos Garcia Campos  <cgarcia@igalia.com>
 

trunk/Source/WebKit2/Shared/PrintInfo.cpp

@@ -53 +53 @@
     CoreIPC::encode(encoder, printSettings.get());
     CoreIPC::encode(encoder, pageSetup.get());
+    encoder.encodeEnum(printMode);
 #endif
 }
@@ -70 +71 @@
     if (!CoreIPC::decode(decoder, info.pageSetup))
         return false;
+    if (!decoder.decodeEnum(info.printMode))
+        return false;
 #endif
 

trunk/Source/WebKit2/Shared/PrintInfo.h

@@ -48 +48 @@
     PrintInfo();
 #if PLATFORM(GTK)
-    explicit PrintInfo(GtkPrintSettings*, GtkPageSetup*);
+    enum PrintMode {
+        PrintModeAsync,
+        PrintModeSync
+    };
+
+    explicit PrintInfo(GtkPrintSettings*, GtkPageSetup*, PrintMode = PrintModeAsync);
 #else
     explicit PrintInfo(NSPrintInfo *);
@@ -60 +65 @@
     GRefPtr<GtkPrintSettings> printSettings;
     GRefPtr<GtkPageSetup> pageSetup;
+    PrintMode printMode;
 #endif
 

trunk/Source/WebKit2/Shared/gtk/PrintInfoGtk.cpp

@@ -31 +31 @@
 namespace WebKit {
 
-PrintInfo::PrintInfo(GtkPrintSettings* settings, GtkPageSetup* pageSetup)
+PrintInfo::PrintInfo(GtkPrintSettings* settings, GtkPageSetup* pageSetup, PrintMode printMode)
     : pageSetupScaleFactor(gtk_print_settings_get_scale(settings) / 100.0)
     , availablePaperWidth(gtk_page_setup_get_paper_width(pageSetup, GTK_UNIT_POINTS) - gtk_page_setup_get_left_margin(pageSetup, GTK_UNIT_POINTS) - gtk_page_setup_get_right_margin(pageSetup, GTK_UNIT_POINTS))
@@ -37 +37 @@
     , printSettings(settings)
     , pageSetup(pageSetup)
+    , printMode(printMode)
 {
     ASSERT(settings);

trunk/Source/WebKit2/UIProcess/API/gtk/WebKitPrintOperation.cpp

@@ -21 +21 @@
 #include "WebKitPrintOperation.h"
 
-#include "PrintInfo.h"
 #include "WebKitPrintOperationPrivate.h"
 #include "WebKitPrivate.h"
@@ -74 +73 @@
     WebKitWebView* webView;
     gulong webViewDestroyedId;
+    PrintInfo::PrintMode printMode;
 
     GRefPtr<GtkPrintSettings> printSettings;
@@ -265 +265 @@
     GRefPtr<WebKitPrintOperation> printOperation = adoptGRef(WEBKIT_PRINT_OPERATION(context));
     WebPageProxy* page = webkitWebViewBaseGetPage(WEBKIT_WEB_VIEW_BASE(printOperation->priv->webView));
-    page->endPrinting();
+
+    // When running synchronously WebPageProxy::printFrame() calls endPrinting().
+    if (printOperation->priv->printMode == PrintInfo::PrintModeAsync)
+        page->endPrinting();
 
     const WebCore::ResourceError& resourceError = toImpl(wkPrintError)->platformError();
@@ -279 +282 @@
 static void webkitPrintOperationPrintPagesForFrame(WebKitPrintOperation* printOperation, WebFrameProxy* webFrame, GtkPrintSettings* printSettings, GtkPageSetup* pageSetup)
 {
-    PrintInfo printInfo(printSettings, pageSetup);
+    PrintInfo printInfo(printSettings, pageSetup, printOperation->priv->printMode);
     WebPageProxy* page = webkitWebViewBaseGetPage(WEBKIT_WEB_VIEW_BASE(printOperation->priv->webView));
     page->drawPagesForPrinting(webFrame, printInfo, PrintFinishedCallback::create(g_object_ref(printOperation), &drawPagesForPrintingCompleted));
@@ -299 +302 @@
     webkitPrintOperationPrintPagesForFrame(printOperation, webFrame, priv->printSettings.get(), priv->pageSetup.get());
     return response;
+}
+
+void webkitPrintOperationSetPrintMode(WebKitPrintOperation* printOperation, PrintInfo::PrintMode printMode)
+{
+    printOperation->priv->printMode = printMode;
 }
 

trunk/Source/WebKit2/UIProcess/API/gtk/WebKitPrintOperationPrivate.h

@@ -21 +21 @@
 #define WebKitPrintOperationPrivate_h
 
+#include "PrintInfo.h"
 #include "WebFrameProxy.h"
 #include "WebKitPrintOperation.h"
 
 WebKitPrintOperationResponse webkitPrintOperationRunDialogForFrame(WebKitPrintOperation*, GtkWindow* parent, WebKit::WebFrameProxy*);
+void webkitPrintOperationSetPrintMode(WebKitPrintOperation*, WebKit::PrintInfo::PrintMode);
 
 #endif // WebKitPrintOperationPrivate_h

trunk/Source/WebKit2/UIProcess/API/gtk/WebKitWebView.cpp

@@ -1684 +1684 @@
         return;
 
+    webkitPrintOperationSetPrintMode(printOperation.get(), PrintInfo::PrintModeSync);
     WebKitPrintOperationResponse response = webkitPrintOperationRunDialogForFrame(printOperation.get(), 0, frame);
     if (response == WEBKIT_PRINT_OPERATION_RESPONSE_CANCEL)

trunk/Source/WebKit2/WebProcess/WebPage/gtk/WebPrintOperationGtk.cpp

@@ -110 +110 @@
         m_callbackID = callbackID;
         gtk_enumerate_printers(reinterpret_cast<GtkPrinterFunc>(enumeratePrintersFunction), this,
-                               reinterpret_cast<GDestroyNotify>(enumeratePrintersFinished), FALSE);
+            reinterpret_cast<GDestroyNotify>(enumeratePrintersFinished), m_printMode == PrintInfo::PrintModeSync);
     }
 
@@ -218 +218 @@
         , isValid(true)
     {
+        if (printOperation->printMode() == PrintInfo::PrintModeSync)
+            mainLoop = adoptGRef(g_main_loop_new(0, FALSE));
+
         if (printOperation->collateCopies()) {
             collatedCopies = printOperation->copies();
@@ -359 +362 @@
 
     RefPtr<WebPrintOperationGtk> printOperation;
+    GRefPtr<GMainLoop> mainLoop;
 
     int totalPrinted;
@@ -393 +397 @@
     , m_printSettings(printInfo.printSettings.get())
     , m_pageSetup(printInfo.pageSetup.get())
+    , m_printMode(printInfo.printMode)
     , m_printContext(0)
     , m_callbackID(0)
@@ -670 +675 @@
 {
     PrintPagesData* data = static_cast<PrintPagesData*>(userData);
+    if (data->mainLoop)
+        g_main_loop_quit(data->mainLoop.get());
 
     data->printOperation->printPagesDone();
@@ -706 +713 @@
     m_yDPI = yDPI;
     m_cairoContext = adoptRef(cairo_create(surface));
-    m_printPagesIdleId = gdk_threads_add_idle_full(G_PRIORITY_DEFAULT_IDLE + 10, printPagesIdle,
-                                                   data.leakPtr(), printPagesIdleDone);
-}
-
-}
+
+    // Make sure the print pages idle has more priority than IPC messages comming from
+    // the IO thread, so that the EndPrinting message is always handled once the print
+    // operation has finished. See https://bugs.webkit.org/show_bug.cgi?id=122801.
+    unsigned idlePriority = m_printMode == PrintInfo::PrintModeSync ? G_PRIORITY_DEFAULT - 10 : G_PRIORITY_DEFAULT_IDLE + 10;
+    GMainLoop* mainLoop = data->mainLoop.get();
+    m_printPagesIdleId = gdk_threads_add_idle_full(idlePriority, printPagesIdle, data.leakPtr(), printPagesIdleDone);
+    if (m_printMode == PrintInfo::PrintModeSync) {
+        ASSERT(mainLoop);
+        g_main_loop_run(mainLoop);
+    }
+}
+
+}

trunk/Source/WebKit2/WebProcess/WebPage/gtk/WebPrintOperationGtk.h

@@ -54 +54 @@
     GtkPrintSettings* printSettings() const { return m_printSettings.get(); }
     GtkPageSetup* pageSetup() const { return m_pageSetup.get(); }
+    PrintInfo::PrintMode printMode() const { return m_printMode; }
     void setNumberOfPagesToPrint(size_t numberOfPages) { m_numberOfPagesToPrint = numberOfPages; }
     unsigned int pagesToPrint() const { return m_pagesToPrint; }
@@ -96 +97 @@
     GRefPtr<GtkPrintSettings> m_printSettings;
     GRefPtr<GtkPageSetup> m_pageSetup;
+    PrintInfo::PrintMode m_printMode;
     WebCore::PrintContext* m_printContext;
     uint64_t m_callbackID;