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 file,
michael@0:  * You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0: 
michael@0: /**
michael@0:  * This file works on the old-style "bookmarks.html" file.  It includes
michael@0:  * functions to import and export existing bookmarks to this file format.
michael@0:  *
michael@0:  * Format
michael@0:  * ------
michael@0:  *
michael@0:  * Primary heading := h1
michael@0:  *   Old version used this to set attributes on the bookmarks RDF root, such
michael@0:  *   as the last modified date. We only use H1 to check for the attribute
michael@0:  *   PLACES_ROOT, which tells us that this hierarchy root is the places root.
michael@0:  *   For backwards compatibility, if we don't find this, we assume that the
michael@0:  *   hierarchy is rooted at the bookmarks menu.
michael@0:  * Heading := any heading other than h1
michael@0:  *   Old version used this to set attributes on the current container. We only
michael@0:  *   care about the content of the heading container, which contains the title
michael@0:  *   of the bookmark container.
michael@0:  * Bookmark := a
michael@0:  *   HREF is the destination of the bookmark
michael@0:  *   FEEDURL is the URI of the RSS feed if this is a livemark.
michael@0:  *   LAST_CHARSET is stored as an annotation so that the next time we go to
michael@0:  *     that page we remember the user's preference.
michael@0:  *   WEB_PANEL is set to "true" if the bookmark should be loaded in the sidebar.
michael@0:  *   ICON will be stored in the favicon service
michael@0:  *   ICON_URI is new for places bookmarks.html, it refers to the original
michael@0:  *     URI of the favicon so we don't have to make up favicon URLs.
michael@0:  *   Text of the <a> container is the name of the bookmark
michael@0:  *   Ignored: LAST_VISIT, ID (writing out non-RDF IDs can confuse Firefox 2)
michael@0:  * Bookmark comment := dd
michael@0:  *   This affects the previosly added bookmark
michael@0:  * Separator := hr
michael@0:  *   Insert a separator into the current container
michael@0:  * The folder hierarchy is defined by <dl>/<ul>/<menu> (the old importing code
michael@0:  *     handles all these cases, when we write, use <dl>).
michael@0:  *
michael@0:  * Overall design
michael@0:  * --------------
michael@0:  *
michael@0:  * We need to emulate a recursive parser. A "Bookmark import frame" is created
michael@0:  * corresponding to each folder we encounter. These are arranged in a stack,
michael@0:  * and contain all the state we need to keep track of.
michael@0:  *
michael@0:  * A frame is created when we find a heading, which defines a new container.
michael@0:  * The frame also keeps track of the nesting of <DL>s, (in well-formed
michael@0:  * bookmarks files, these will have a 1-1 correspondence with frames, but we
michael@0:  * try to be a little more flexible here). When the nesting count decreases
michael@0:  * to 0, then we know a frame is complete and to pop back to the previous
michael@0:  * frame.
michael@0:  *
michael@0:  * Note that a lot of things happen when tags are CLOSED because we need to
michael@0:  * get the text from the content of the tag. For example, link and heading tags
michael@0:  * both require the content (= title) before actually creating it.
michael@0:  */
michael@0: 
michael@0: this.EXPORTED_SYMBOLS = [ "BookmarkHTMLUtils" ];
michael@0: 
michael@0: const Ci = Components.interfaces;
michael@0: const Cc = Components.classes;
michael@0: const Cu = Components.utils;
michael@0: 
michael@0: Cu.import("resource://gre/modules/XPCOMUtils.jsm");
michael@0: Cu.import("resource://gre/modules/Services.jsm");
michael@0: Cu.import("resource://gre/modules/NetUtil.jsm");
michael@0: Cu.import("resource://gre/modules/osfile.jsm");
michael@0: Cu.import("resource://gre/modules/FileUtils.jsm");
michael@0: Cu.import("resource://gre/modules/PlacesUtils.jsm");
michael@0: Cu.import("resource://gre/modules/Promise.jsm");
michael@0: Cu.import("resource://gre/modules/Task.jsm");
michael@0: 
michael@0: XPCOMUtils.defineLazyModuleGetter(this, "PlacesBackups",
michael@0:   "resource://gre/modules/PlacesBackups.jsm");
michael@0: XPCOMUtils.defineLazyModuleGetter(this, "Deprecated",
michael@0:   "resource://gre/modules/Deprecated.jsm");
michael@0: 
michael@0: const Container_Normal = 0;
michael@0: const Container_Toolbar = 1;
michael@0: const Container_Menu = 2;
michael@0: const Container_Unfiled = 3;
michael@0: const Container_Places = 4;
michael@0: 
michael@0: const LOAD_IN_SIDEBAR_ANNO = "bookmarkProperties/loadInSidebar";
michael@0: const DESCRIPTION_ANNO = "bookmarkProperties/description";
michael@0: 
michael@0: const MICROSEC_PER_SEC = 1000000;
michael@0: 
michael@0: const EXPORT_INDENT = "    "; // four spaces
michael@0: 
michael@0: // Counter used to build fake favicon urls.
michael@0: let serialNumber = 0;
michael@0: 
michael@0: function base64EncodeString(aString) {
michael@0:   let stream = Cc["@mozilla.org/io/string-input-stream;1"]
michael@0:                  .createInstance(Ci.nsIStringInputStream);
michael@0:   stream.setData(aString, aString.length);
michael@0:   let encoder = Cc["@mozilla.org/scriptablebase64encoder;1"]
michael@0:                   .createInstance(Ci.nsIScriptableBase64Encoder);
michael@0:   return encoder.encodeToString(stream, aString.length);
michael@0: }
michael@0: 
michael@0: /**
michael@0:  * Provides HTML escaping for use in HTML attributes and body of the bookmarks
michael@0:  * file, compatible with the old bookmarks system.
michael@0:  */
michael@0: function escapeHtmlEntities(aText) {
michael@0:   return (aText || "").replace("&", "&amp;", "g")
michael@0:                       .replace("<", "&lt;", "g")
michael@0:                       .replace(">", "&gt;", "g")
michael@0:                       .replace("\"", "&quot;", "g")
michael@0:                       .replace("'", "&#39;", "g");
michael@0: }
michael@0: 
michael@0: /**
michael@0:  * Provides URL escaping for use in HTML attributes of the bookmarks file,
michael@0:  * compatible with the old bookmarks system.
michael@0:  */
michael@0: function escapeUrl(aText) {
michael@0:   return (aText || "").replace("\"", "%22", "g");
michael@0: }
michael@0: 
michael@0: function notifyObservers(aTopic, aInitialImport) {
michael@0:   Services.obs.notifyObservers(null, aTopic, aInitialImport ? "html-initial"
michael@0:                                                             : "html");
michael@0: }
michael@0: 
michael@0: function promiseSoon() {
michael@0:   let deferred = Promise.defer();
michael@0:   Services.tm.mainThread.dispatch(deferred.resolve,
michael@0:                                   Ci.nsIThread.DISPATCH_NORMAL);
michael@0:   return deferred.promise;
michael@0: }
michael@0: 
michael@0: this.BookmarkHTMLUtils = Object.freeze({
michael@0:   /**
michael@0:    * Loads the current bookmarks hierarchy from a "bookmarks.html" file.
michael@0:    *
michael@0:    * @param aSpec
michael@0:    *        String containing the "file:" URI for the existing "bookmarks.html"
michael@0:    *        file to be loaded.
michael@0:    * @param aInitialImport
michael@0:    *        Whether this is the initial import executed on a new profile.
michael@0:    *
michael@0:    * @return {Promise}
michael@0:    * @resolves When the new bookmarks have been created.
michael@0:    * @rejects JavaScript exception.
michael@0:    */
michael@0:   importFromURL: function BHU_importFromURL(aSpec, aInitialImport) {
michael@0:     return Task.spawn(function* () {
michael@0:       notifyObservers(PlacesUtils.TOPIC_BOOKMARKS_RESTORE_BEGIN, aInitialImport);
michael@0:       try {
michael@0:         let importer = new BookmarkImporter(aInitialImport);
michael@0:         yield importer.importFromURL(aSpec);
michael@0: 
michael@0:         notifyObservers(PlacesUtils.TOPIC_BOOKMARKS_RESTORE_SUCCESS, aInitialImport);
michael@0:       } catch(ex) {
michael@0:         Cu.reportError("Failed to import bookmarks from " + aSpec + ": " + ex);
michael@0:         notifyObservers(PlacesUtils.TOPIC_BOOKMARKS_RESTORE_FAILED, aInitialImport);
michael@0:         throw ex;
michael@0:       }
michael@0:     });
michael@0:   },
michael@0: 
michael@0:   /**
michael@0:    * Loads the current bookmarks hierarchy from a "bookmarks.html" file.
michael@0:    *
michael@0:    * @param aFilePath
michael@0:    *        OS.File path string of the "bookmarks.html" file to be loaded.
michael@0:    * @param aInitialImport
michael@0:    *        Whether this is the initial import executed on a new profile.
michael@0:    *
michael@0:    * @return {Promise}
michael@0:    * @resolves When the new bookmarks have been created.
michael@0:    * @rejects JavaScript exception.
michael@0:    * @deprecated passing an nsIFile is deprecated
michael@0:    */
michael@0:   importFromFile: function BHU_importFromFile(aFilePath, aInitialImport) {
michael@0:     if (aFilePath instanceof Ci.nsIFile) {
michael@0:       Deprecated.warning("Passing an nsIFile to BookmarksJSONUtils.importFromFile " +
michael@0:                          "is deprecated. Please use an OS.File path string instead.",
michael@0:                          "https://developer.mozilla.org/docs/JavaScript_OS.File");
michael@0:       aFilePath = aFilePath.path;
michael@0:     }
michael@0: 
michael@0:     return Task.spawn(function* () {
michael@0:       notifyObservers(PlacesUtils.TOPIC_BOOKMARKS_RESTORE_BEGIN, aInitialImport);
michael@0:       try {
michael@0:         if (!(yield OS.File.exists(aFilePath)))
michael@0:           throw new Error("Cannot import from nonexisting html file");
michael@0: 
michael@0:         let importer = new BookmarkImporter(aInitialImport);
michael@0:         yield importer.importFromURL(OS.Path.toFileURI(aFilePath));
michael@0: 
michael@0:         notifyObservers(PlacesUtils.TOPIC_BOOKMARKS_RESTORE_SUCCESS, aInitialImport);
michael@0:       } catch(ex) {
michael@0:         Cu.reportError("Failed to import bookmarks from " + aFilePath + ": " + ex);
michael@0:         notifyObservers(PlacesUtils.TOPIC_BOOKMARKS_RESTORE_FAILED, aInitialImport);
michael@0:         throw ex;
michael@0:       }
michael@0:     });
michael@0:   },
michael@0: 
michael@0:   /**
michael@0:    * Saves the current bookmarks hierarchy to a "bookmarks.html" file.
michael@0:    *
michael@0:    * @param aFilePath
michael@0:    *        OS.File path string for the "bookmarks.html" file to be created.
michael@0:    *
michael@0:    * @return {Promise}
michael@0:    * @resolves To the exported bookmarks count when the file has been created.
michael@0:    * @rejects JavaScript exception.
michael@0:    * @deprecated passing an nsIFile is deprecated
michael@0:    */
michael@0:   exportToFile: function BHU_exportToFile(aFilePath) {
michael@0:     if (aFilePath instanceof Ci.nsIFile) {
michael@0:       Deprecated.warning("Passing an nsIFile to BookmarksHTMLUtils.exportToFile " +
michael@0:                          "is deprecated. Please use an OS.File path string instead.",
michael@0:                          "https://developer.mozilla.org/docs/JavaScript_OS.File");
michael@0:       aFilePath = aFilePath.path;
michael@0:     }
michael@0:     return Task.spawn(function* () {
michael@0:       let [bookmarks, count] = yield PlacesBackups.getBookmarksTree();
michael@0:       let startTime = Date.now();
michael@0: 
michael@0:       // Report the time taken to convert the tree to HTML.
michael@0:       let exporter = new BookmarkExporter(bookmarks);
michael@0:       yield exporter.exportToFile(aFilePath);
michael@0: 
michael@0:       try {
michael@0:         Services.telemetry
michael@0:                 .getHistogramById("PLACES_EXPORT_TOHTML_MS")
michael@0:                 .add(Date.now() - startTime);
michael@0:       } catch (ex) {
michael@0:         Components.utils.reportError("Unable to report telemetry.");
michael@0:       }
michael@0: 
michael@0:       return count;
michael@0:     });
michael@0:   },
michael@0: 
michael@0:   get defaultPath() {
michael@0:     try {
michael@0:       return Services.prefs.getCharPref("browser.bookmarks.file");
michael@0:     } catch (ex) {}
michael@0:     return OS.Path.join(OS.Constants.Path.profileDir, "bookmarks.html")
michael@0:   }
michael@0: });
michael@0: 
michael@0: function Frame(aFrameId) {
michael@0:   this.containerId = aFrameId;
michael@0: 
michael@0:   /**
michael@0:    * How many <dl>s have been nested. Each frame/container should start
michael@0:    * with a heading, and is then followed by a <dl>, <ul>, or <menu>. When
michael@0:    * that list is complete, then it is the end of this container and we need
michael@0:    * to pop back up one level for new items. If we never get an open tag for
michael@0:    * one of these things, we should assume that the container is empty and
michael@0:    * that things we find should be siblings of it. Normally, these <dl>s won't
michael@0:    * be nested so this will be 0 or 1.
michael@0:    */
michael@0:   this.containerNesting = 0;
michael@0: 
michael@0:   /**
michael@0:    * when we find a heading tag, it actually affects the title of the NEXT
michael@0:    * container in the list. This stores that heading tag and whether it was
michael@0:    * special. 'consumeHeading' resets this._
michael@0:    */
michael@0:   this.lastContainerType = Container_Normal;
michael@0: 
michael@0:   /**
michael@0:    * this contains the text from the last begin tag until now. It is reset
michael@0:    * at every begin tag. We can check it when we see a </a>, or </h3>
michael@0:    * to see what the text content of that node should be.
michael@0:    */
michael@0:   this.previousText = "";
michael@0: 
michael@0:   /**
michael@0:    * true when we hit a <dd>, which contains the description for the preceding
michael@0:    * <a> tag. We can't just check for </dd> like we can for </a> or </h3>
michael@0:    * because if there is a sub-folder, it is actually a child of the <dd>
michael@0:    * because the tag is never explicitly closed. If this is true and we see a
michael@0:    * new open tag, that means to commit the description to the previous
michael@0:    * bookmark.
michael@0:    *
michael@0:    * Additional weirdness happens when the previous <dt> tag contains a <h3>:
michael@0:    * this means there is a new folder with the given description, and whose
michael@0:    * children are contained in the following <dl> list.
michael@0:    *
michael@0:    * This is handled in openContainer(), which commits previous text if
michael@0:    * necessary.
michael@0:    */
michael@0:   this.inDescription = false;
michael@0: 
michael@0:   /**
michael@0:    * contains the URL of the previous bookmark created. This is used so that
michael@0:    * when we encounter a <dd>, we know what bookmark to associate the text with.
michael@0:    * This is cleared whenever we hit a <h3>, so that we know NOT to save this
michael@0:    * with a bookmark, but to keep it until 
michael@0:    */
michael@0:   this.previousLink = null; // nsIURI
michael@0: 
michael@0:   /**
michael@0:    * contains the URL of the previous livemark, so that when the link ends,
michael@0:    * and the livemark title is known, we can create it.
michael@0:    */
michael@0:   this.previousFeed = null; // nsIURI
michael@0: 
michael@0:   /**
michael@0:    * Contains the id of an imported, or newly created bookmark.
michael@0:    */
michael@0:   this.previousId = 0;
michael@0: 
michael@0:   /**
michael@0:    * Contains the date-added and last-modified-date of an imported item.
michael@0:    * Used to override the values set by insertBookmark, createFolder, etc.
michael@0:    */
michael@0:   this.previousDateAdded = 0;
michael@0:   this.previousLastModifiedDate = 0;
michael@0: }
michael@0: 
michael@0: function BookmarkImporter(aInitialImport) {
michael@0:   this._isImportDefaults = aInitialImport;
michael@0:   this._frames = new Array();
michael@0:   this._frames.push(new Frame(PlacesUtils.bookmarksMenuFolderId));
michael@0: }
michael@0: 
michael@0: BookmarkImporter.prototype = {
michael@0: 
michael@0:   _safeTrim: function safeTrim(aStr) {
michael@0:     return aStr ? aStr.trim() : aStr;
michael@0:   },
michael@0: 
michael@0:   get _curFrame() {
michael@0:     return this._frames[this._frames.length - 1];
michael@0:   },
michael@0: 
michael@0:   get _previousFrame() {
michael@0:     return this._frames[this._frames.length - 2];
michael@0:   },
michael@0: 
michael@0:   /**
michael@0:    * This is called when there is a new folder found. The folder takes the
michael@0:    * name from the previous frame's heading.
michael@0:    */
michael@0:   _newFrame: function newFrame() {
michael@0:     let containerId = -1;
michael@0:     let frame = this._curFrame;
michael@0:     let containerTitle = frame.previousText;
michael@0:     frame.previousText = "";
michael@0:     let containerType = frame.lastContainerType;
michael@0: 
michael@0:     switch (containerType) {
michael@0:       case Container_Normal:
michael@0:         // append a new folder
michael@0:         containerId = 
michael@0:           PlacesUtils.bookmarks.createFolder(frame.containerId,
michael@0:                                              containerTitle,
michael@0:                                              PlacesUtils.bookmarks.DEFAULT_INDEX);
michael@0:         break;
michael@0:       case Container_Places:
michael@0:         containerId = PlacesUtils.placesRootId;
michael@0:         break;
michael@0:       case Container_Menu:
michael@0:         containerId = PlacesUtils.bookmarksMenuFolderId;
michael@0:         break;
michael@0:       case Container_Unfiled:
michael@0:         containerId = PlacesUtils.unfiledBookmarksFolderId;
michael@0:         break;
michael@0:       case Container_Toolbar:
michael@0:         containerId = PlacesUtils.toolbarFolderId;
michael@0:         break;
michael@0:       default:
michael@0:         // NOT REACHED
michael@0:         throw new Error("Unreached");
michael@0:     }
michael@0: 
michael@0:     if (frame.previousDateAdded > 0) {
michael@0:       try {
michael@0:         PlacesUtils.bookmarks.setItemDateAdded(containerId, frame.previousDateAdded);
michael@0:       } catch(e) {
michael@0:       }
michael@0:       frame.previousDateAdded = 0;
michael@0:     }
michael@0:     if (frame.previousLastModifiedDate > 0) {
michael@0:       try {
michael@0:         PlacesUtils.bookmarks.setItemLastModified(containerId, frame.previousLastModifiedDate);
michael@0:       } catch(e) {
michael@0:       }
michael@0:       // don't clear last-modified, in case there's a description
michael@0:     }
michael@0: 
michael@0:     frame.previousId = containerId;
michael@0: 
michael@0:     this._frames.push(new Frame(containerId));
michael@0:   },
michael@0: 
michael@0:   /**
michael@0:    * Handles <hr> as a separator.
michael@0:    *
michael@0:    * @note Separators may have a title in old html files, though Places dropped
michael@0:    *       support for them.
michael@0:    *       We also don't import ADD_DATE or LAST_MODIFIED for separators because
michael@0:    *       pre-Places bookmarks did not support them.
michael@0:    */
michael@0:   _handleSeparator: function handleSeparator(aElt) {
michael@0:     let frame = this._curFrame;
michael@0:     try {
michael@0:       frame.previousId =
michael@0:         PlacesUtils.bookmarks.insertSeparator(frame.containerId,
michael@0:                                               PlacesUtils.bookmarks.DEFAULT_INDEX);
michael@0:     } catch(e) {}
michael@0:   },
michael@0: 
michael@0:   /**
michael@0:    * Handles <H1>. We check for the attribute PLACES_ROOT and reset the
michael@0:    * container id if it's found. Otherwise, the default bookmark menu
michael@0:    * root is assumed and imported things will go into the bookmarks menu.
michael@0:    */
michael@0:   _handleHead1Begin: function handleHead1Begin(aElt) {
michael@0:     if (this._frames.length > 1) {
michael@0:       return;
michael@0:     }
michael@0:     if (aElt.hasAttribute("places_root")) {
michael@0:       this._curFrame.containerId = PlacesUtils.placesRootId;
michael@0:     }
michael@0:   },
michael@0: 
michael@0:   /**
michael@0:    * Called for h2,h3,h4,h5,h6. This just stores the correct information in
michael@0:    * the current frame; the actual new frame corresponding to the container
michael@0:    * associated with the heading will be created when the tag has been closed
michael@0:    * and we know the title (we don't know to create a new folder or to merge
michael@0:    * with an existing one until we have the title).
michael@0:    */
michael@0:   _handleHeadBegin: function handleHeadBegin(aElt) {
michael@0:     let frame = this._curFrame;
michael@0: 
michael@0:     // after a heading, a previous bookmark is not applicable (for example, for
michael@0:     // the descriptions contained in a <dd>). Neither is any previous head type
michael@0:     frame.previousLink = null;
michael@0:     frame.lastContainerType = Container_Normal;
michael@0: 
michael@0:     // It is syntactically possible for a heading to appear after another heading
michael@0:     // but before the <dl> that encloses that folder's contents.  This should not
michael@0:     // happen in practice, as the file will contain "<dl></dl>" sequence for
michael@0:     // empty containers.
michael@0:     //
michael@0:     // Just to be on the safe side, if we encounter
michael@0:     //   <h3>FOO</h3>
michael@0:     //   <h3>BAR</h3>
michael@0:     //   <dl>...content 1...</dl>
michael@0:     //   <dl>...content 2...</dl>
michael@0:     // we'll pop the stack when we find the h3 for BAR, treating that as an
michael@0:     // implicit ending of the FOO container. The output will be FOO and BAR as
michael@0:     // siblings. If there's another <dl> following (as in "content 2"), those
michael@0:     // items will be treated as further siblings of FOO and BAR
michael@0:     // This special frame popping business, of course, only happens when our
michael@0:     // frame array has more than one element so we can avoid situations where
michael@0:     // we don't have a frame to parse into anymore.
michael@0:     if (frame.containerNesting == 0 && this._frames.length > 1) {
michael@0:       this._frames.pop();
michael@0:     }
michael@0: 
michael@0:     // We have to check for some attributes to see if this is a "special"
michael@0:     // folder, which will have different creation rules when the end tag is
michael@0:     // processed.
michael@0:     if (aElt.hasAttribute("personal_toolbar_folder")) {
michael@0:       if (this._isImportDefaults) {
michael@0:         frame.lastContainerType = Container_Toolbar;
michael@0:       }
michael@0:     } else if (aElt.hasAttribute("bookmarks_menu")) {
michael@0:       if (this._isImportDefaults) {
michael@0:         frame.lastContainerType = Container_Menu;
michael@0:       }
michael@0:     } else if (aElt.hasAttribute("unfiled_bookmarks_folder")) {
michael@0:       if (this._isImportDefaults) {
michael@0:         frame.lastContainerType = Container_Unfiled;
michael@0:       }
michael@0:     } else if (aElt.hasAttribute("places_root")) {
michael@0:       if (this._isImportDefaults) {
michael@0:         frame.lastContainerType = Container_Places;
michael@0:       }
michael@0:     } else {
michael@0:       let addDate = aElt.getAttribute("add_date");
michael@0:       if (addDate) {
michael@0:         frame.previousDateAdded =
michael@0:           this._convertImportedDateToInternalDate(addDate);
michael@0:       }
michael@0:       let modDate = aElt.getAttribute("last_modified");
michael@0:       if (modDate) {
michael@0:         frame.previousLastModifiedDate =
michael@0:           this._convertImportedDateToInternalDate(modDate);
michael@0:       }
michael@0:     }
michael@0:     this._curFrame.previousText = "";
michael@0:   },
michael@0: 
michael@0:   /*
michael@0:    * Handles "<a" tags by creating a new bookmark. The title of the bookmark
michael@0:    * will be the text content, which will be stuffed in previousText for us
michael@0:    * and which will be saved by handleLinkEnd
michael@0:    */
michael@0:   _handleLinkBegin: function handleLinkBegin(aElt) {
michael@0:     let frame = this._curFrame;
michael@0: 
michael@0:     // Make sure that the feed URIs from previous frames are emptied.
michael@0:     frame.previousFeed = null;
michael@0:     // Make sure that the bookmark id from previous frames are emptied.
michael@0:     frame.previousId = 0;
michael@0:     // mPreviousText will hold link text, clear it.
michael@0:     frame.previousText = "";
michael@0: 
michael@0:     // Get the attributes we care about.
michael@0:     let href = this._safeTrim(aElt.getAttribute("href"));
michael@0:     let feedUrl = this._safeTrim(aElt.getAttribute("feedurl"));
michael@0:     let icon = this._safeTrim(aElt.getAttribute("icon"));
michael@0:     let iconUri = this._safeTrim(aElt.getAttribute("icon_uri"));
michael@0:     let lastCharset = this._safeTrim(aElt.getAttribute("last_charset"));
michael@0:     let keyword = this._safeTrim(aElt.getAttribute("shortcuturl"));
michael@0:     let postData = this._safeTrim(aElt.getAttribute("post_data"));
michael@0:     let webPanel = this._safeTrim(aElt.getAttribute("web_panel"));
michael@0:     let micsumGenURI = this._safeTrim(aElt.getAttribute("micsum_gen_uri"));
michael@0:     let generatedTitle = this._safeTrim(aElt.getAttribute("generated_title"));
michael@0:     let dateAdded = this._safeTrim(aElt.getAttribute("add_date"));
michael@0:     let lastModified = this._safeTrim(aElt.getAttribute("last_modified"));
michael@0: 
michael@0:     // For feeds, get the feed URL.  If it is invalid, mPreviousFeed will be
michael@0:     // NULL and we'll create it as a normal bookmark.
michael@0:     if (feedUrl) {
michael@0:       frame.previousFeed = NetUtil.newURI(feedUrl);
michael@0:     }
michael@0: 
michael@0:     // Ignore <a> tags that have no href.
michael@0:     if (href) {
michael@0:       // Save the address if it's valid.  Note that we ignore errors if this is a
michael@0:       // feed since href is optional for them.
michael@0:       try {
michael@0:         frame.previousLink = NetUtil.newURI(href);
michael@0:       } catch(e) {
michael@0:         if (!frame.previousFeed) {
michael@0:           frame.previousLink = null;
michael@0:           return;
michael@0:         }
michael@0:       }
michael@0:     } else {
michael@0:       frame.previousLink = null;
michael@0:       // The exception is for feeds, where the href is an optional component
michael@0:       // indicating the source web site.
michael@0:       if (!frame.previousFeed) {
michael@0:         return;
michael@0:       }
michael@0:     }
michael@0: 
michael@0:     // Save bookmark's last modified date.
michael@0:     if (lastModified) {
michael@0:       frame.previousLastModifiedDate =
michael@0:         this._convertImportedDateToInternalDate(lastModified);
michael@0:     }
michael@0: 
michael@0:     // If this is a live bookmark, we will handle it in HandleLinkEnd(), so we
michael@0:     // can skip bookmark creation.
michael@0:     if (frame.previousFeed) {
michael@0:       return;
michael@0:     }
michael@0: 
michael@0:     // Create the bookmark.  The title is unknown for now, we will set it later.
michael@0:     try {
michael@0:       frame.previousId =
michael@0:         PlacesUtils.bookmarks.insertBookmark(frame.containerId,
michael@0:                                              frame.previousLink,
michael@0:                                              PlacesUtils.bookmarks.DEFAULT_INDEX,
michael@0:                                              "");
michael@0:     } catch(e) {
michael@0:       return;
michael@0:     }
michael@0: 
michael@0:     // Set the date added value, if we have it.
michael@0:     if (dateAdded) {
michael@0:       try {
michael@0:         PlacesUtils.bookmarks.setItemDateAdded(frame.previousId,
michael@0:           this._convertImportedDateToInternalDate(dateAdded));
michael@0:       } catch(e) {
michael@0:       }
michael@0:     }
michael@0: 
michael@0:     // Save the favicon.
michael@0:     if (icon || iconUri) {
michael@0:       let iconUriObject;
michael@0:       try {
michael@0:         iconUriObject = NetUtil.newURI(iconUri);
michael@0:       } catch(e) {
michael@0:       }
michael@0:       if (icon || iconUriObject) {
michael@0:         try {
michael@0:           this._setFaviconForURI(frame.previousLink, iconUriObject, icon);
michael@0:         } catch(e) {
michael@0:         }
michael@0:       }
michael@0:     }
michael@0: 
michael@0:     // Save the keyword.
michael@0:     if (keyword) {
michael@0:       try {
michael@0:         PlacesUtils.bookmarks.setKeywordForBookmark(frame.previousId, keyword);
michael@0:         if (postData) {
michael@0:           PlacesUtils.annotations.setItemAnnotation(frame.previousId,
michael@0:                                                     PlacesUtils.POST_DATA_ANNO,
michael@0:                                                     postData,
michael@0:                                                     0,
michael@0:                                                     PlacesUtils.annotations.EXPIRE_NEVER);
michael@0:         }
michael@0:       } catch(e) {
michael@0:       }
michael@0:     }
michael@0: 
michael@0:     // Set load-in-sidebar annotation for the bookmark.
michael@0:     if (webPanel && webPanel.toLowerCase() == "true") {
michael@0:       try {
michael@0:         PlacesUtils.annotations.setItemAnnotation(frame.previousId,
michael@0:                                                   LOAD_IN_SIDEBAR_ANNO,
michael@0:                                                   1,
michael@0:                                                   0,
michael@0:                                                   PlacesUtils.annotations.EXPIRE_NEVER);
michael@0:       } catch(e) {
michael@0:       }
michael@0:     }
michael@0: 
michael@0:     // Import last charset.
michael@0:     if (lastCharset) {
michael@0:       PlacesUtils.setCharsetForURI(frame.previousLink, lastCharset);
michael@0:     }
michael@0:   },
michael@0: 
michael@0:   _handleContainerBegin: function handleContainerBegin() {
michael@0:     this._curFrame.containerNesting++;
michael@0:   },
michael@0: 
michael@0:   /**
michael@0:    * Our "indent" count has decreased, and when we hit 0 that means that this
michael@0:    * container is complete and we need to pop back to the outer frame. Never
michael@0:    * pop the toplevel frame
michael@0:    */
michael@0:   _handleContainerEnd: function handleContainerEnd() {
michael@0:     let frame = this._curFrame;
michael@0:     if (frame.containerNesting > 0)
michael@0:       frame.containerNesting --;
michael@0:     if (this._frames.length > 1 && frame.containerNesting == 0) {
michael@0:       // we also need to re-set the imported last-modified date here. Otherwise
michael@0:       // the addition of items will override the imported field.
michael@0:       let prevFrame = this._previousFrame;
michael@0:       if (prevFrame.previousLastModifiedDate > 0) {
michael@0:         PlacesUtils.bookmarks.setItemLastModified(frame.containerId,
michael@0:                                                   prevFrame.previousLastModifiedDate);
michael@0:       }
michael@0:       this._frames.pop();
michael@0:     }
michael@0:   },
michael@0: 
michael@0:   /**
michael@0:    * Creates the new frame for this heading now that we know the name of the
michael@0:    * container (tokens since the heading open tag will have been placed in
michael@0:    * previousText).
michael@0:    */
michael@0:   _handleHeadEnd: function handleHeadEnd() {
michael@0:     this._newFrame();
michael@0:   },
michael@0: 
michael@0:   /**
michael@0:    * Saves the title for the given bookmark.
michael@0:    */
michael@0:   _handleLinkEnd: function handleLinkEnd() {
michael@0:     let frame = this._curFrame;
michael@0:     frame.previousText = frame.previousText.trim();
michael@0: 
michael@0:     try {
michael@0:       if (frame.previousFeed) {
michael@0:         // The is a live bookmark.  We create it here since in HandleLinkBegin we
michael@0:         // don't know the title.
michael@0:         PlacesUtils.livemarks.addLivemark({
michael@0:           "title": frame.previousText,
michael@0:           "parentId": frame.containerId,
michael@0:           "index": PlacesUtils.bookmarks.DEFAULT_INDEX,
michael@0:           "feedURI": frame.previousFeed,
michael@0:           "siteURI": frame.previousLink,
michael@0:         }).then(null, Cu.reportError);
michael@0:       } else if (frame.previousLink) {
michael@0:         // This is a common bookmark.
michael@0:         PlacesUtils.bookmarks.setItemTitle(frame.previousId,
michael@0:                                            frame.previousText);
michael@0:       }
michael@0:     } catch(e) {
michael@0:     }
michael@0: 
michael@0: 
michael@0:     // Set last modified date as the last change.
michael@0:     if (frame.previousId > 0 && frame.previousLastModifiedDate > 0) {
michael@0:       try {
michael@0:         PlacesUtils.bookmarks.setItemLastModified(frame.previousId,
michael@0:                                                   frame.previousLastModifiedDate);
michael@0:       } catch(e) {
michael@0:       }
michael@0:       // Note: don't clear previousLastModifiedDate, because if this item has a
michael@0:       // description, we'll need to set it again.
michael@0:     }
michael@0: 
michael@0:     frame.previousText = "";
michael@0: 
michael@0:   },
michael@0: 
michael@0:   _openContainer: function openContainer(aElt) {
michael@0:     if (aElt.namespaceURI != "http://www.w3.org/1999/xhtml") {
michael@0:       return;
michael@0:     }
michael@0:     switch(aElt.localName) {
michael@0:       case "h1":
michael@0:         this._handleHead1Begin(aElt);
michael@0:         break;
michael@0:       case "h2":
michael@0:       case "h3":
michael@0:       case "h4":
michael@0:       case "h5":
michael@0:       case "h6":
michael@0:         this._handleHeadBegin(aElt);
michael@0:         break;
michael@0:       case "a":
michael@0:         this._handleLinkBegin(aElt);
michael@0:         break;
michael@0:       case "dl":
michael@0:       case "ul":
michael@0:       case "menu":
michael@0:         this._handleContainerBegin();
michael@0:         break;
michael@0:       case "dd":
michael@0:         this._curFrame.inDescription = true;
michael@0:         break;
michael@0:       case "hr":
michael@0:         this._handleSeparator(aElt);
michael@0:         break;
michael@0:     }
michael@0:   },
michael@0: 
michael@0:   _closeContainer: function closeContainer(aElt) {
michael@0:     let frame = this._curFrame;
michael@0: 
michael@0:     // see the comment for the definition of inDescription. Basically, we commit
michael@0:     // any text in previousText to the description of the node/folder if there
michael@0:     // is any.
michael@0:     if (frame.inDescription) {
michael@0:       // NOTE ES5 trim trims more than the previous C++ trim.
michael@0:       frame.previousText = frame.previousText.trim(); // important
michael@0:       if (frame.previousText) {
michael@0: 
michael@0:         let itemId = !frame.previousLink ? frame.containerId
michael@0:                                          : frame.previousId;
michael@0: 
michael@0:         try {
michael@0:           if (!PlacesUtils.annotations.itemHasAnnotation(itemId, DESCRIPTION_ANNO)) {
michael@0:             PlacesUtils.annotations.setItemAnnotation(itemId,
michael@0:                                                       DESCRIPTION_ANNO,
michael@0:                                                       frame.previousText,
michael@0:                                                       0,
michael@0:                                                       PlacesUtils.annotations.EXPIRE_NEVER);
michael@0:           }
michael@0:         } catch(e) {
michael@0:         }
michael@0:         frame.previousText = "";
michael@0: 
michael@0:         // Set last-modified a 2nd time for all items with descriptions
michael@0:         // we need to set last-modified as the *last* step in processing 
michael@0:         // any item type in the bookmarks.html file, so that we do
michael@0:         // not overwrite the imported value. for items without descriptions, 
michael@0:         // setting this value after setting the item title is that 
michael@0:         // last point at which we can save this value before it gets reset.
michael@0:         // for items with descriptions, it must set after that point.
michael@0:         // however, at the point at which we set the title, there's no way 
michael@0:         // to determine if there will be a description following, 
michael@0:         // so we need to set the last-modified-date at both places.
michael@0: 
michael@0:         let lastModified;
michael@0:         if (!frame.previousLink) {
michael@0:           lastModified = this._previousFrame.previousLastModifiedDate;
michael@0:         } else {
michael@0:           lastModified = frame.previousLastModifiedDate;
michael@0:         }
michael@0: 
michael@0:         if (itemId > 0 && lastModified > 0) {
michael@0:           PlacesUtils.bookmarks.setItemLastModified(itemId, lastModified);
michael@0:         }
michael@0:       }
michael@0:       frame.inDescription = false;
michael@0:     }
michael@0: 
michael@0:     if (aElt.namespaceURI != "http://www.w3.org/1999/xhtml") {
michael@0:       return;
michael@0:     }
michael@0:     switch(aElt.localName) {
michael@0:       case "dl":
michael@0:       case "ul":
michael@0:       case "menu":
michael@0:         this._handleContainerEnd();
michael@0:         break;
michael@0:       case "dt":
michael@0:         break;
michael@0:       case "h1":
michael@0:         // ignore
michael@0:         break;
michael@0:       case "h2":
michael@0:       case "h3":
michael@0:       case "h4":
michael@0:       case "h5":
michael@0:       case "h6":
michael@0:         this._handleHeadEnd();
michael@0:         break;
michael@0:       case "a":
michael@0:         this._handleLinkEnd();
michael@0:         break;
michael@0:       default:
michael@0:         break;
michael@0:     }
michael@0:   },
michael@0: 
michael@0:   _appendText: function appendText(str) {
michael@0:     this._curFrame.previousText += str;
michael@0:   },
michael@0: 
michael@0:   /**
michael@0:    * data is a string that is a data URI for the favicon. Our job is to
michael@0:    * decode it and store it in the favicon service.
michael@0:    *
michael@0:    * When aIconURI is non-null, we will use that as the URI of the favicon
michael@0:    * when storing in the favicon service.
michael@0:    *
michael@0:    * When aIconURI is null, we have to make up a URI for this favicon so that
michael@0:    * it can be stored in the service. The real one will be set the next time
michael@0:    * the user visits the page. Our made up one should get expired when the
michael@0:    * page no longer references it.
michael@0:    */
michael@0:   _setFaviconForURI: function setFaviconForURI(aPageURI, aIconURI, aData) {
michael@0:     // if the input favicon URI is a chrome: URI, then we just save it and don't
michael@0:     // worry about data
michael@0:     if (aIconURI) {
michael@0:       if (aIconURI.schemeIs("chrome")) {
michael@0:         PlacesUtils.favicons.setAndFetchFaviconForPage(aPageURI, aIconURI,
michael@0:                                                        false,
michael@0:                                                        PlacesUtils.favicons.FAVICON_LOAD_NON_PRIVATE);
michael@0:         return;
michael@0:       }
michael@0:     }
michael@0: 
michael@0:     // some bookmarks have placeholder URIs that contain just "data:"
michael@0:     // ignore these
michael@0:     if (aData.length <= 5) {
michael@0:       return;
michael@0:     }
michael@0: 
michael@0:     let faviconURI;
michael@0:     if (aIconURI) {
michael@0:       faviconURI = aIconURI;
michael@0:     } else {
michael@0:       // Make up a favicon URI for this page.  Later, we'll make sure that this
michael@0:       // favicon URI is always associated with local favicon data, so that we
michael@0:       // don't load this URI from the network.
michael@0:       let faviconSpec = "http://www.mozilla.org/2005/made-up-favicon/"
michael@0:                       + serialNumber
michael@0:                       + "-"
michael@0:                       + new Date().getTime();
michael@0:       faviconURI = NetUtil.newURI(faviconSpec);
michael@0:       serialNumber++;
michael@0:     }
michael@0: 
michael@0:     // This could fail if the favicon is bigger than defined limit, in such a
michael@0:     // case neither the favicon URI nor the favicon data will be saved.  If the
michael@0:     // bookmark is visited again later, the URI and data will be fetched.
michael@0:     PlacesUtils.favicons.replaceFaviconDataFromDataURL(faviconURI, aData);
michael@0:     PlacesUtils.favicons.setAndFetchFaviconForPage(aPageURI, faviconURI, false, PlacesUtils.favicons.FAVICON_LOAD_NON_PRIVATE);
michael@0:   },
michael@0: 
michael@0:   /**
michael@0:    * Converts a string date in seconds to an int date in microseconds
michael@0:    */
michael@0:   _convertImportedDateToInternalDate: function convertImportedDateToInternalDate(aDate) {
michael@0:     if (aDate && !isNaN(aDate)) {
michael@0:       return parseInt(aDate) * 1000000; // in bookmarks.html this value is in seconds, not microseconds
michael@0:     } else {
michael@0:       return Date.now();
michael@0:     }
michael@0:   },
michael@0: 
michael@0:   runBatched: function runBatched(aDoc) {
michael@0:     if (!aDoc) {
michael@0:       return;
michael@0:     }
michael@0: 
michael@0:     if (this._isImportDefaults) {
michael@0:       PlacesUtils.bookmarks.removeFolderChildren(PlacesUtils.bookmarksMenuFolderId);
michael@0:       PlacesUtils.bookmarks.removeFolderChildren(PlacesUtils.toolbarFolderId);
michael@0:       PlacesUtils.bookmarks.removeFolderChildren(PlacesUtils.unfiledBookmarksFolderId);
michael@0:     }
michael@0: 
michael@0:     let current = aDoc;
michael@0:     let next;
michael@0:     for (;;) {
michael@0:       switch (current.nodeType) {
michael@0:         case Ci.nsIDOMNode.ELEMENT_NODE:
michael@0:           this._openContainer(current);
michael@0:           break;
michael@0:         case Ci.nsIDOMNode.TEXT_NODE:
michael@0:           this._appendText(current.data);
michael@0:           break;
michael@0:       }
michael@0:       if ((next = current.firstChild)) {
michael@0:         current = next;
michael@0:         continue;
michael@0:       }
michael@0:       for (;;) {
michael@0:         if (current.nodeType == Ci.nsIDOMNode.ELEMENT_NODE) {
michael@0:           this._closeContainer(current);
michael@0:         }
michael@0:         if (current == aDoc) {
michael@0:           return;
michael@0:         }
michael@0:         if ((next = current.nextSibling)) {
michael@0:           current = next;
michael@0:           break;
michael@0:         }
michael@0:         current = current.parentNode;
michael@0:       }
michael@0:     }
michael@0:   },
michael@0: 
michael@0:   _walkTreeForImport: function walkTreeForImport(aDoc) {
michael@0:     PlacesUtils.bookmarks.runInBatchMode(this, aDoc);
michael@0:   },
michael@0: 
michael@0:   importFromURL: function importFromURL(aSpec) {
michael@0:     let deferred = Promise.defer();
michael@0:     let xhr = Cc["@mozilla.org/xmlextras/xmlhttprequest;1"]
michael@0:                 .createInstance(Ci.nsIXMLHttpRequest);
michael@0:     xhr.onload = () => {
michael@0:       try {
michael@0:         this._walkTreeForImport(xhr.responseXML);
michael@0:         deferred.resolve();
michael@0:       } catch(e) {
michael@0:         deferred.reject(e);
michael@0:         throw e;
michael@0:       }
michael@0:     };
michael@0:     xhr.onabort = xhr.onerror = xhr.ontimeout = () => {
michael@0:       deferred.reject(new Error("xmlhttprequest failed"));
michael@0:     };
michael@0:     try {
michael@0:       xhr.open("GET", aSpec);
michael@0:       xhr.responseType = "document";
michael@0:       xhr.overrideMimeType("text/html");
michael@0:       xhr.send();
michael@0:     } catch (e) {
michael@0:       deferred.reject(e);
michael@0:     }
michael@0:     return deferred.promise;
michael@0:   },
michael@0: 
michael@0: };
michael@0: 
michael@0: function BookmarkExporter(aBookmarksTree) {
michael@0:   // Create a map of the roots.
michael@0:   let rootsMap = new Map();
michael@0:   for (let child of aBookmarksTree.children) {
michael@0:     if (child.root)
michael@0:       rootsMap.set(child.root, child);
michael@0:   }
michael@0: 
michael@0:   // For backwards compatibility reasons the bookmarks menu is the root, while
michael@0:   // the bookmarks toolbar and unfiled bookmarks will be child items.
michael@0:   this._root = rootsMap.get("bookmarksMenuFolder");
michael@0: 
michael@0:   for (let key of [ "toolbarFolder", "unfiledBookmarksFolder" ]) {
michael@0:     let root = rootsMap.get(key);
michael@0:     if (root.children && root.children.length > 0) {
michael@0:       if (!this._root.children)
michael@0:         this._root.children = [];
michael@0:       this._root.children.push(root);
michael@0:     }
michael@0:   }
michael@0: }
michael@0: 
michael@0: BookmarkExporter.prototype = {
michael@0:   exportToFile: function exportToFile(aFilePath) {
michael@0:     return Task.spawn(function* () {
michael@0:       // Create a file that can be accessed by the current user only.
michael@0:       let out = FileUtils.openAtomicFileOutputStream(new FileUtils.File(aFilePath));
michael@0:       try {
michael@0:         // We need a buffered output stream for performance.  See bug 202477.
michael@0:         let bufferedOut = Cc["@mozilla.org/network/buffered-output-stream;1"]
michael@0:                           .createInstance(Ci.nsIBufferedOutputStream);
michael@0:         bufferedOut.init(out, 4096);
michael@0:         try {
michael@0:           // Write bookmarks in UTF-8.
michael@0:           this._converterOut = Cc["@mozilla.org/intl/converter-output-stream;1"]
michael@0:                                .createInstance(Ci.nsIConverterOutputStream);
michael@0:           this._converterOut.init(bufferedOut, "utf-8", 0, 0);
michael@0:           try {
michael@0:             this._writeHeader();
michael@0:             yield this._writeContainer(this._root);
michael@0:             // Retain the target file on success only.
michael@0:             bufferedOut.QueryInterface(Ci.nsISafeOutputStream).finish();
michael@0:           } finally {
michael@0:             this._converterOut.close();
michael@0:             this._converterOut = null;
michael@0:           }
michael@0:         } finally {
michael@0:           bufferedOut.close();
michael@0:         }
michael@0:       } finally {
michael@0:         out.close();
michael@0:       }
michael@0:     }.bind(this));
michael@0:   },
michael@0: 
michael@0:   _converterOut: null,
michael@0: 
michael@0:   _write: function (aText) {
michael@0:     this._converterOut.writeString(aText || "");
michael@0:   },
michael@0: 
michael@0:   _writeAttribute: function (aName, aValue) {
michael@0:     this._write(' ' +  aName + '="' + aValue + '"');
michael@0:   },
michael@0: 
michael@0:   _writeLine: function (aText) {
michael@0:     this._write(aText + "\n");
michael@0:   },
michael@0: 
michael@0:   _writeHeader: function () {
michael@0:     this._writeLine("<!DOCTYPE NETSCAPE-Bookmark-file-1>");
michael@0:     this._writeLine("<!-- This is an automatically generated file.");
michael@0:     this._writeLine("     It will be read and overwritten.");
michael@0:     this._writeLine("     DO NOT EDIT! -->");
michael@0:     this._writeLine('<META HTTP-EQUIV="Content-Type" CONTENT="text/html; ' +
michael@0:                     'charset=UTF-8">');
michael@0:     this._writeLine("<TITLE>Bookmarks</TITLE>");
michael@0:   },
michael@0: 
michael@0:   _writeContainer: function (aItem, aIndent = "") {
michael@0:     if (aItem == this._root) {
michael@0:       this._writeLine("<H1>" + escapeHtmlEntities(this._root.title) + "</H1>");
michael@0:       this._writeLine("");
michael@0:     }
michael@0:     else {
michael@0:       this._write(aIndent + "<DT><H3");
michael@0:       this._writeDateAttributes(aItem);
michael@0: 
michael@0:       if (aItem.root === "toolbarFolder")
michael@0:         this._writeAttribute("PERSONAL_TOOLBAR_FOLDER", "true");
michael@0:       else if (aItem.root === "unfiledBookmarksFolder")
michael@0:         this._writeAttribute("UNFILED_BOOKMARKS_FOLDER", "true");
michael@0:       this._writeLine(">" + escapeHtmlEntities(aItem.title) + "</H3>");
michael@0:     }
michael@0: 
michael@0:     this._writeDescription(aItem, aIndent);
michael@0: 
michael@0:     this._writeLine(aIndent + "<DL><p>");
michael@0:     if (aItem.children)
michael@0:       yield this._writeContainerContents(aItem, aIndent);
michael@0:     if (aItem == this._root)
michael@0:       this._writeLine(aIndent + "</DL>");
michael@0:     else
michael@0:       this._writeLine(aIndent + "</DL><p>");
michael@0:   },
michael@0: 
michael@0:   _writeContainerContents: function (aItem, aIndent) {
michael@0:     let localIndent = aIndent + EXPORT_INDENT;
michael@0: 
michael@0:     for (let child of aItem.children) {
michael@0:       if (child.annos && child.annos.some(anno => anno.name == PlacesUtils.LMANNO_FEEDURI))
michael@0:           this._writeLivemark(child, localIndent);
michael@0:       else if (child.type == PlacesUtils.TYPE_X_MOZ_PLACE_CONTAINER)
michael@0:           yield this._writeContainer(child, localIndent);
michael@0:       else if (child.type == PlacesUtils.TYPE_X_MOZ_PLACE_SEPARATOR)
michael@0:         this._writeSeparator(child, localIndent);
michael@0:       else
michael@0:         yield this._writeItem(child, localIndent);
michael@0:     }
michael@0:   },
michael@0: 
michael@0:   _writeSeparator: function (aItem, aIndent) {
michael@0:     this._write(aIndent + "<HR");
michael@0:     // We keep exporting separator titles, but don't support them anymore.
michael@0:     if (aItem.title)
michael@0:       this._writeAttribute("NAME", escapeHtmlEntities(aItem.title));
michael@0:     this._write(">");
michael@0:   },
michael@0: 
michael@0:   _writeLivemark: function (aItem, aIndent) {
michael@0:     this._write(aIndent + "<DT><A");
michael@0:     let feedSpec = aItem.annos.find(anno => anno.name == PlacesUtils.LMANNO_FEEDURI).value;
michael@0:     this._writeAttribute("FEEDURL", escapeUrl(feedSpec));
michael@0:     let siteSpecAnno = aItem.annos.find(anno => anno.name == PlacesUtils.LMANNO_SITEURI);
michael@0:     if (siteSpecAnno)
michael@0:       this._writeAttribute("HREF", escapeUrl(siteSpecAnno.value));
michael@0:     this._writeLine(">" + escapeHtmlEntities(aItem.title) + "</A>");
michael@0:     this._writeDescription(aItem, aIndent);
michael@0:   },
michael@0: 
michael@0:   _writeItem: function (aItem, aIndent) {
michael@0:     // This is a workaround for "too much recursion" error, due to the fact
michael@0:     // Task.jsm still uses old on-same-tick promises.  It may be removed as
michael@0:     // soon as bug 887923 is fixed.
michael@0:     yield promiseSoon();
michael@0:     let uri = null;
michael@0:     try {
michael@0:       uri = NetUtil.newURI(aItem.uri);
michael@0:     } catch (ex) {
michael@0:       // If the item URI is invalid, skip the item instead of failing later.
michael@0:       return;
michael@0:     }
michael@0: 
michael@0:     this._write(aIndent + "<DT><A");
michael@0:     this._writeAttribute("HREF", escapeUrl(aItem.uri));
michael@0:     this._writeDateAttributes(aItem);
michael@0:     yield this._writeFaviconAttribute(aItem);
michael@0: 
michael@0:     let keyword = PlacesUtils.bookmarks.getKeywordForBookmark(aItem.id);
michael@0:     if (aItem.keyword)
michael@0:       this._writeAttribute("SHORTCUTURL", escapeHtmlEntities(keyword));
michael@0: 
michael@0:     let postDataAnno = aItem.annos &&
michael@0:                        aItem.annos.find(anno => anno.name == PlacesUtils.POST_DATA_ANNO);
michael@0:     if (postDataAnno)
michael@0:       this._writeAttribute("POST_DATA", escapeHtmlEntities(postDataAnno.value));
michael@0: 
michael@0:     if (aItem.annos && aItem.annos.some(anno => anno.name == LOAD_IN_SIDEBAR_ANNO))
michael@0:       this._writeAttribute("WEB_PANEL", "true");
michael@0:     if (aItem.charset)
michael@0:       this._writeAttribute("LAST_CHARSET", escapeHtmlEntities(aItem.charset));
michael@0:     if (aItem.tags)
michael@0:       this._writeAttribute("TAGS", aItem.tags);
michael@0:     this._writeLine(">" + escapeHtmlEntities(aItem.title) + "</A>");
michael@0:     this._writeDescription(aItem, aIndent);
michael@0:   },
michael@0: 
michael@0:   _writeDateAttributes: function (aItem) {
michael@0:     if (aItem.dateAdded)
michael@0:       this._writeAttribute("ADD_DATE",
michael@0:                            Math.floor(aItem.dateAdded / MICROSEC_PER_SEC));
michael@0:     if (aItem.lastModified)
michael@0:       this._writeAttribute("LAST_MODIFIED",
michael@0:                            Math.floor(aItem.lastModified / MICROSEC_PER_SEC));
michael@0:   },
michael@0: 
michael@0:   _writeFaviconAttribute: function (aItem) {
michael@0:     if (!aItem.iconuri)
michael@0:       return;
michael@0:     let favicon;
michael@0:     try {
michael@0:       favicon  = yield PlacesUtils.promiseFaviconData(aItem.uri);
michael@0:     } catch (ex) {
michael@0:       Components.utils.reportError("Unexpected Error trying to fetch icon data");
michael@0:       return;
michael@0:     }
michael@0: 
michael@0:     this._writeAttribute("ICON_URI", escapeUrl(favicon.uri.spec));
michael@0: 
michael@0:     if (!favicon.uri.schemeIs("chrome") && favicon.dataLen > 0) {
michael@0:       let faviconContents = "data:image/png;base64," +
michael@0:         base64EncodeString(String.fromCharCode.apply(String, favicon.data));
michael@0:       this._writeAttribute("ICON", faviconContents);
michael@0:     }
michael@0:   },
michael@0: 
michael@0:   _writeDescription: function (aItem, aIndent) {
michael@0:     let descriptionAnno = aItem.annos &&
michael@0:                           aItem.annos.find(anno => anno.name == DESCRIPTION_ANNO);
michael@0:     if (descriptionAnno)
michael@0:       this._writeLine(aIndent + "<DD>" + escapeHtmlEntities(descriptionAnno.value));
michael@0:   }
michael@0: };