summaryrefslogtreecommitdiffstats
path: root/layout/printing/nsPagePrintTimer.cpp
diff options
context:
space:
mode:
authorMatt A. Tobin <mattatobin@localhost.localdomain>2018-02-02 04:16:08 -0500
committerMatt A. Tobin <mattatobin@localhost.localdomain>2018-02-02 04:16:08 -0500
commit5f8de423f190bbb79a62f804151bc24824fa32d8 (patch)
tree10027f336435511475e392454359edea8e25895d /layout/printing/nsPagePrintTimer.cpp
parent49ee0794b5d912db1f95dce6eb52d781dc210db5 (diff)
downloadUXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar
UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.gz
UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.lz
UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.xz
UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.zip
Add m-esr52 at 52.6.0
Diffstat (limited to 'layout/printing/nsPagePrintTimer.cpp')
-rw-r--r--layout/printing/nsPagePrintTimer.cpp224
1 files changed, 224 insertions, 0 deletions
diff --git a/layout/printing/nsPagePrintTimer.cpp b/layout/printing/nsPagePrintTimer.cpp
new file mode 100644
index 000000000..b56569a9a
--- /dev/null
+++ b/layout/printing/nsPagePrintTimer.cpp
@@ -0,0 +1,224 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#include "nsPagePrintTimer.h"
+
+#include "mozilla/Unused.h"
+#include "nsIContentViewer.h"
+#include "nsIServiceManager.h"
+#include "nsPrintEngine.h"
+
+NS_IMPL_ISUPPORTS_INHERITED(nsPagePrintTimer, mozilla::Runnable, nsITimerCallback)
+
+nsPagePrintTimer::~nsPagePrintTimer()
+{
+ // "Destroy" the document viewer; this normally doesn't actually
+ // destroy it because of the IncrementDestroyRefCount call below
+ // XXX This is messy; the document viewer should use a single approach
+ // to keep itself alive during printing
+ nsCOMPtr<nsIContentViewer> cv(do_QueryInterface(mDocViewerPrint));
+ if (cv) {
+ cv->Destroy();
+ }
+}
+
+nsresult
+nsPagePrintTimer::StartTimer(bool aUseDelay)
+{
+ nsresult result;
+ mTimer = do_CreateInstance("@mozilla.org/timer;1", &result);
+ if (NS_FAILED(result)) {
+ NS_WARNING("unable to start the timer");
+ } else {
+ uint32_t delay = 0;
+ if (aUseDelay) {
+ if (mFiringCount < 10) {
+ // Longer delay for the few first pages.
+ delay = mDelay + ((10 - mFiringCount) * 100);
+ } else {
+ delay = mDelay;
+ }
+ }
+ mTimer->InitWithCallback(this, delay, nsITimer::TYPE_ONE_SHOT);
+ }
+ return result;
+}
+
+nsresult
+nsPagePrintTimer::StartWatchDogTimer()
+{
+ nsresult result;
+ if (mWatchDogTimer) {
+ mWatchDogTimer->Cancel();
+ }
+ mWatchDogTimer = do_CreateInstance("@mozilla.org/timer;1", &result);
+ if (NS_FAILED(result)) {
+ NS_WARNING("unable to start the timer");
+ } else {
+ // Instead of just doing one timer for a long period do multiple so we
+ // can check if the user cancelled the printing.
+ mWatchDogTimer->InitWithCallback(this, WATCH_DOG_INTERVAL,
+ nsITimer::TYPE_ONE_SHOT);
+ }
+ return result;
+}
+
+void
+nsPagePrintTimer::StopWatchDogTimer()
+{
+ if (mWatchDogTimer) {
+ mWatchDogTimer->Cancel();
+ mWatchDogTimer = nullptr;
+ }
+}
+
+//nsRunnable
+NS_IMETHODIMP
+nsPagePrintTimer::Run()
+{
+ bool initNewTimer = true;
+ // Check to see if we are done
+ // inRange will be true if a page is actually printed
+ bool inRange;
+ bool donePrinting;
+
+ // donePrinting will be true if it completed successfully or
+ // if the printing was cancelled
+ donePrinting = !mPrintEngine || mPrintEngine->PrintPage(mPrintObj, inRange);
+ if (donePrinting) {
+ // now clean up print or print the next webshell
+ if (!mPrintEngine || mPrintEngine->DonePrintingPages(mPrintObj, NS_OK)) {
+ initNewTimer = false;
+ mDone = true;
+ }
+ }
+
+ // Note that the Stop() destroys this after the print job finishes
+ // (The PrintEngine stops holding a reference when DonePrintingPages
+ // returns true.)
+ Stop();
+ if (initNewTimer) {
+ ++mFiringCount;
+ nsresult result = StartTimer(inRange);
+ if (NS_FAILED(result)) {
+ mDone = true; // had a failure.. we are finished..
+ if (mPrintEngine) {
+ mPrintEngine->SetIsPrinting(false);
+ }
+ }
+ }
+ return NS_OK;
+}
+
+// nsITimerCallback
+NS_IMETHODIMP
+nsPagePrintTimer::Notify(nsITimer *timer)
+{
+ // When finished there may be still pending notifications, which we can just
+ // ignore.
+ if (mDone) {
+ return NS_OK;
+ }
+
+ // There are four things that call Notify with different values for timer:
+ // 1) the delay between pages (timer == mTimer)
+ // 2) canvasPrintState done (timer == null)
+ // 3) the watch dog timer (timer == mWatchDogTimer)
+ // 4) the waiting for remote print "timer" (timer == mWaitingForRemotePrint)
+ if (!timer) {
+ // Reset the counter since a mozPrintCallback has finished.
+ mWatchDogCount = 0;
+ } else if (timer == mTimer) {
+ // Reset the watchdog timer before the start of every page.
+ mWatchDogCount = 0;
+ mTimer = nullptr;
+ } else if (timer == mWaitingForRemotePrint) {
+ mWaitingForRemotePrint = nullptr;
+
+ // If we are still waiting for the page delay timer, don't let the
+ // notification from the remote print job trigger the next page.
+ if (mTimer) {
+ return NS_OK;
+ }
+ } else if (timer == mWatchDogTimer) {
+ mWatchDogCount++;
+ if (mWatchDogCount > WATCH_DOG_MAX_COUNT) {
+ Fail();
+ return NS_OK;
+ }
+ }
+
+ if (mDocViewerPrint) {
+ bool donePrePrint = true;
+ if (mPrintEngine) {
+ donePrePrint = mPrintEngine->PrePrintPage();
+ }
+
+ if (donePrePrint && !mWaitingForRemotePrint) {
+ StopWatchDogTimer();
+ NS_DispatchToMainThread(this);
+ } else {
+ // Start the watch dog if we're waiting for preprint to ensure that if any
+ // mozPrintCallbacks take to long we error out.
+ StartWatchDogTimer();
+ }
+
+ }
+ return NS_OK;
+}
+
+
+void
+nsPagePrintTimer::WaitForRemotePrint()
+{
+ nsresult result;
+ mWaitingForRemotePrint = do_CreateInstance("@mozilla.org/timer;1", &result);
+ if (NS_FAILED(result)) {
+ NS_WARNING("Failed to wait for remote print, we might time-out.");
+ mWaitingForRemotePrint = nullptr;
+ }
+}
+
+void
+nsPagePrintTimer::RemotePrintFinished()
+{
+ if (!mWaitingForRemotePrint) {
+ return;
+ }
+
+ mozilla::Unused <<
+ mWaitingForRemotePrint->InitWithCallback(this, 0, nsITimer::TYPE_ONE_SHOT);
+}
+
+nsresult
+nsPagePrintTimer::Start(nsPrintObject* aPO)
+{
+ mPrintObj = aPO;
+ mDone = false;
+ return StartTimer(false);
+}
+
+
+void
+nsPagePrintTimer::Stop()
+{
+ if (mTimer) {
+ mTimer->Cancel();
+ mTimer = nullptr;
+ }
+ StopWatchDogTimer();
+}
+
+void
+nsPagePrintTimer::Fail()
+{
+ NS_WARNING("nsPagePrintTimer::Fail called");
+
+ mDone = true;
+ Stop();
+ if (mPrintEngine) {
+ mPrintEngine->CleanupOnFailure(NS_OK, false);
+ }
+}