michael@0: /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0:  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0: 
michael@0: /**
michael@0:  * Provides utility functions for the download manager chrome tests.
michael@0:  */
michael@0: 
michael@0: const Cc = Components.classes;
michael@0: const Ci = Components.interfaces;
michael@0: const Cr = Components.results;
michael@0: 
michael@0: Components.utils.import("resource://gre/modules/Services.jsm");
michael@0: 
michael@0: /**
michael@0:  * Returns the toolkit implementation of the download manager UI service.
michael@0:  * If the toolkit implementation of the service can't be found (e.g. because
michael@0:  * SeaMonkey doesn't package that version but an own implementation that calls
michael@0:  * different UI), then returns false (see bug 483781).
michael@0:  *
michael@0:  * @returns toolkit's nsIDownloadManagerUI implementation or false if not found
michael@0:  */
michael@0: function getDMUI()
michael@0: {
michael@0:   try {
michael@0:     // This method throws an exception if the old Download Manager is disabled.
michael@0:     Services.downloads.activeDownloadCount;
michael@0:   } catch (ex) {
michael@0:     return false;
michael@0:   }
michael@0:   if (Components.classesByID["{7dfdf0d1-aff6-4a34-bad1-d0fe74601642}"])
michael@0:     return Components.classesByID["{7dfdf0d1-aff6-4a34-bad1-d0fe74601642}"].
michael@0:            getService(Ci.nsIDownloadManagerUI);
michael@0:   return false;
michael@0: }
michael@0: 
michael@0: /**
michael@0:  * Adds a live download to the download manager.
michael@0:  *
michael@0:  * @param [optional] aName
michael@0:  *        The name that will be assigned to the downloaded file.
michael@0:  * @returns an instance of nsIDownload.
michael@0:  */
michael@0: function addDownload(aName) {
michael@0:     function createURI(aObj) {
michael@0:       let ios = Cc["@mozilla.org/network/io-service;1"].
michael@0:                 getService(Ci.nsIIOService);
michael@0:       return (aObj instanceof Ci.nsIFile) ? ios.newFileURI(aObj) :
michael@0:                                             ios.newURI(aObj, null, null);
michael@0:     }
michael@0: 
michael@0:     function randomString() {
michael@0:       let chars = "ABCDEFGHIJKLMNOPQRSTUVWXTZabcdefghiklmnopqrstuvwxyz";
michael@0:       let string_length = 8;
michael@0:       let randomstring = "";
michael@0:       for (let i=0; i<string_length; i++) {
michael@0:         let rnum = Math.floor(Math.random() * chars.length);
michael@0:         randomstring += chars.substring(rnum, rnum+1);
michael@0:       }
michael@0:       return randomstring;
michael@0:     }
michael@0: 
michael@0:     let dm = Cc["@mozilla.org/download-manager;1"].
michael@0:              getService(Ci.nsIDownloadManager);
michael@0:     const nsIWBP = Ci.nsIWebBrowserPersist;
michael@0:     let persist = Cc["@mozilla.org/embedding/browser/nsWebBrowserPersist;1"]
michael@0:                   .createInstance(Ci.nsIWebBrowserPersist);
michael@0:     persist.persistFlags = nsIWBP.PERSIST_FLAGS_REPLACE_EXISTING_FILES |
michael@0:                            nsIWBP.PERSIST_FLAGS_BYPASS_CACHE |
michael@0:                            nsIWBP.PERSIST_FLAGS_AUTODETECT_APPLY_CONVERSION;
michael@0:     let dirSvc = Cc["@mozilla.org/file/directory_service;1"].
michael@0:                  getService(Ci.nsIProperties);
michael@0:     let dmFile = dirSvc.get("TmpD", Ci.nsIFile);
michael@0:     dmFile.append(aName || ("dm-test-file-" + randomString()));
michael@0:     if (dmFile.exists())
michael@0:       throw "Download file already exists";
michael@0:   
michael@0:     let dl = dm.addDownload(Ci.nsIDownloadManager.DOWNLOAD_TYPE_DOWNLOAD,
michael@0:                             createURI("http://example.com/httpd.js"),
michael@0:                             createURI(dmFile), null, null,
michael@0:                             Math.round(Date.now() * 1000), null, persist, false);
michael@0: 
michael@0:     let privacyContext = window.QueryInterface(Ci.nsIInterfaceRequestor)
michael@0:                                .getInterface(Ci.nsIWebNavigation)
michael@0:                                .QueryInterface(Ci.nsILoadContext);
michael@0: 
michael@0:     persist.progressListener = dl.QueryInterface(Ci.nsIWebProgressListener);
michael@0:     persist.saveURI(dl.source, null, null, null, null, dl.targetFile, privacyContext);
michael@0: 
michael@0:     return dl;
michael@0:   }
michael@0: 
michael@0: /**
michael@0:  * Used to populate the dm with dummy download data.
michael@0:  *
michael@0:  * @param aDownloadData
michael@0:  *        An array that contains the dummy download data to be added to the DM.
michael@0:  *        Expected fields are:
michael@0:  *          name, source, target, startTime, endTime, state, currBytes,
michael@0:  *          maxBytes, preferredAction, and autoResume
michael@0:  */
michael@0: function populateDM(DownloadData)
michael@0: {
michael@0:   let dm = Cc["@mozilla.org/download-manager;1"].
michael@0:            getService(Ci.nsIDownloadManager);
michael@0:   let db = dm.DBConnection;
michael@0: 
michael@0:   let stmt = db.createStatement(
michael@0:     "INSERT INTO moz_downloads (name, source, target, startTime, endTime, " +
michael@0:       "state, currBytes, maxBytes, preferredAction, autoResume) " +
michael@0:     "VALUES (:name, :source, :target, :startTime, :endTime, :state, " +
michael@0:       ":currBytes, :maxBytes, :preferredAction, :autoResume)");
michael@0:   for each (let dl in DownloadData) {
michael@0:     for (let prop in dl)
michael@0:       stmt.params[prop] = dl[prop];
michael@0: 
michael@0:     stmt.execute();
michael@0:   }
michael@0:   stmt.finalize();
michael@0: }
michael@0: 
michael@0: /**
michael@0:  * Returns an instance to the download manager window
michael@0:  *
michael@0:  * @return an instance of nsIDOMWindow
michael@0:  */
michael@0: function getDMWindow()
michael@0: {
michael@0:   return Cc["@mozilla.org/appshell/window-mediator;1"].
michael@0:          getService(Ci.nsIWindowMediator).
michael@0:          getMostRecentWindow("Download:Manager");
michael@0: }
michael@0: 
michael@0: /**
michael@0:  * Establishes a clean state to run a test in by removing everything from the
michael@0:  * database and ensuring that the download manager's window is not open.
michael@0:  */
michael@0: function setCleanState()
michael@0: {
michael@0:   let dm = Cc["@mozilla.org/download-manager;1"].
michael@0:            getService(Ci.nsIDownloadManager);
michael@0: 
michael@0:   // Clean the dm
michael@0:   dm.DBConnection.executeSimpleSQL("DELETE FROM moz_downloads");
michael@0: 
michael@0:   let win = getDMWindow();
michael@0:   if (win) win.close();
michael@0: }
michael@0: 
michael@0: /**
michael@0:  * Clears history invoking callback when done.
michael@0:  */
michael@0: function waitForClearHistory(aCallback) {
michael@0:   Components.utils.import("resource://gre/modules/PlacesUtils.jsm");
michael@0:   Services.obs.addObserver(function observeClearHistory(aSubject, aTopic) {
michael@0:     Services.obs.removeObserver(observeClearHistory, aTopic);
michael@0:     aCallback();
michael@0:   }, PlacesUtils.TOPIC_EXPIRATION_FINISHED, false);
michael@0:   PlacesUtils.bhistory.removeAllPages();
michael@0: }