home *** CD-ROM | disk | FTP | other *** search
/ PC World 2006 December / PCWorld_2006-12_cd.bin / komunikace / netscape / nsb-install-8-1-2.exe / components / nsProgressDialog.js < prev    next >
Text File  |  2006-01-06  |  38KB  |  945 lines
  1. /* vim:set ts=4 sts=4 sw=4 et cin: */
  2. /* ***** BEGIN LICENSE BLOCK *****
  3.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  4.  *
  5.  * The contents of this file are subject to the Mozilla Public License Version
  6.  * 1.1 (the "License"); you may not use this file except in compliance with
  7.  * the License. You may obtain a copy of the License at
  8.  * http://www.mozilla.org/MPL/
  9.  *
  10.  * Software distributed under the License is distributed on an "AS IS" basis,
  11.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12.  * for the specific language governing rights and limitations under the
  13.  * License.
  14.  *
  15.  * The Original Code is Mozilla Progress Dialog.
  16.  *
  17.  * The Initial Developer of the Original Code is
  18.  * Netscape Communications Corp.
  19.  * Portions created by the Initial Developer are Copyright (C) 2002
  20.  * the Initial Developer. All Rights Reserved.
  21.  *
  22.  * Contributor(s):
  23.  *   Bill Law       <law@netscape.com>
  24.  *   Aaron Kaluszka <ask@swva.net>
  25.  *
  26.  * Alternatively, the contents of this file may be used under the terms of
  27.  * either the GNU General Public License Version 2 or later (the "GPL"), or
  28.  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29.  * in which case the provisions of the GPL or the LGPL are applicable instead
  30.  * of those above. If you wish to allow use of your version of this file only
  31.  * under the terms of either the GPL or the LGPL, and not to allow others to
  32.  * use your version of this file under the terms of the MPL, indicate your
  33.  * decision by deleting the provisions above and replace them with the notice
  34.  * and other provisions required by the GPL or the LGPL. If you do not delete
  35.  * the provisions above, a recipient may use your version of this file under
  36.  * the terms of any one of the MPL, the GPL or the LGPL.
  37.  *
  38.  * ***** END LICENSE BLOCK ***** */
  39.  
  40. /* This file implements the nsIProgressDialog interface.  See nsIProgressDialog.idl
  41.  *
  42.  * The implementation consists of a JavaScript "class" named nsProgressDialog,
  43.  * comprised of:
  44.  *   - a JS constructor function
  45.  *   - a prototype providing all the interface methods and implementation stuff
  46.  *
  47.  * In addition, this file implements an nsIModule object that registers the
  48.  * nsProgressDialog component.
  49.  */
  50.  
  51. /* ctor
  52.  */
  53. function nsProgressDialog() {
  54.     // Initialize data properties.
  55.     this.mParent      = null;
  56.     this.mOperation   = null;
  57.     this.mStartTime   = ( new Date() ).getTime();
  58.     this.observer     = null;
  59.     this.mLastUpdate  = Number.MIN_VALUE; // To ensure first onProgress causes update.
  60.     this.mInterval    = 750; // Default to .75 seconds.
  61.     this.mElapsed     = 0;
  62.     this.mLoaded      = false;
  63.     this.fields       = new Array;
  64.     this.strings      = new Array;
  65.     this.mSource      = null;
  66.     this.mTarget      = null;
  67.     this.mTargetFile  = null;
  68.     this.mMIMEInfo    = null;
  69.     this.mDialog      = null;
  70.     this.mDisplayName = null;
  71.     this.mPaused      = false;
  72.     this.mRequest     = null;
  73.     this.mCompleted   = false;
  74.     this.mMode        = "normal";
  75.     this.mPercent     = 0;
  76.     this.mRate        = 0;
  77.     this.mBundle      = null;
  78.     this.mCancelDownloadOnClose = true;
  79. }
  80.  
  81. const nsIProgressDialog      = Components.interfaces.nsIProgressDialog;
  82. const nsIWindowWatcher       = Components.interfaces.nsIWindowWatcher;
  83. const nsIWebProgressListener = Components.interfaces.nsIWebProgressListener;
  84. const nsITextToSubURI        = Components.interfaces.nsITextToSubURI;
  85. const nsIChannel             = Components.interfaces.nsIChannel;
  86. const nsIFileURL             = Components.interfaces.nsIFileURL;
  87. const nsIURL                 = Components.interfaces.nsIURL;
  88. const nsILocalFile           = Components.interfaces.nsILocalFile;
  89.  
  90. nsProgressDialog.prototype = {
  91.     // Turn this on to get debugging messages.
  92.     debug: false,
  93.  
  94.     // Chrome-related constants.
  95.     dialogChrome:   "chrome://global/content/nsProgressDialog.xul",
  96.     dialogFeatures: "chrome,titlebar,minimizable=yes,dialog=no",
  97.  
  98.     // getters/setters
  99.     get saving()            { return this.MIMEInfo == null ||
  100.                               this.MIMEInfo.preferredAction == Components.interfaces.nsIMIMEInfo.saveToDisk; },
  101.     get parent()            { return this.mParent; },
  102.     set parent(newval)      { return this.mParent = newval; },
  103.     get operation()         { return this.mOperation; },
  104.     set operation(newval)   { return this.mOperation = newval; },
  105.     get observer()          { return this.mObserver; },
  106.     set observer(newval)    { return this.mObserver = newval; },
  107.     get startTime()         { return this.mStartTime; },
  108.     set startTime(newval)   { return this.mStartTime = newval/1000; }, // PR_Now() is in microseconds, so we convert.
  109.     get lastUpdate()        { return this.mLastUpdate; },
  110.     set lastUpdate(newval)  { return this.mLastUpdate = newval; },
  111.     get interval()          { return this.mInterval; },
  112.     set interval(newval)    { return this.mInterval = newval; },
  113.     get elapsed()           { return this.mElapsed; },
  114.     set elapsed(newval)     { return this.mElapsed = newval; },
  115.     get loaded()            { return this.mLoaded; },
  116.     set loaded(newval)      { return this.mLoaded = newval; },
  117.     get source()            { return this.mSource; },
  118.     set source(newval)      { return this.mSource = newval; },
  119.     get target()            { return this.mTarget; },
  120.     get targetFile()        { return this.mTargetFile; },
  121.     get MIMEInfo()          { return this.mMIMEInfo; },
  122.     set MIMEInfo(newval)    { return this.mMIMEInfo = newval; },
  123.     get dialog()            { return this.mDialog; },
  124.     set dialog(newval)      { return this.mDialog = newval; },
  125.     get displayName()       { return this.mDisplayName; },
  126.     set displayName(newval) { return this.mDisplayName = newval; },
  127.     get paused()            { return this.mPaused; },
  128.     get request()           { return this.mRequest; },
  129.     set request(newval)     { return this.mRequest = newval; },
  130.     get completed()         { return this.mCompleted; },
  131.     get mode()              { return this.mMode; },
  132.     get percent()           { return this.mPercent; },
  133.     get rate()              { return this.mRate; },
  134.     get kRate()             { return this.mRate / 1024; },
  135.     get cancelDownloadOnClose() { return this.mCancelDownloadOnClose; },
  136.     set cancelDownloadOnClose(newval) { return this.mCancelDownloadOnClose = newval; },
  137.  
  138.     set target(newval) { 
  139.         // If newval references a file on the local filesystem, then grab a
  140.         // reference to its corresponding nsIFile.
  141.         if (newval instanceof nsIFileURL && newval.file instanceof nsILocalFile) {
  142.             this.mTargetFile = newval.file.QueryInterface(nsILocalFile);
  143.         } else {
  144.             this.mTargetFile = null;
  145.         }
  146.  
  147.         return this.mTarget = newval;
  148.     },
  149.  
  150.     // These setters use functions that update the dialog.
  151.     set paused(newval)      { return this.setPaused(newval); },
  152.     set completed(newval)   { return this.setCompleted(newval); },
  153.     set mode(newval)        { return this.setMode(newval); },
  154.     set percent(newval)     { return this.setPercent(newval); },
  155.     set rate(newval)        { return this.setRate(newval); },
  156.  
  157.     // ---------- nsIProgressDialog methods ----------
  158.  
  159.     // open: Store aParentWindow and open the dialog.
  160.     open: function( aParentWindow ) {
  161.         // Save parent and "persist" operation.
  162.         this.parent    = aParentWindow;
  163.  
  164.         // Open dialog using the WindowWatcher service.
  165.         var ww = Components.classes["@mozilla.org/embedcomp/window-watcher;1"]
  166.                    .getService( nsIWindowWatcher );
  167.         this.dialog = ww.openWindow( this.parent,
  168.                                      this.dialogChrome,
  169.                                      null,
  170.                                      this.dialogFeatures,
  171.                                      this );
  172.     },
  173.     
  174.     init: function( aSource, aTarget, aDisplayName, aMIMEInfo, aStartTime, aOperation ) {
  175.       this.source = aSource;
  176.       this.target = aTarget;
  177.       this.displayName = aDisplayName;
  178.       this.MIMEInfo = aMIMEInfo;
  179.       if ( aStartTime ) {
  180.           this.startTime = aStartTime;
  181.       }
  182.       this.operation = aOperation;
  183.     },
  184.  
  185.     // ---------- nsIWebProgressListener methods ----------
  186.  
  187.     // Look for STATE_STOP and update dialog to indicate completion when it happens.
  188.     onStateChange: function( aWebProgress, aRequest, aStateFlags, aStatus ) {
  189.         if ( aStateFlags & nsIWebProgressListener.STATE_STOP ) {
  190.             // if we are downloading, then just wait for the first STATE_STOP
  191.             if ( this.targetFile != null ) {
  192.                 // we are done transfering...
  193.                 this.completed = true;
  194.                 return;
  195.             }
  196.  
  197.             // otherwise, wait for STATE_STOP with aRequest corresponding to
  198.             // our target.  XXX redirects might screw up this logic.
  199.             try {
  200.                 var chan = aRequest.QueryInterface(nsIChannel);
  201.                 if (chan.URI.equals(this.target)) {
  202.                     // we are done transfering...
  203.                     this.completed = true;
  204.                 }
  205.             }
  206.             catch (e) {
  207.             }
  208.         }
  209.     },
  210.  
  211.     // Handle progress notifications.
  212.     onProgressChange: function( aWebProgress,
  213.                                 aRequest,
  214.                                 aCurSelfProgress,
  215.                                 aMaxSelfProgress,
  216.                                 aCurTotalProgress,
  217.                                 aMaxTotalProgress ) {
  218.         // Remember the request; this will also initialize the pause/resume stuff.
  219.         this.request = aRequest;
  220.  
  221.         var overallProgress = aCurTotalProgress;
  222.  
  223.         // Get current time.
  224.         var now = ( new Date() ).getTime();
  225.  
  226.         // If interval hasn't elapsed, ignore it.
  227.         if ( now - this.lastUpdate < this.interval &&
  228.              aMaxTotalProgress != "-1" && 
  229.              parseInt( aCurTotalProgress ) < parseInt( aMaxTotalProgress ) ) {
  230.             return;
  231.         }
  232.  
  233.         // Update this time.
  234.         this.lastUpdate = now;
  235.  
  236.         // Update elapsed time.
  237.         this.elapsed = now - this.startTime;
  238.  
  239.         // Calculate percentage.
  240.         if ( aMaxTotalProgress > 0) {
  241.             this.percent = Math.floor( ( overallProgress * 100.0 ) / aMaxTotalProgress );
  242.         } else {
  243.             this.percent = -1;
  244.         }
  245.  
  246.         // If dialog not loaded, then don't bother trying to update display.
  247.         if ( !this.loaded ) {
  248.             return;
  249.         }
  250.  
  251.         // Update dialog's display of elapsed time.
  252.         this.setValue( "timeElapsed", this.formatSeconds( this.elapsed / 1000 ) );
  253.  
  254.         // Now that we've set the progress and the time, update # bytes downloaded...
  255.         // Update status (nnK of mmK bytes at xx.xK aCurTotalProgress/sec)
  256.         var status = this.getString( "progressMsg" );
  257.  
  258.         // Insert 1 is the number of kilobytes downloaded so far.
  259.         status = this.replaceInsert( status, 1, parseInt( overallProgress/1024 + .5 ) );
  260.  
  261.         // Insert 2 is the total number of kilobytes to be downloaded (if known).
  262.         if ( aMaxTotalProgress != "-1" ) {
  263.             status = this.replaceInsert( status, 2, parseInt( aMaxTotalProgress/1024 + .5 ) );
  264.         } else {
  265.             status = this.replaceInsert( status, 2, "??" );
  266.         }
  267.     
  268.         // Insert 3 is the download rate.
  269.         if ( this.elapsed ) {
  270.             this.rate = ( aCurTotalProgress * 1000 ) / this.elapsed;
  271.             status = this.replaceInsert( status, 3, this.rateToKRate( this.rate ) );
  272.         } else {
  273.             // Rate not established, yet.
  274.             status = this.replaceInsert( status, 3, "??.?" );
  275.         }
  276.     
  277.         // All 3 inserts are taken care of, now update status msg.
  278.         this.setValue( "status", status );
  279.     
  280.         // Update time remaining.
  281.         if ( this.rate && ( aMaxTotalProgress > 0 ) ) {
  282.             // Calculate how much time to download remaining at this rate.
  283.             var rem = Math.round( ( aMaxTotalProgress - aCurTotalProgress ) / this.rate );
  284.             this.setValue( "timeLeft", this.formatSeconds( rem ) );
  285.         } else {
  286.             // We don't know how much time remains.
  287.             this.setValue( "timeLeft", this.getString( "unknownTime" ) );
  288.         }
  289.     },
  290.  
  291.     // Look for error notifications and display alert to user.
  292.     onStatusChange: function( aWebProgress, aRequest, aStatus, aMessage ) {
  293.         // Check for error condition (only if dialog is still open).
  294.         if ( aStatus != Components.results.NS_OK ) {
  295.             if ( this.loaded ) {
  296.                 // Get prompt service.
  297.                 var prompter = Components.classes[ "@mozilla.org/embedcomp/prompt-service;1" ]
  298.                                    .getService( Components.interfaces.nsIPromptService );
  299.                 // Display error alert (using text supplied by back-end).
  300.                 var title = this.getProperty( this.saving ? "savingAlertTitle" : "openingAlertTitle",
  301.                                               [ this.fileName() ], 
  302.                                               1 );
  303.                 prompter.alert( this.dialog, title, aMessage );
  304.     
  305.                 // Close the dialog.
  306.                 if ( !this.completed ) {
  307.                     this.onCancel();
  308.                 }
  309.             } else {
  310.                 // Error occurred prior to onload even firing.
  311.                 // We can't handle this error until we're done loading, so
  312.                 // defer the handling of this call.
  313.                 this.dialog.setTimeout( function(obj,wp,req,stat,msg){obj.onStatusChange(wp,req,stat,msg)},
  314.                                         100, this, aWebProgress, aRequest, aStatus, aMessage );
  315.             }
  316.         }
  317.     },
  318.  
  319.     // Ignore onLocationChange and onSecurityChange notifications.
  320.     onLocationChange: function( aWebProgress, aRequest, aLocation ) {
  321.     },
  322.  
  323.     onSecurityChange: function( aWebProgress, aRequest, state ) {
  324.     },
  325.  
  326.     // ---------- nsIObserver methods ----------
  327.     observe: function( anObject, aTopic, aData ) {
  328.         // Something of interest occured on the dialog.
  329.         // Dispatch to corresponding implementation method.
  330.         switch ( aTopic ) {
  331.         case "onload":
  332.             this.onLoad();
  333.             break;
  334.         case "oncancel":
  335.             this.onCancel();
  336.             break;
  337.         case "onpause":
  338.             this.onPause();
  339.             break;
  340.         case "onlaunch":
  341.             this.onLaunch();
  342.             break;
  343.         case "onreveal":
  344.             this.onReveal();
  345.             break;
  346.         case "onunload":
  347.             this.onUnload();
  348.             break;
  349.         case "oncompleted":
  350.             // This event comes in when setCompleted needs to be deferred because
  351.             // the dialog isn't loaded yet.
  352.             this.completed = true;
  353.             break;
  354.         default:
  355.             break;
  356.         }
  357.     },
  358.  
  359.     // ---------- nsISupports methods ----------
  360.  
  361.     // This "class" supports nsIProgressDialog, nsIWebProgressListener (by virtue
  362.     // of interface inheritance), nsIObserver, and nsISupports.
  363.     QueryInterface: function (iid) {
  364.         if (!iid.equals(Components.interfaces.nsIProgressDialog) &&
  365.             !iid.equals(Components.interfaces.nsIDownload) && 
  366.             !iid.equals(Components.interfaces.nsITransfer) && 
  367.             !iid.equals(Components.interfaces.nsIWebProgressListener) &&
  368.             !iid.equals(Components.interfaces.nsIObserver) &&
  369.             !iid.equals(Components.interfaces.nsIInterfaceRequestor) &&
  370.             !iid.equals(Components.interfaces.nsISupports)) {
  371.             throw Components.results.NS_ERROR_NO_INTERFACE;
  372.         }
  373.         return this;
  374.     },
  375.  
  376.     // ---------- nsIInterfaceRequestor methods ----------
  377.  
  378.     getInterface: function(iid) {
  379.         if (iid.equals(Components.interfaces.nsIPrompt) ||
  380.             iid.equals(Components.interfaces.nsIAuthPrompt)) {
  381.             // use the window watcher service to get a nsIPrompt/nsIAuthPrompt impl
  382.             var ww = Components.classes["@mozilla.org/embedcomp/window-watcher;1"]
  383.                                .getService(Components.interfaces.nsIWindowWatcher);
  384.             var prompt;
  385.             if (iid.equals(Components.interfaces.nsIPrompt))
  386.                 prompt = ww.getNewPrompter(this.parent);
  387.             else
  388.                 prompt = ww.getNewAuthPrompter(this.parent);
  389.             return prompt;
  390.         }
  391.         Components.returnCode = Components.results.NS_ERROR_NO_INTERFACE;
  392.         return null;
  393.     },
  394.  
  395.     // ---------- implementation methods ----------
  396.  
  397.     // Initialize the dialog.
  398.     onLoad: function() {
  399.         // Note that onLoad has finished.
  400.         this.loaded = true;
  401.  
  402.         // Fill dialog.
  403.         this.loadDialog();
  404.  
  405.         // Position dialog.
  406.         if ( this.dialog.opener ) {
  407.             this.dialog.moveToAlertPosition();
  408.         } else {
  409.             this.dialog.centerWindowOnScreen();
  410.         }
  411.  
  412.         // Set initial focus on "keep open" box.  If that box is hidden, or, if
  413.         // the download is already complete, then focus is on the cancel/close
  414.         // button.  The download may be complete if it was really short and the
  415.         // dialog took longer to open than to download the data.
  416.         if ( !this.completed && !this.saving ) {
  417.             this.dialogElement( "keep" ).focus();
  418.         } else {
  419.             this.dialogElement( "cancel" ).focus();
  420.         }
  421.     },
  422.  
  423.     // load dialog with initial contents
  424.     loadDialog: function() {
  425.         // Check whether we're saving versus opening with a helper app.
  426.         if ( !this.saving ) {
  427.             // Put proper label on source field.
  428.             this.setValue( "sourceLabel", this.getString( "openingSource" ) );
  429.  
  430.             // Target is the "preferred" application.  Hide if empty.
  431.             if ( this.MIMEInfo && this.MIMEInfo.preferredApplicationHandler ) {
  432.                 var appName = this.MIMEInfo.preferredApplicationHandler.leafName;
  433.                 if ( appName == null || appName.length == 0 ) {
  434.                     this.hide( "targetRow" );
  435.                 } else {
  436.                     // Use the "with:" label.
  437.                     this.setValue( "targetLabel", this.getString( "openingTarget" ) );
  438.                     // Name of application.
  439.                     this.setValue( "target", appName );
  440.                 }
  441.            } else {
  442.                this.hide( "targetRow" );
  443.            }
  444.         } else {
  445.             // If target is not a local file, then hide extra dialog controls.
  446.             if (this.targetFile != null) {
  447.                 this.setValue( "target", this.targetFile.path );
  448.             } else {
  449.                 this.setValue( "target", this.target.spec );
  450.                 this.hide( "pauseResume" );
  451.                 this.hide( "launch" );
  452.                 this.hide( "reveal" );
  453.             }
  454.         }
  455.  
  456.         // Set source field.
  457.         this.setValue( "source", this.source.spec );
  458.  
  459.         var now = ( new Date() ).getTime();
  460.  
  461.         // Intialize the elapsed time.
  462.         if ( !this.elapsed ) {
  463.             this.elapsed = now - this.startTime;
  464.         }
  465.  
  466.         // Update elapsed time display.
  467.         this.setValue( "timeElapsed", this.formatSeconds( this.elapsed / 1000 ) );
  468.         this.setValue( "timeLeft", this.getString( "unknownTime" ) );
  469.  
  470.         // Initialize the "keep open" box.  Hide this if we're opening a helper app
  471.         // or if we are uploading.
  472.         if ( !this.saving || !this.targetFile ) {
  473.             // Hide this in this case.
  474.             this.hide( "keep" );
  475.         } else {
  476.             // Initialize using last-set value from prefs.
  477.             var prefs = Components.classes[ "@mozilla.org/preferences-service;1" ]
  478.                             .getService( Components.interfaces.nsIPrefBranch );
  479.             if ( prefs ) {
  480.                 this.dialogElement( "keep" ).checked = prefs.getBoolPref( "browser.download.progressDnldDialog.keepAlive" );
  481.             }
  482.         }
  483.  
  484.         // Initialize title.
  485.         this.setTitle();
  486.     },
  487.  
  488.     // Cancel button stops the download (if not completed),
  489.     // and closes the dialog.
  490.     onCancel: function() {
  491.         // Cancel the download, if not completed.
  492.         if ( !this.completed ) {
  493.             if ( this.operation ) {
  494.                 this.operation.cancelSave();
  495.                 // XXX We're supposed to clean up files/directories.
  496.             }
  497.             if ( this.observer ) {
  498.                 this.observer.observe( this, "oncancel", "" );
  499.             }
  500.             this.paused = false;
  501.         }
  502.         // Test whether the dialog is already closed.
  503.         // This will be the case if we've come through onUnload.
  504.         if ( this.dialog ) {
  505.             // Close the dialog.
  506.             this.dialog.close();
  507.         }
  508.     },
  509.  
  510.     // onunload event means the dialog has closed.
  511.     // We go through our onCancel logic to stop the download if still in progress.
  512.     onUnload: function() {
  513.         // Remember "keep dialog open" setting, if visible.
  514.         if ( this.saving ) {
  515.             var prefs = Components.classes["@mozilla.org/preferences-service;1"]
  516.                           .getService( Components.interfaces.nsIPrefBranch );
  517.             if ( prefs ) {
  518.                 prefs.setBoolPref( "browser.download.progressDnldDialog.keepAlive", this.dialogElement( "keep" ).checked );
  519.             }
  520.          }
  521.          this.dialog = null; // The dialog is history.
  522.          if ( this.mCancelDownloadOnClose ) {
  523.              this.onCancel();
  524.          }
  525.     },
  526.  
  527.     // onpause event means the user pressed the pause/resume button
  528.     // Toggle the pause/resume state (see the function setPause(), below).i
  529.     onPause: function() {
  530.          this.paused = !this.paused;
  531.     },
  532.  
  533.     // onlaunch event means the user pressed the launch button
  534.     // Invoke the launch method of the target file.
  535.     onLaunch: function() {
  536.          try {
  537.            const kDontAskAgainPref  = "browser.download.progressDnlgDialog.dontAskForLaunch";
  538.            try {
  539.              var pref = Components.classes["@mozilla.org/preferences-service;1"]
  540.                               .getService(Components.interfaces.nsIPrefBranch);
  541.              var dontAskAgain = pref.getBoolPref(kDontAskAgainPref);
  542.            } catch (e) {
  543.              // we need to ask if we're unsure
  544.              dontAskAgain = false;
  545.            }
  546.            if ( !dontAskAgain && this.targetFile.isExecutable() ) {
  547.              try {
  548.                var promptService = Components.classes["@mozilla.org/embedcomp/prompt-service;1"]
  549.                                                .getService( Components.interfaces.nsIPromptService );
  550.              } catch (ex) {
  551.                // getService doesn't return null, it throws
  552.                return;
  553.              }
  554.              var title = this.getProperty( "openingAlertTitle",
  555.                                            [ this.fileName() ],
  556.                                            1 );
  557.              var msg = this.getProperty( "securityAlertMsg",
  558.                                          [ this.fileName() ],
  559.                                          1 );
  560.              var dontaskmsg = this.getProperty( "dontAskAgain",
  561.                                                 [ ], 0 );
  562.              var checkbox = {value:0};
  563.              var okToProceed = promptService.confirmCheck(this.dialog, title, msg, dontaskmsg, checkbox);
  564.              try {
  565.                if (checkbox.value != dontAskAgain)
  566.                  pref.setBoolPref(kDontAskAgainPref, checkbox.value);
  567.              } catch (ex) {}
  568.  
  569.              if ( !okToProceed )
  570.                return;
  571.            }
  572.            this.targetFile.launch();
  573.            this.dialog.close();
  574.          } catch ( exception ) {
  575.              // XXX Need code here to tell user the launch failed!
  576.              dump( "nsProgressDialog::onLaunch failed: " + exception + "\n" );
  577.          }
  578.     },
  579.  
  580.     // onreveal event means the user pressed the "reveal location" button
  581.     // Invoke the reveal method of the target file.
  582.     onReveal: function() {
  583.          try {
  584.              this.targetFile.reveal();
  585.              this.dialog.close();
  586.          } catch ( exception ) {
  587.          }
  588.     },
  589.  
  590.     // Get filename from the target.
  591.     fileName: function() {
  592.         if ( this.targetFile != null )
  593.             return this.targetFile.leafName;
  594.         try {
  595.             var escapedFileName = this.target.QueryInterface(nsIURL).fileName; 
  596.             var textToSubURI = Components.classes["@mozilla.org/intl/texttosuburi;1"]
  597.                                          .getService(nsITextToSubURI);
  598.             return textToSubURI.unEscapeURIForUI(this.target.originCharset, escapedFileName);
  599.         } catch (e) {}
  600.         return "";
  601.     },
  602.  
  603.     // Set the dialog title.
  604.     setTitle: function() {
  605.         // Start with saving/opening template.
  606.         // If percentage is not known (-1), use alternate template
  607.         var title = this.saving 
  608.             ? ( this.percent != -1 ? this.getString( "savingTitle" ) : this.getString( "unknownSavingTitle" ) )
  609.             : ( this.percent != -1 ? this.getString( "openingTitle" ) : this.getString( "unknownOpeningTitle" ) );
  610.  
  611.  
  612.         // Use file name as insert 1.
  613.         title = this.replaceInsert( title, 1, this.fileName() );
  614.  
  615.         // Use percentage as insert 2 (if known).
  616.         if ( this.percent != -1 ) {
  617.             title = this.replaceInsert( title, 2, this.percent );
  618.         }
  619.  
  620.         // Set <window>'s title attribute.
  621.         if ( this.dialog ) {
  622.             this.dialog.title = title;
  623.         }
  624.     },
  625.  
  626.     // Update the dialog to indicate specified percent complete.
  627.     setPercent: function( percent ) {
  628.         // Maximum percentage is 100.
  629.         if ( percent > 100 ) {
  630.             percent = 100;
  631.         }
  632.         // Test if percentage is changing.
  633.         if ( this.percent != percent ) {
  634.             this.mPercent = percent;
  635.  
  636.             // If dialog not opened yet, bail early.
  637.             if ( !this.loaded ) {
  638.                 return this.mPercent;
  639.             }
  640.  
  641.             if ( percent == -1 ) {
  642.                 // Progress meter needs to be in "undetermined" mode.
  643.                 this.mode = "undetermined";
  644.  
  645.                 // Update progress meter percentage text.
  646.                 this.setValue( "progressText", "" );
  647.             } else {
  648.                 // Progress meter needs to be in normal mode.
  649.                 this.mode = "normal";
  650.  
  651.                 // Set progress meter thermometer.
  652.                 this.setValue( "progress", percent );
  653.  
  654.                 // Update progress meter percentage text.
  655.                 this.setValue( "progressText", this.replaceInsert( this.getString( "percentMsg" ), 1, percent ) );
  656.             }
  657.     
  658.             // Update title.
  659.             this.setTitle();
  660.         }
  661.         return this.mPercent;
  662.     },
  663.  
  664.     // Update download rate and dialog display.
  665.     // Note that we don't want the displayed value to quiver
  666.     // between essentially identical values (e.g., 99.9Kb and
  667.     // 100.0Kb) so we only update if we see a big change.
  668.     setRate: function( rate ) {
  669.         if ( rate ) {
  670.             // rate is bytes/sec
  671.             var change = Math.abs( this.rate - rate );
  672.             // Don't update too often!
  673.             if ( change > this.rate / 10 ) {
  674.                 // Displayed rate changes.
  675.                 this.mRate = rate;
  676.             }
  677.         }
  678.         return this.mRate;
  679.     },
  680.  
  681.     // Handle download completion.
  682.     setCompleted: function() {
  683.         // If dialog hasn't loaded yet, defer this.
  684.         if ( !this.loaded ) {
  685.             this.dialog.setTimeout( function(obj){obj.setCompleted()}, 100, this );
  686.             return false;
  687.         }
  688.         if ( !this.mCompleted ) {
  689.             this.mCompleted = true;
  690.  
  691.             // If the "keep dialog open" box is checked, then update dialog.
  692.             if ( this.dialog && this.dialogElement( "keep" ).checked ) {
  693.                 // Indicate completion in status area.
  694.                 var string = this.getString( "completeMsg" );
  695.                 string = this.replaceInsert( string,
  696.                                              1,
  697.                                              this.formatSeconds( this.elapsed/1000 ) );
  698.                 string = this.replaceInsert( string,
  699.                                              2,
  700.                                              this.targetFile.fileSize >> 10 );
  701.  
  702.                 this.setValue( "status", string);
  703.                 // Put progress meter at 100%.
  704.                 this.percent = 100;
  705.  
  706.                 // Set time remaining to 00:00.
  707.                 this.setValue( "timeLeft", this.formatSeconds( 0 ) );
  708.  
  709.                 // Change Cancel button to Close, and give it focus.
  710.                 var cancelButton = this.dialogElement( "cancel" );
  711.                 cancelButton.label = this.getString( "close" );
  712.                 cancelButton.focus();
  713.  
  714.                 // Activate reveal/launch buttons if we enable them.
  715.                 var enableButtons = true;
  716.                 try {
  717.                   var prefs = Components.classes[ "@mozilla.org/preferences-service;1" ]
  718.                                   .getService( Components.interfaces.nsIPrefBranch );
  719.                   enableButtons = prefs.getBoolPref( "browser.download.progressDnldDialog.enable_launch_reveal_buttons" );
  720.                 } catch ( e ) {
  721.                 }
  722.  
  723.                 if ( enableButtons ) {
  724.                     this.enable( "reveal" );
  725.                     try {
  726.                         if ( this.targetFile != null ) {
  727.                             this.enable( "launch" );
  728.                         }
  729.                     } catch(e) {
  730.                     }
  731.                 }
  732.  
  733.                 // Disable the Pause/Resume buttons.
  734.                 this.dialogElement( "pauseResume" ).disabled = true;
  735.  
  736.                 // Fix up dialog layout (which gets messed up sometimes).
  737.                 this.dialog.sizeToContent();
  738.  
  739.                 // GetAttention to show the user that we're done
  740.                this.dialog.getAttention();
  741.             } else if ( this.dialog ) {
  742.                 this.dialog.close();
  743.             }
  744.         }
  745.         return this.mCompleted;
  746.     },
  747.  
  748.     // Set progress meter to given mode ("normal" or "undetermined").
  749.     setMode: function( newMode ) {
  750.         if ( this.mode != newMode ) {
  751.             // Need to update progress meter.
  752.             this.dialogElement( "progress" ).setAttribute( "mode", newMode );
  753.         }
  754.         return this.mMode = newMode;
  755.     },
  756.  
  757.     // Set pause/resume state.
  758.     setPaused: function( pausing ) {
  759.         // If state changing, then update stuff.
  760.         if ( this.paused != pausing ) {
  761.             var string = pausing ? "resume" : "pause";
  762.             this.dialogElement( "pauseResume" ).label = this.getString(string);
  763.  
  764.             // If we have a request, suspend/resume it.
  765.             if ( this.request ) {
  766.                 if ( pausing ) {
  767.                     this.request.suspend();
  768.                 } else {
  769.                     this.request.resume();
  770.                 }
  771.             }
  772.         }
  773.         return this.mPaused = pausing;
  774.     },
  775.  
  776.     // Convert raw rate (bytes/sec) to Kbytes/sec (to nearest tenth).
  777.     rateToKRate: function( rate ) {
  778.         return ( rate / 1024 ).toFixed(1);
  779.     },
  780.  
  781.     // Format number of seconds in hh:mm:ss form.
  782.     formatSeconds: function( secs ) {
  783.         // Round the number of seconds to remove fractions.
  784.         secs = parseInt( secs + .5 );
  785.         var hours = parseInt( secs/3600 );
  786.         secs -= hours*3600;
  787.         var mins = parseInt( secs/60 );
  788.         secs -= mins*60;
  789.         var result;
  790.         if ( hours )
  791.             result = this.getString( "longTimeFormat" );
  792.         else
  793.             result = this.getString( "shortTimeFormat" );
  794.     
  795.         if ( hours < 10 )
  796.             hours = "0" + hours;
  797.         if ( mins < 10 )
  798.             mins = "0" + mins;
  799.         if ( secs < 10 )
  800.             secs = "0" + secs;
  801.     
  802.         // Insert hours, minutes, and seconds into result string.
  803.         result = this.replaceInsert( result, 1, hours );
  804.         result = this.replaceInsert( result, 2, mins );
  805.         result = this.replaceInsert( result, 3, secs );
  806.     
  807.         return result;
  808.     },
  809.  
  810.     // Get dialog element using argument as id.
  811.     dialogElement: function( id ) {
  812.         // Check if we've already fetched it.
  813.         if ( !( id in this.fields ) ) {
  814.             // No, then get it from dialog.
  815.             try {
  816.                 this.fields[ id ] = this.dialog.document.getElementById( id );
  817.             } catch(e) {
  818.                 this.fields[ id ] = { 
  819.                     value: "",
  820.                     setAttribute: function(id,val) {},
  821.                     removeAttribute: function(id) {}
  822.                     }
  823.             }
  824.         }
  825.         return this.fields[ id ];
  826.     },
  827.  
  828.     // Set dialog element value for given dialog element.
  829.     setValue: function( id, val ) {
  830.         this.dialogElement( id ).value = val;
  831.     },
  832.  
  833.     // Enable dialgo element.
  834.     enable: function( field ) {
  835.         this.dialogElement( field ).removeAttribute( "disabled" );
  836.     },
  837.  
  838.     // Get localizable string from properties file.
  839.     getProperty: function( propertyId, strings, len ) {
  840.         if ( !this.mBundle ) {
  841.             this.mBundle = Components.classes[ "@mozilla.org/intl/stringbundle;1" ]
  842.                              .getService( Components.interfaces.nsIStringBundleService )
  843.                                .createBundle( "chrome://global/locale/nsProgressDialog.properties");
  844.         }
  845.         return this.mBundle.formatStringFromName( propertyId, strings, len );
  846.     },
  847.  
  848.     // Get localizable string (from dialog <data> elements).
  849.     getString: function ( stringId ) {
  850.         // Check if we've fetched this string already.
  851.         if ( !( this.strings && stringId in this.strings ) ) {
  852.             // Presume the string is empty if we can't get it.
  853.             this.strings[ stringId ] = "";
  854.             // Try to get it.
  855.             try {
  856.                 this.strings[ stringId ] = this.dialog.document.getElementById( "string."+stringId ).childNodes[0].nodeValue;
  857.             } catch (e) {}
  858.        }
  859.        return this.strings[ stringId ];
  860.     },
  861.     
  862.     // Replaces insert ("#n") with input text.
  863.     replaceInsert: function( text, index, value ) {
  864.         var result = text;
  865.         var regExp = new RegExp( "#"+index );
  866.         result = result.replace( regExp, value );
  867.         return result;
  868.     },
  869.  
  870.     // Hide a given dialog field.
  871.     hide: function( field ) {
  872.         this.dialogElement( field ).hidden = true;
  873.  
  874.         // Also hide any related separator element...
  875.         var sep = this.dialogElement( field+"Separator" );
  876.         if (sep)
  877.             sep.hidden = true;
  878.     },
  879.  
  880.     // Return input in hex, prepended with "0x" and leading zeros (to 8 digits).
  881.     hex: function( x ) {
  882.         return "0x" + ("0000000" + Number(x).toString(16)).slice(-8);
  883.     },
  884.  
  885.     // Dump text (if debug is on).
  886.     dump: function( text ) {
  887.         if ( this.debug ) {
  888.             dump( text );
  889.         }
  890.     }
  891. }
  892.  
  893. // This Component's module implementation.  All the code below is used to get this
  894. // component registered and accessible via XPCOM.
  895. var module = {
  896.     // registerSelf: Register this component.
  897.     registerSelf: function (compMgr, fileSpec, location, type) {
  898.         var compReg = compMgr.QueryInterface( Components.interfaces.nsIComponentRegistrar );
  899.         compReg.registerFactoryLocation( this.cid,
  900.                                          "Mozilla Download Progress Dialog",
  901.                                          this.contractId,
  902.                                          fileSpec,
  903.                                          location,
  904.                                          type );
  905.     },
  906.  
  907.     // getClassObject: Return this component's factory object.
  908.     getClassObject: function (compMgr, cid, iid) {
  909.         if (!cid.equals(this.cid))
  910.             throw Components.results.NS_ERROR_NO_INTERFACE;
  911.  
  912.         if (!iid.equals(Components.interfaces.nsIFactory))
  913.             throw Components.results.NS_ERROR_NOT_IMPLEMENTED;
  914.  
  915.         return this.factory;
  916.     },
  917.  
  918.     /* CID for this class */
  919.     cid: Components.ID("{F5D248FD-024C-4f30-B208-F3003B85BC92}"),
  920.  
  921.     /* Contract ID for this class */
  922.     contractId: "@mozilla.org/progressdialog;1",
  923.  
  924.     /* factory object */
  925.     factory: {
  926.         // createInstance: Return a new nsProgressDialog object.
  927.         createInstance: function (outer, iid) {
  928.             if (outer != null)
  929.                 throw Components.results.NS_ERROR_NO_AGGREGATION;
  930.  
  931.             return (new nsProgressDialog()).QueryInterface(iid);
  932.         }
  933.     },
  934.  
  935.     // canUnload: n/a (returns true)
  936.     canUnload: function(compMgr) {
  937.         return true;
  938.     }
  939. };
  940.  
  941. // NSGetModule: Return the nsIModule object.
  942. function NSGetModule(compMgr, fileSpec) {
  943.     return module;
  944. }
  945.