From 9c88eb1c273a2cb7f341d2f956296a7d62576547 Mon Sep 17 00:00:00 2001 From: Marco Bonardo Date: Thu, 6 Aug 2009 16:34:16 +0200 Subject: [PATCH] Bug 508265 - Localized bookmarks backup are not replaced by new backups, r=dietrich --- browser/components/places/content/places.js | 10 +- toolkit/components/places/src/utils.js | 40 ++++-- .../unit/test_utils_archiveBookmarksFile.js | 127 ++++++++++++++++++ 3 files changed, 157 insertions(+), 20 deletions(-) create mode 100644 toolkit/components/places/tests/unit/test_utils_archiveBookmarksFile.js diff --git a/browser/components/places/content/places.js b/browser/components/places/content/places.js index 3f4af8bc14a..ebd75dd28c5 100644 --- a/browser/components/places/content/places.js +++ b/browser/components/places/content/places.js @@ -553,11 +553,7 @@ var PlacesOrganizer = { var backupsDir = dirSvc.get("Desk", Ci.nsILocalFile); fp.displayDirectory = backupsDir; - // Use YYYY-MM-DD (ISO 8601) as it doesn't contain illegal characters - // and makes the alphabetical order of multiple backup files more useful. - var date = (new Date).toLocaleFormat("%Y-%m-%d"); - fp.defaultString = PlacesUIUtils.getFormattedString("bookmarksBackupFilenameJSON", - [date]); + fp.defaultString = PlacesUtils.getBackupFilename(); if (fp.show() != Ci.nsIFilePicker.returnCancel) { PlacesUtils.backupBookmarksToFile(fp.file); @@ -566,9 +562,7 @@ var PlacesOrganizer = { var latestBackup = PlacesUtils.getMostRecentBackup(); if (!latestBackup || latestBackup != fp.file) { latestBackup.remove(false); - var date = new Date().toLocaleFormat("%Y-%m-%d"); - var name = PlacesUtils.getFormattedString("bookmarksArchiveFilename", - [date]); + var name = PlacesUtils.getBackupFilename(); fp.file.copyTo(this.bookmarksBackupDir, name); } } diff --git a/toolkit/components/places/src/utils.js b/toolkit/components/places/src/utils.js index 501d01ef91f..fa597f52578 100644 --- a/toolkit/components/places/src/utils.js +++ b/toolkit/components/places/src/utils.js @@ -1749,6 +1749,23 @@ var PlacesUtils = { stream.close(); }, + /** + * Creates a filename for bookmarks backup files. + * + * @param [optional] aDateObj Date object used to build the filename. + * Will use current date if empty. + * @return A bookmarks backup filename. + */ + getBackupFilename: + function PU_getBackupFilename(aDateObj) { + if (!aDateObj) + aDateObj = new Date(); + // Use YYYY-MM-DD (ISO 8601) as it doesn't contain illegal characters + // and makes the alphabetical order of multiple backup files more useful. + var date = aDateObj.toLocaleFormat("%Y-%m-%d"); + return "bookmarks-" + date + ".json"; + }, + /** * ArchiveBookmarksFile() * @@ -1775,12 +1792,9 @@ var PlacesUtils = { return; // unable to create directory! } - // construct the new leafname - // Use YYYY-MM-DD (ISO 8601) as it doesn't contain illegal characters - // and makes the alphabetical order of multiple backup files more useful. - var date = new Date().toLocaleFormat("%Y-%m-%d"); - var backupFilename = "bookmarks-" + date + ".json"; - + // Construct the new leafname. + var date = new Date(); + var backupFilename = this.getBackupFilename(date); var backupFile = null; if (!aForceArchive) { var backupFileNames = []; @@ -1790,7 +1804,7 @@ var PlacesUtils = { // old backups with a localized name (bug 445704). var localizedFilename = this.getFormattedString("bookmarksArchiveFilename", [date]); var localizedFilenamePrefix = localizedFilename.substr(0, localizedFilename.indexOf("-")); - var rx = new RegExp("^(bookmarks|" + localizedFilenamePrefix + ")-.+\.(json|html)"); + var rx = new RegExp("^(bookmarks|" + localizedFilenamePrefix + ")-([0-9-]+)\.(json|html)"); var entries = bookmarksBackupDir.directoryEntries; while (entries.hasMoreElements()) { @@ -1798,10 +1812,11 @@ var PlacesUtils = { var backupName = entry.leafName; // A valid backup is any file that matches either the localized or // not-localized filename (bug 445704). - if (backupName.match(rx)) { + var matches = backupName.match(rx); + if (matches) { if (backupName == backupFilename) backupFile = entry; - backupFileNames.push(backupName); + backupFileNames.push({ filename: backupName, date: matches[2] }); } } @@ -1815,11 +1830,12 @@ var PlacesUtils = { // number specified in the pref. if (!backupFile) numberOfBackupsToDelete++; - - backupFileNames.sort(); + backupFileNames.sort(function compare(a, b) { + return a.date < b.date ? -1 : a.date > b.date ? 1 : 0; + }); while (numberOfBackupsToDelete--) { let backupFile = bookmarksBackupDir.clone(); - backupFile.append(backupFileNames[0]); + backupFile.append(backupFileNames[0].filename); backupFile.remove(false); backupFileNames.shift(); } diff --git a/toolkit/components/places/tests/unit/test_utils_archiveBookmarksFile.js b/toolkit/components/places/tests/unit/test_utils_archiveBookmarksFile.js new file mode 100644 index 00000000000..673bb50dcd8 --- /dev/null +++ b/toolkit/components/places/tests/unit/test_utils_archiveBookmarksFile.js @@ -0,0 +1,127 @@ +/* -*- Mode: Java; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ +/* vim:set ts=2 sw=2 sts=2 et: */ +/* ***** BEGIN LICENSE BLOCK ***** + * Version: MPL 1.1/GPL 2.0/LGPL 2.1 + * + * The contents of this file are subject to the Mozilla Public License Version + * 1.1 (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * http://www.mozilla.org/MPL/ + * + * Software distributed under the License is distributed on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License + * for the specific language governing rights and limitations under the + * License. + * + * The Original Code is Places unit test code. + * + * The Initial Developer of the Original Code is + * Mozilla Foundation. + * Portions created by the Initial Developer are Copyright (C) 2009 + * the Initial Developer. All Rights Reserved. + * + * Contributor(s): + * Marco Bonardo (Original Author) + * + * Alternatively, the contents of this file may be used under the terms of + * either the GNU General Public License Version 2 or later (the "GPL"), or + * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), + * in which case the provisions of the GPL or the LGPL are applicable instead + * of those above. If you wish to allow use of your version of this file only + * under the terms of either the GPL or the LGPL, and not to allow others to + * use your version of this file under the terms of the MPL, indicate your + * decision by deleting the provisions above and replace them with the notice + * and other provisions required by the GPL or the LGPL. If you do not delete + * the provisions above, a recipient may use your version of this file under + * the terms of any one of the MPL, the GPL or the LGPL. + * + * ***** END LICENSE BLOCK ***** */ + + /** + * Check for correct functionality of PlacesUtils.archiveBookmarksFile + */ + +Components.utils.import("resource://gre/modules/utils.js"); + +const PREFIX = "bookmarks-"; +// The localized prefix must be "bigger" and associated to older backups. +const LOCALIZED_PREFIX = "segnalibri-"; +const SUFFIX = ".json"; +const NUMBER_OF_BACKUPS = 10; + +function run_test() { + // Generate random dates. + var dateObj = new Date(); + var dates = []; + while (dates.length < NUMBER_OF_BACKUPS) { + // Use last year to ensure today's backup is the newest. + let randomDate = new Date(dateObj.getFullYear() - 1, + Math.floor(12 * Math.random()), + Math.floor(28 * Math.random())); + let dateString = randomDate.toLocaleFormat("%Y-%m-%d"); + if (dates.indexOf(dateString) == -1) + dates.push(dateString); + } + // Sort dates from oldest to newest. + dates.sort(); + + // Get and cleanup the backups folder. + var dirSvc = Cc["@mozilla.org/file/directory_service;1"]. + getService(Ci.nsIProperties); + var bookmarksBackupDir = dirSvc.get("ProfD", Ci.nsILocalFile); + bookmarksBackupDir.append("bookmarkbackups"); + if (bookmarksBackupDir.exists()) { + bookmarksBackupDir.remove(true); + do_check_false(bookmarksBackupDir.exists()); + } + bookmarksBackupDir.create(Ci.nsIFile.DIRECTORY_TYPE, 0777); + + // Fake backups are created backwards to ensure we won't consider file + // creation time. + // Create fake backups for the newest dates. + for (let i = dates.length - 1; i >= 0; i--) { + let backupFilename; + if (i > Math.floor(dates.length/2)) + backupFilename = PREFIX + dates[i] + SUFFIX; + else + backupFilename = LOCALIZED_PREFIX + dates[i] + SUFFIX; + dump("creating: " + backupFilename + "\n"); + let backupFile = bookmarksBackupDir.clone(); + backupFile.append(backupFilename); + backupFile.create(Ci.nsIFile.NORMAL_FILE_TYPE, 0666); + do_check_true(backupFile.exists()); + } + + // Replace PlacesUtils getFormattedString so that it will return the localized + // string we want. + PlacesUtils.getFormattedString = function (aKey, aValue) { + return LOCALIZED_PREFIX + aValue; + } + + PlacesUtils.archiveBookmarksFile(Math.floor(dates.length/2)); + // Add today's backup. + dates.push(dateObj.toLocaleFormat("%Y-%m-%d")); + + // Check backups. + for (var i = 0; i < dates.length; i++) { + let backupFilename; + let shouldExist; + if (i > Math.floor(dates.length/2)) { + backupFilename = PREFIX + dates[i] + SUFFIX; + shouldExist = true; + } + else { + backupFilename = LOCALIZED_PREFIX + dates[i] + SUFFIX; + shouldExist = false; + } + var backupFile = bookmarksBackupDir.clone(); + backupFile.append(backupFilename); + if (backupFile.exists() != shouldExist) + do_throw("Backup should " + (shouldExist ? "" : "not") + " exist: " + backupFilename); + } + + // Cleanup backups folder. + bookmarksBackupDir.remove(true); + do_check_false(bookmarksBackupDir.exists()); + bookmarksBackupDir.create(Ci.nsIFile.DIRECTORY_TYPE, 0777); +}