Emit a new signal when printing to a PDF file finishes

[ChangeLog][Important Changes] Printing to a PDF file will now emit
signal the signal pdfPrintingFinished in both QQuickWebEngineView
and QWebEnginePage.

The boolean passed with the signal to indicate if the printing and
saving of the PDF was successful. The path of the created file is
also passed to enable the user to map the signal to a print request.

Task-number: QTBUG-56677
Change-Id: Ifab5a20b048f33a8cd872165bd4d453b01708037
Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>

1 files changed, 42 insertions, 19 deletions

diff --git a/src/core/print_view_manager_qt.cpp b/src/core/print_view_manager_qt.cpp
index 0231df8bd..6006c3bad 100644
--- a/src/core/print_view_manager_qt.cpp
+++ b/src/core/print_view_manager_qt.cpp
@@ -63,7 +63,8 @@ namespace {
 static const qreal kMicronsToMillimeter = 1000.0f;
 
 static std::vector<char>
-GetStdVectorFromHandle(base::SharedMemoryHandle handle, uint32_t data_size) {
+GetStdVectorFromHandle(base::SharedMemoryHandle handle, uint32_t data_size)
+{
     std::unique_ptr<base::SharedMemory> shared_buf(
                 new base::SharedMemory(handle, true));
 
@@ -76,7 +77,8 @@ GetStdVectorFromHandle(base::SharedMemoryHandle handle, uint32_t data_size) {
 }
 
 static scoped_refptr<base::RefCountedBytes>
-GetBytesFromHandle(base::SharedMemoryHandle handle, uint32_t data_size) {
+GetBytesFromHandle(base::SharedMemoryHandle handle, uint32_t data_size)
+{
      std::unique_ptr<base::SharedMemory> shared_buf(
                  new base::SharedMemory(handle, true));
 
@@ -91,7 +93,10 @@ GetBytesFromHandle(base::SharedMemoryHandle handle, uint32_t data_size) {
 
 // Write the PDF file to disk.
 static void SavePdfFile(scoped_refptr<base::RefCountedBytes> data,
-                        const base::FilePath& path) {
+                        const base::FilePath& path,
+                        const QtWebEngineCore::PrintViewManagerQt::PrintToPDFFileCallback
+                                &saveCallback)
+{
     DCHECK_CURRENTLY_ON(content::BrowserThread::FILE);
     DCHECK_GT(data->size(), 0U);
 
@@ -100,8 +105,10 @@ static void SavePdfFile(scoped_refptr<base::RefCountedBytes> data,
 
     base::File file(path,
                     base::File::FLAG_CREATE_ALWAYS | base::File::FLAG_WRITE);
-    if (file.IsValid())
-        metafile.SaveTo(&file);
+    bool success = file.IsValid() && metafile.SaveTo(&file);
+    content::BrowserThread::PostTask(content::BrowserThread::UI,
+                                     FROM_HERE,
+                                     base::Bind(saveCallback, success));
 }
 
 static base::DictionaryValue *createPrintSettings()
@@ -172,30 +179,43 @@ PrintViewManagerQt::~PrintViewManagerQt()
 }
 
 #if defined(ENABLE_BASIC_PRINTING)
-bool PrintViewManagerQt::PrintToPDF(const QPageLayout &pageLayout, bool printInColor, const QString &filePath)
+void PrintViewManagerQt::PrintToPDFFileWithCallback(const QPageLayout &pageLayout,
+                                                    bool printInColor, const QString &filePath,
+                                                    const PrintToPDFFileCallback& callback)
 {
-    if (m_printSettings || !filePath.length())
-        return false;
+    if (callback.is_null())
+        return;
+
+    if (m_printSettings || !filePath.length()) {
+                content::BrowserThread::PostTask(content::BrowserThread::UI,
+                                         FROM_HERE,
+                                         base::Bind(callback, false));
+        return;
+    }
 
     m_pdfOutputPath = toFilePath(filePath);
+    m_pdfSaveCallback = callback;
     if (!PrintToPDFInternal(pageLayout, printInColor)) {
+        content::BrowserThread::PostTask(content::BrowserThread::UI,
+                                         FROM_HERE,
+                                         base::Bind(callback, false));
         resetPdfState();
-        return false;
     }
-    return true;
 }
 
-bool PrintViewManagerQt::PrintToPDFWithCallback(const QPageLayout &pageLayout, bool printInColor, const PrintToPDFCallback& callback)
+void PrintViewManagerQt::PrintToPDFWithCallback(const QPageLayout &pageLayout,
+                                                bool printInColor,
+                                                const PrintToPDFCallback& callback)
 {
     if (callback.is_null())
-        return false;
+        return;
 
     // If there already is a pending print in progress, don't try starting another one.
     if (m_printSettings) {
             content::BrowserThread::PostTask(content::BrowserThread::UI,
                                              FROM_HERE,
                                              base::Bind(callback, std::vector<char>()));
-        return false;
+        return;
     }
 
     m_pdfPrintCallback = callback;
@@ -205,9 +225,7 @@ bool PrintViewManagerQt::PrintToPDFWithCallback(const QPageLayout &pageLayout, b
                                          base::Bind(callback, std::vector<char>()));
 
         resetPdfState();
-        return false;
     }
-    return true;
 }
 
 bool PrintViewManagerQt::PrintToPDFInternal(const QPageLayout &pageLayout, bool printInColor)
@@ -218,7 +236,8 @@ bool PrintViewManagerQt::PrintToPDFInternal(const QPageLayout &pageLayout, bool
     m_printSettings.reset(createPrintSettingsFromQPageLayout(pageLayout));
     m_printSettings->SetBoolean(printing::kSettingShouldPrintBackgrounds
         , web_contents()->GetRenderViewHost()->GetWebkitPreferences().should_print_backgrounds);
-    m_printSettings->SetInteger(printing::kSettingColor, printInColor ? printing::COLOR : printing::GRAYSCALE);
+    m_printSettings->SetInteger(printing::kSettingColor,
+                                printInColor ? printing::COLOR : printing::GRAYSCALE);
     return Send(new PrintMsg_InitiatePrintPreview(routing_id(), false));
 }
 
@@ -255,6 +274,7 @@ void PrintViewManagerQt::resetPdfState()
 {
     m_pdfOutputPath.clear();
     m_pdfPrintCallback.Reset();
+    m_pdfSaveCallback.Reset();
     m_printSettings.reset();
 }
 
@@ -273,20 +293,23 @@ void PrintViewManagerQt::OnMetafileReadyForPrinting(
 
     // Create local copies so we can reset the state and take a new pdf print job.
     base::Callback<void(const std::vector<char>&)> pdf_print_callback = m_pdfPrintCallback;
+    base::Callback<void(bool)> pdf_save_callback = m_pdfSaveCallback;
     base::FilePath pdfOutputPath = m_pdfOutputPath;
 
     resetPdfState();
 
     if (!pdf_print_callback.is_null()) {
-        std::vector<char> data_vector = GetStdVectorFromHandle(params.metafile_data_handle, params.data_size);
+        std::vector<char> data_vector = GetStdVectorFromHandle(params.metafile_data_handle,
+                                                               params.data_size);
         content::BrowserThread::PostTask(content::BrowserThread::UI,
                                          FROM_HERE,
                                          base::Bind(pdf_print_callback, data_vector));
     } else {
-        scoped_refptr<base::RefCountedBytes> data_bytes = GetBytesFromHandle(params.metafile_data_handle, params.data_size);
+        scoped_refptr<base::RefCountedBytes> data_bytes
+                = GetBytesFromHandle(params.metafile_data_handle, params.data_size);
         content::BrowserThread::PostTask(content::BrowserThread::FILE,
                FROM_HERE,
-               base::Bind(&SavePdfFile, data_bytes, pdfOutputPath));
+               base::Bind(&SavePdfFile, data_bytes, pdfOutputPath, pdf_save_callback));
     }
 }