gecko/mobile/android/base/ProfileMigrator.java

1403 lines
60 KiB
Java

/* -*- Mode: Java; c-basic-offset: 4; tab-width: 20; indent-tabs-mode: nil; -*-
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
package org.mozilla.gecko;
import org.mozilla.gecko.db.BrowserContract;
import org.mozilla.gecko.db.BrowserContract.Bookmarks;
import org.mozilla.gecko.db.BrowserContract.Passwords;
import org.mozilla.gecko.db.LocalBrowserDB;
import org.mozilla.gecko.sqlite.SQLiteBridge;
import org.mozilla.gecko.sqlite.SQLiteBridgeException;
import org.mozilla.gecko.sync.setup.SyncAccounts;
import org.mozilla.gecko.sync.setup.SyncAccounts.SyncAccountParameters;
import org.mozilla.gecko.util.GeckoEventListener;
import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;
import android.accounts.Account;
import android.content.ContentProviderOperation;
import android.content.ContentResolver;
import android.content.Context;
import android.content.OperationApplicationException;
import android.content.SharedPreferences;
import android.database.Cursor;
import android.database.SQLException;
import android.graphics.Bitmap;
import android.graphics.drawable.BitmapDrawable;
import android.graphics.drawable.Drawable;
import android.net.Uri;
import android.os.Build;
import android.os.RemoteException;
import android.text.TextUtils;
import android.util.Log;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.nio.channels.FileChannel;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;
public class ProfileMigrator {
private static final String LOGTAG = "ProfileMigrator";
private static final String PREFS_NAME = "ProfileMigrator";
private ContentResolver mCr;
private Context mContext;
private Runnable mLongOperationStartCallback;
private boolean mLongOperationStartRun;
private Runnable mLongOperationStopCallback;
private LocalBrowserDB mDB;
// Default number of history entries to migrate in one run.
private static final int DEFAULT_HISTORY_MIGRATE_COUNT = 2000;
// Maximum number of history entries to fetch at once.
// This limits the max memory use to about 10M (empirically), so we don't OOM.
private static final int HISTORY_MAX_BATCH = 5000;
private static final String PREFS_MIGRATE_BOOKMARKS_DONE = "bookmarks_done";
private static final String PREFS_MIGRATE_HISTORY_DONE = "history_done";
// Number of history entries already migrated.
private static final String PREFS_MIGRATE_HISTORY_COUNT = "history_count";
private static final String PREFS_MIGRATE_SYNC_DONE = "sync_done";
// Profile has been moved to internal storage?
private static final String PREFS_MIGRATE_MOVE_PROFILE_DONE
= "move_profile_done";
/*
These queries are derived from the low-level Places schema
https://developer.mozilla.org/en/The_Places_database
*/
private static final String ROOT_QUERY =
"SELECT root_name, folder_id FROM moz_bookmarks_roots";
private static final String ROOT_NAME = "root_name";
private static final String ROOT_FOLDER_ID = "folder_id";
// We use this to ignore the tags folder during migration.
private static final String ROOT_TAGS_FOLDER_NAME = "tags";
// Find the Mobile bookmarks root in places (bug 746860).
// We cannot rely on the name as that is locale-dependent.
// If it exists, it will have Id=6, fk=null, type=folder.
private static final String MOBILE_ROOT_QUERY =
"SELECT id FROM moz_bookmarks " +
"WHERE id=6 AND type=2 AND fk IS NULL AND parent=1";
private static final String MOBILE_ROOT_ID = "id";
// Do not migrate about URLs that we may not support,
// and do not migrate links to the XUL addons page.
private static final String FILTER_BLACKLISTED_BOOKMARKS =
"AND (places.url IS NULL OR (" +
"(places.url NOT LIKE 'about:%') AND " +
"(places.url NOT LIKE 'https://addons.mozilla.org/%/mobile%')" +
"))";
private static final String BOOKMARK_QUERY_SELECT =
"SELECT places.url AS p_url," +
" bookmark.guid AS b_guid," +
" bookmark.id AS b_id," +
" bookmark.title AS b_title," +
" bookmark.type AS b_type," +
" bookmark.parent AS b_parent," +
" bookmark.dateAdded AS b_added," +
" bookmark.lastModified AS b_modified," +
" bookmark.position AS b_position," +
" keyword.keyword AS k_keyword,";
private static final String BOOKMARK_QUERY_TRAILER =
"FROM (((moz_bookmarks AS bookmark " +
" LEFT OUTER JOIN moz_keywords AS keyword "+
" ON keyword.id = bookmark.keyword_id) " +
" LEFT OUTER JOIN moz_places AS places " +
" ON places.id = bookmark.fk) " +
" LEFT OUTER JOIN moz_favicons AS favicon " +
" ON places.favicon_id = favicon.id) " +
// Bookmark folders don't have a places entry.
"WHERE (places.hidden IS NULL " +
" OR places.hidden <> 1) " +
FILTER_BLACKLISTED_BOOKMARKS +
// This gives us a better chance of adding a folder before
// adding its contents and hence avoiding extra iterations below.
"ORDER BY bookmark.id";
private static final String BOOKMARK_QUERY_GUID =
BOOKMARK_QUERY_SELECT +
" favicon.data AS f_data," +
" favicon.mime_type AS f_mime_type," +
" favicon.url AS f_url," +
" favicon.guid AS f_guid " +
BOOKMARK_QUERY_TRAILER;
private static final String BOOKMARK_QUERY_NO_GUID =
BOOKMARK_QUERY_SELECT +
" favicon.data AS f_data," +
" favicon.mime_type AS f_mime_type," +
" favicon.url AS f_url " +
BOOKMARK_QUERY_TRAILER;
// Result column of relevant data
private static final String BOOKMARK_URL = "p_url";
private static final String BOOKMARK_TITLE = "b_title";
private static final String BOOKMARK_GUID = "b_guid";
private static final String BOOKMARK_ID = "b_id";
private static final String BOOKMARK_TYPE = "b_type";
private static final String BOOKMARK_PARENT = "b_parent";
private static final String BOOKMARK_ADDED = "b_added";
private static final String BOOKMARK_MODIFIED = "b_modified";
private static final String BOOKMARK_POSITION = "b_position";
private static final String KEYWORD_KEYWORD = "k_keyword";
private static final String FAVICON_DATA = "f_data";
private static final String FAVICON_MIME = "f_mime_type";
private static final String FAVICON_URL = "f_url";
private static final String FAVICON_GUID = "f_guid";
// Query for extra bookmark information
private static final String BOOKMARK_QUERY_EXTRAS =
"SELECT annos.item_id AS a_item_id, " +
" attributes.name AS t_name, " +
" annos.content AS a_content " +
"FROM (moz_items_annos AS annos " +
" JOIN moz_anno_attributes AS attributes " +
" ON annos.anno_attribute_id = attributes.id)";
// Result columns of extra information query
private static final String ANNO_ITEM_ID = "a_item_id";
private static final String ATTRIBUTE_NAME = "t_name";
private static final String ANNO_CONTENT = "a_content";
private class AttributePair {
final String name;
final String content;
public AttributePair(String aName, String aContent) {
name = aName;
content = aContent;
}
}
// Places attribute names for bookmarks
private static final String PLACES_ATTRIB_QUERY = "Places/SmartBookmark";
private static final String PLACES_ATTRIB_LIVEMARK_FEED = "livemark/feedURI";
private static final String PLACES_ATTRIB_LIVEMARK_SITE = "livemark/siteURI";
// Helper constants. They enumerate the different types of bookmarks we
// have to deal with, and we should have as many types as BrowserContract
// knows about, though the actual values don't necessarily match up. We do
// the translation between both values elsewhere.
// The first 3 correspond to real types that exist in places, and match
// values with the places types.
private static final int PLACES_TYPE_BOOKMARK = 1;
private static final int PLACES_TYPE_FOLDER = 2;
private static final int PLACES_TYPE_SEPARATOR = 3;
// These aren't used in the type field in places, but we use them
// internally because we need to distinguish them from the above types.
private static final int PLACES_TYPE_LIVEMARK = 4;
private static final int PLACES_TYPE_QUERY = 5;
/*
For statistics keeping.
*/
private static final String HISTORY_COUNT_QUERY =
"SELECT COUNT(*) FROM moz_historyvisits";
/*
The sort criterion here corresponds to the one used for the
Awesomebar results. It's a simplification of Frecency.
We must divide date by 1000 due to the micro (Places)
vs milli (Android) distiction.
*/
private static final String HISTORY_QUERY_SELECT =
"SELECT places.url AS p_url, " +
" places.title AS p_title, " +
" places.guid AS p_guid, " +
" MAX(history.visit_date) AS h_date, " +
" COUNT(*) AS h_visits, " +
// see BrowserDB.filterAllSites for this formula
" MAX(1, 100 * 225 / (" +
" ((MAX(history.visit_date)/1000 - ?) / 86400000) * " +
" ((MAX(history.visit_date)/1000 - ?) / 86400000) + 225)) AS a_recent, ";
private static final String HISTORY_QUERY_TRAILER =
"FROM (moz_historyvisits AS history " +
" JOIN moz_places AS places " +
" ON places.id = history.place_id " +
// Add favicon data if a favicon is present for this URL.
" LEFT OUTER JOIN moz_favicons AS favicon " +
" ON places.favicon_id = favicon.id) " +
"WHERE places.hidden <> 1 " +
"GROUP BY p_url " +
"ORDER BY h_visits * a_recent " +
"DESC LIMIT ? OFFSET ?";
private static final String HISTORY_QUERY_GUID =
HISTORY_QUERY_SELECT +
" favicon.data AS f_data, " +
" favicon.mime_type AS f_mime_type, " +
" favicon.url AS f_url, " +
" favicon.guid AS f_guid " +
HISTORY_QUERY_TRAILER;
private static final String HISTORY_QUERY_NO_GUID =
HISTORY_QUERY_SELECT +
" favicon.data AS f_data, " +
" favicon.mime_type AS f_mime_type, " +
" favicon.url AS f_url " +
HISTORY_QUERY_TRAILER;
private static final String HISTORY_URL = "p_url";
private static final String HISTORY_TITLE = "p_title";
private static final String HISTORY_GUID = "p_guid";
private static final String HISTORY_DATE = "h_date";
private static final String HISTORY_VISITS = "h_visits";
/*
Sync settings to get from prefs.js.
*/
private static final String[] SYNC_SETTINGS_LIST = new String[] {
"services.sync.account",
"services.sync.client.name",
"services.sync.client.GUID",
"services.sync.serverURL",
"services.sync.clusterURL"
};
/*
Sync settings to get from password manager.
*/
private static final String SYNC_HOST_NAME = "chrome://weave";
private static final String[] SYNC_REALM_LIST = new String[] {
"Mozilla Services Password",
"Mozilla Services Encryption Passphrase"
};
public ProfileMigrator(Context context) {
mContext = context;
mCr = mContext.getContentResolver();
mLongOperationStartCallback = null;
mLongOperationStopCallback = null;
}
public ProfileMigrator(Context context, ContentResolver contentResolver) {
mContext = context;
mCr = contentResolver;
mLongOperationStartCallback = null;
mLongOperationStopCallback = null;
}
// Define callbacks to run if the operation will take a while.
// Stop callback is only run if there was a start callback that was run.
public void setLongOperationCallbacks(Runnable start,
Runnable stop) {
mLongOperationStartCallback = start;
mLongOperationStopCallback = stop;
mLongOperationStartRun = false;
}
public void launchPlacesTest(File profileDir) {
resetMigration();
launchPlaces(profileDir, DEFAULT_HISTORY_MIGRATE_COUNT);
}
public void launchPlaces(File profileDir) {
boolean timeThisRun = false;
Telemetry.Timer timer = null;
// First run, time things
if (!hasMigrationRun()) {
timeThisRun = true;
timer = new Telemetry.Timer("BROWSERPROVIDER_XUL_IMPORT_TIME");
}
launchPlaces(profileDir, DEFAULT_HISTORY_MIGRATE_COUNT);
if (timeThisRun)
timer.stop();
}
public void launchPlaces(File profileDir, int maxEntries) {
mLongOperationStartRun = false;
// Places migration is heavy on the phone, allow it to block
// other processing.
new PlacesRunnable(profileDir, maxEntries).run();
}
public void launchSyncPrefs() {
// Sync settings will post a runnable, no need for a seperate thread.
new SyncTask().run();
}
public void launchMoveProfile() {
// Make sure the profile is on internal storage.
new MoveProfileTask().run();
}
public boolean areBookmarksMigrated() {
return getPreferences().getBoolean(PREFS_MIGRATE_BOOKMARKS_DONE, false);
}
public boolean isHistoryMigrated() {
return getPreferences().getBoolean(PREFS_MIGRATE_HISTORY_DONE, false);
}
// Have Sync settings been transferred?
public boolean hasSyncMigrated() {
return getPreferences().getBoolean(PREFS_MIGRATE_SYNC_DONE, false);
}
// Has the profile been moved from an SDcard to internal storage?
public boolean isProfileMoved() {
return getPreferences().getBoolean(PREFS_MIGRATE_MOVE_PROFILE_DONE,
false);
}
// Only to be used for testing. Allows forcing Migration to rerun.
private void resetMigration() {
SharedPreferences.Editor editor = getPreferences().edit();
editor.putBoolean(PREFS_MIGRATE_BOOKMARKS_DONE, false);
editor.putBoolean(PREFS_MIGRATE_HISTORY_DONE, false);
editor.putInt(PREFS_MIGRATE_HISTORY_COUNT, 0);
editor.commit();
}
// Has migration run before?
protected boolean hasMigrationRun() {
return areBookmarksMigrated()
&& ((getMigratedHistoryEntries() > 0) || isHistoryMigrated());
}
// Has migration entirely finished?
protected boolean hasMigrationFinished() {
return areBookmarksMigrated() && isHistoryMigrated();
}
protected SharedPreferences getPreferences() {
return mContext.getSharedPreferences(PREFS_NAME, 0);
}
protected int getMigratedHistoryEntries() {
return getPreferences().getInt(PREFS_MIGRATE_HISTORY_COUNT, 0);
}
protected void setMigratedHistoryEntries(int count) {
SharedPreferences.Editor editor = getPreferences().edit();
editor.putInt(PREFS_MIGRATE_HISTORY_COUNT, count);
editor.commit();
}
protected void setBooleanPrefTrue(String prefName) {
SharedPreferences.Editor editor = getPreferences().edit();
editor.putBoolean(prefName, true);
editor.commit();
}
protected void setMigratedHistory() {
setBooleanPrefTrue(PREFS_MIGRATE_HISTORY_DONE);
}
protected void setMigratedBookmarks() {
setBooleanPrefTrue(PREFS_MIGRATE_BOOKMARKS_DONE);
}
protected void setMigratedSync() {
setBooleanPrefTrue(PREFS_MIGRATE_SYNC_DONE);
}
protected void setMovedProfile() {
setBooleanPrefTrue(PREFS_MIGRATE_MOVE_PROFILE_DONE);
}
private class MoveProfileTask implements Runnable {
protected void moveProfilesToAppInstallLocation() {
if (Build.VERSION.SDK_INT >= 8) {
// if we're on API >= 8, it's possible that
// we were previously on external storage, check there for profiles to pull in
moveProfilesFrom(mContext.getExternalFilesDir(null));
}
// Maybe it worked. Maybe it didn't. We won't try again.
setMovedProfile();
}
protected void moveProfilesFrom(File oldFilesDir) {
if (oldFilesDir == null) {
return;
}
File oldMozDir = new File(oldFilesDir, "mozilla");
if (! (oldMozDir.exists() && oldMozDir.isDirectory())) {
return;
}
// if we get here, we know that oldMozDir exists
File currentMozDir;
try {
currentMozDir = GeckoProfile.ensureMozillaDirectory(mContext);
if (currentMozDir.equals(oldMozDir)) {
return;
}
} catch (IOException ioe) {
Log.e(LOGTAG, "Unable to create a profile directory!", ioe);
return;
}
Log.d(LOGTAG, "Moving old profile directories from " + oldMozDir.getAbsolutePath());
// if we get here, we know that oldMozDir != currentMozDir, so we have some stuff to move
moveDirContents(oldMozDir, currentMozDir);
}
protected void moveDirContents(File src, File dst) {
File[] files = src.listFiles();
if (files == null) {
src.delete();
return;
}
for (File f : files) {
File target = new File(dst, f.getName());
try {
if (f.renameTo(target)) {
continue;
}
} catch (SecurityException se) {
Log.w(LOGTAG, "Unable to rename file to " + target.getAbsolutePath() + " while moving profiles", se);
}
// rename failed, try moving manually
if (f.isDirectory()) {
if (target.exists() || target.mkdirs()) {
moveDirContents(f, target);
} else {
Log.e(LOGTAG, "Unable to create folder " + target.getAbsolutePath() + " while moving profiles");
}
} else {
if (!moveFile(f, target)) {
Log.e(LOGTAG, "Unable to move file " + target.getAbsolutePath() + " while moving profiles");
}
}
}
src.delete();
}
protected boolean moveFile(File src, File dst) {
boolean success = false;
long lastModified = src.lastModified();
try {
FileInputStream fis = new FileInputStream(src);
try {
FileOutputStream fos = new FileOutputStream(dst);
try {
FileChannel inChannel = fis.getChannel();
long size = inChannel.size();
if (size == inChannel.transferTo(0, size, fos.getChannel())) {
success = true;
}
} finally {
fos.close();
}
} finally {
fis.close();
}
} catch (IOException ioe) {
Log.e(LOGTAG, "Exception while attempting to move file to " + dst.getAbsolutePath(), ioe);
}
if (success) {
dst.setLastModified(lastModified);
src.delete();
} else {
dst.delete();
}
return success;
}
@Override
public void run() {
if (isProfileMoved()) {
return;
}
moveProfilesToAppInstallLocation();
}
}
private class SyncTask implements Runnable, GeckoEventListener {
private List<String> mSyncSettingsList;
private Map<String, String> mSyncSettingsMap;
// Initialize preferences by sending the "Preferences:Get" command to Gecko
protected void requestValues() {
mSyncSettingsList = Arrays.asList(SYNC_SETTINGS_LIST);
mSyncSettingsMap = new HashMap<String, String>();
JSONArray jsonPrefs = new JSONArray(mSyncSettingsList);
Log.d(LOGTAG, "Sending: " + jsonPrefs.toString());
GeckoEvent event =
GeckoEvent.createBroadcastEvent("Preferences:Get",
jsonPrefs.toString());
GeckoAppShell.sendEventToGecko(event);
}
// Receive settings reply from Gecko, do the rest of the setup
public void handleMessage(String event, JSONObject message) {
Log.d(LOGTAG, "Received event: " + event);
try {
if (event.equals("Preferences:Data")) {
// Receive most settings from Gecko's service.
// This includes personal info, so don't log.
// Log.d(LOGTAG, "Message: " + message.toString());
JSONArray jsonPrefs = message.getJSONArray("preferences");
// Check that the batch of preferences we got notified of are in
// the ones we requested and not those requested by other java code.
if (!parsePrefs(jsonPrefs))
return;
unregisterEventListener("Preferences:Data", this);
// Now call the password provider to fill in the rest.
for (String location: SYNC_REALM_LIST) {
Log.d(LOGTAG, "Checking: " + location);
String passwd = getPassword(location);
if (!TextUtils.isEmpty(passwd)) {
Log.d(LOGTAG, "Got password");
mSyncSettingsMap.put(location, passwd);
} else {
Log.d(LOGTAG, "No password found");
mSyncSettingsMap.put(location, null);
}
}
// Call Sync and transfer settings.
configureSync();
}
} catch (Exception e) {
Log.e(LOGTAG, "Exception handling message \"" + event + "\":", e);
}
}
protected String getPassword(String realm) {
Cursor cursor = null;
String result = null;
try {
cursor = mCr.query(Passwords.CONTENT_URI,
null,
Passwords.HOSTNAME + " = ? AND "
+ Passwords.HTTP_REALM + " = ?",
new String[] { SYNC_HOST_NAME, realm },
null);
if (cursor != null) {
final int userCol =
cursor.getColumnIndexOrThrow(Passwords.ENCRYPTED_USERNAME);
final int passCol =
cursor.getColumnIndexOrThrow(Passwords.ENCRYPTED_PASSWORD);
if (cursor.moveToFirst()) {
String user = cursor.getString(userCol);
String pass = cursor.getString(passCol);
result = pass;
} else {
Log.i(LOGTAG, "No password found for realm = " + realm);
}
}
} finally {
if (cursor != null)
cursor.close();
}
return result;
}
// Returns true if we sucessfully got the preferences we requested.
protected boolean parsePrefs(JSONArray jsonPrefs) {
try {
final int length = jsonPrefs.length();
for (int i = 0; i < length; i++) {
JSONObject jPref = jsonPrefs.getJSONObject(i);
final String prefName = jPref.getString("name");
// Check to make sure we're working with preferences we requested.
if (!mSyncSettingsList.contains(prefName))
return false;
final String prefType = jPref.getString("type");
if ("bool".equals(prefType)) {
final boolean value = jPref.getBoolean("value");
mSyncSettingsMap.put(prefName, value ? "1" : "0");
} else {
final String value = jPref.getString("value");
if (!TextUtils.isEmpty(value)) {
mSyncSettingsMap.put(prefName, value);
} else {
Log.w(LOGTAG, "Could not recover setting for = " + prefName);
mSyncSettingsMap.put(prefName, null);
}
}
}
} catch (JSONException e) {
Log.e(LOGTAG, "Exception handling preferences answer: "
+ e.getMessage());
return false;
}
return true;
}
protected void configureSync() {
final String userName = mSyncSettingsMap.get("services.sync.account");
final String syncKey = mSyncSettingsMap.get("Mozilla Services Encryption Passphrase");
final String syncPass = mSyncSettingsMap.get("Mozilla Services Password");
final String serverURL = mSyncSettingsMap.get("services.sync.serverURL");
final String clusterURL = mSyncSettingsMap.get("services.sync.clusterURL");
final String clientName = mSyncSettingsMap.get("services.sync.client.name");
final String clientGuid = mSyncSettingsMap.get("services.sync.client.GUID");
GeckoAppShell.getHandler().post(new Runnable() {
public void run() {
if (userName == null || syncKey == null || syncPass == null) {
// This isn't going to work. Give up.
Log.e(LOGTAG, "Profile has incomplete Sync config. Not migrating.");
setMigratedSync();
return;
}
final SyncAccountParameters params =
new SyncAccountParameters(mContext, null,
userName, syncKey,
syncPass, serverURL, clusterURL,
clientName, clientGuid);
final Account account = SyncAccounts.createSyncAccount(params);
if (account == null) {
Log.e(LOGTAG, "Failed to migrate Sync account.");
} else {
Log.i(LOGTAG, "Migrating Sync account succeeded.");
}
setMigratedSync();
}
});
}
protected void registerAndRequest() {
GeckoAppShell.getHandler().post(new Runnable() {
public void run() {
registerEventListener("Preferences:Data", SyncTask.this);
requestValues();
}
});
}
@Override
public void run() {
// Run only if no Sync accounts exist.
new SyncAccounts.AccountsExistTask() {
@Override
protected void onPostExecute(Boolean result) {
if (result.booleanValue()) {
GeckoAppShell.getHandler().post(new Runnable() {
public void run() {
Log.i(LOGTAG, "Sync account already configured, skipping.");
setMigratedSync();
}
});
} else {
// No account configured, fire up.
registerAndRequest();
}
}
}.execute(mContext);
}
private void registerEventListener(String event, GeckoEventListener listener) {
GeckoAppShell.getEventDispatcher().registerEventListener(event, listener);
}
private void unregisterEventListener(String event, GeckoEventListener listener) {
GeckoAppShell.getEventDispatcher().unregisterEventListener(event, listener);
}
}
private class MiscTask implements Runnable {
protected void cleanupXULLibCache() {
File cacheFile = GeckoAppShell.getCacheDir(mContext);
File[] files = cacheFile.listFiles();
if (files != null) {
Iterator<File> cacheFiles = Arrays.asList(files).iterator();
while (cacheFiles.hasNext()) {
File libFile = cacheFiles.next();
if (libFile.getName().endsWith(".so")) {
libFile.delete();
}
}
}
}
@Override
public void run() {
// XXX: Land dependent bugs (732069) first
// cleanupXULLibCache();
}
}
private class PlacesRunnable implements Runnable {
private File mProfileDir;
private Map<Long, Long> mRerootMap;
private Long mTagsPlacesFolderId;
private ArrayList<ContentProviderOperation> mOperations;
private int mMaxEntries;
// We support 2 classes of schemas: Firefox Places 12-13
// and Firefox Places 13-21. The relevant difference for us
// is whether there is a GUID on favicons or not.
private boolean mHasFaviconGUID;
public PlacesRunnable(File profileDir, int limit) {
mProfileDir = profileDir;
mMaxEntries = limit;
mDB = new LocalBrowserDB(GeckoProfile.get(mContext).getName());
}
private long getFolderId(String guid) {
Cursor c = null;
try {
// Uses default profile
c = mCr.query(Bookmarks.CONTENT_URI,
new String[] { Bookmarks._ID },
Bookmarks.GUID + " = ?",
new String [] { guid },
null);
if (c.moveToFirst())
return c.getLong(c.getColumnIndexOrThrow(Bookmarks._ID));
} finally {
if (c != null)
c.close();
}
// Default fallback
return Bookmarks.FIXED_ROOT_ID;
}
// Check the Schema version of the Firefox Places Database.
public boolean checkPlacesSchema(SQLiteBridge db) {
final int schemaVersion = db.getVersion();
Log.d(LOGTAG, "Schema version " + schemaVersion);
if (schemaVersion < 12) {
Log.e(LOGTAG, "Places DB is too old, not migrating.");
return false;
} else if (schemaVersion >= 12 && schemaVersion <= 13) {
Log.d(LOGTAG, "Not Migrating Favicon GUIDs.");
mHasFaviconGUID = false;
return true;
} else if (schemaVersion <= 21) {
Log.d(LOGTAG, "Migrating Favicon GUIDs.");
mHasFaviconGUID = true;
return true;
} else {
Log.e(LOGTAG, "Too new (corrupted?) Places schema.");
return false;
}
}
// We want to know the id of special root folders in the places DB,
// and replace them by the corresponding root id in the Android DB.
protected void calculateReroot(SQLiteBridge db) {
mRerootMap = new HashMap<Long, Long>();
try {
Cursor cursor = db.rawQuery(ROOT_QUERY, null);
final int rootCol = cursor.getColumnIndex(ROOT_NAME);
final int folderCol = cursor.getColumnIndex(ROOT_FOLDER_ID);
cursor.moveToFirst();
while (!cursor.isAfterLast()) {
String name = cursor.getString(rootCol);
long placesFolderId = cursor.getLong(folderCol);
mRerootMap.put(placesFolderId, getFolderId(name));
Log.v(LOGTAG, "Name: " + name + ", pid=" + placesFolderId
+ ", nid=" + mRerootMap.get(placesFolderId));
// Keep track of the tags folder id so we can avoid
// migrating tags later.
if (ROOT_TAGS_FOLDER_NAME.equals(name))
mTagsPlacesFolderId = placesFolderId;
cursor.moveToNext();
}
cursor.close();
// XUL Fennec doesn't mark the Mobile folder as a root,
// so fix that up here.
cursor = db.rawQuery(MOBILE_ROOT_QUERY, null);
if (cursor.moveToFirst()) {
Log.v(LOGTAG, "Mobile root found, adding to known roots.");
final int idCol = cursor.getColumnIndex(MOBILE_ROOT_ID);
final long mobileRootId = cursor.getLong(idCol);
mRerootMap.put(mobileRootId, getFolderId(Bookmarks.MOBILE_FOLDER_GUID));
Log.v(LOGTAG, "Name: mobile, pid=" + mobileRootId
+ ", nid=" + mRerootMap.get(mobileRootId));
} else {
Log.v(LOGTAG, "Mobile root not found, is this a desktop profile?");
}
cursor.close();
} catch (SQLiteBridgeException e) {
Log.e(LOGTAG, "Failed to get bookmark roots: ", e);
// Do not try again.
setMigratedBookmarks();
return;
}
}
protected void updateBrowserHistory(String url, String title,
long date, int visits) {
mDB.updateHistoryInBatch(mCr, mOperations, url, title, date, visits);
}
protected BitmapDrawable decodeImageData(byte[] data) {
InputStream byteStream = new ByteArrayInputStream(data);
BitmapDrawable image =
(BitmapDrawable)Drawable.createFromStream(byteStream, "src");
return image;
}
protected void addFavicon(String url, String faviconUrl, String faviconGuid,
String mime, byte[] data) {
// Some GIFs can cause us to lock up completely
// without exceptions or anything. Not cool.
if (mime == null || mime.compareTo("image/gif") == 0) {
return;
}
BitmapDrawable image = null;
// Decode non-PNG images.
if (mime.compareTo("image/png") != 0) {
image = decodeImageData(data);
// Can't decode, give up.
if (image == null) {
Log.i(LOGTAG, "Cannot decode image type " + mime
+ " for URL=" + url);
}
}
try {
byte[] newData = null;
// Recompress decoded images to PNG.
if (image != null) {
Bitmap bitmap = image.getBitmap();
ByteArrayOutputStream stream = new ByteArrayOutputStream();
bitmap.compress(Bitmap.CompressFormat.PNG, 100, stream);
newData = stream.toByteArray();
} else {
// PNG images can be passed directly. Well, aside
// from having to convert them into a byte[].
newData = data;
}
mDB.updateFaviconInBatch(mCr, mOperations, url, faviconUrl, faviconGuid, newData);
} catch (SQLException e) {
Log.i(LOGTAG, "Migrating favicon failed: " + mime
+ " error:" + e.getMessage());
}
}
protected void doMigrateHistoryBatch(SQLiteBridge db,
int maxEntries, int currentEntries) {
final ArrayList<String> placesHistory = new ArrayList<String>();
mOperations = new ArrayList<ContentProviderOperation>();
int queryResultEntries = 0;
try {
Cursor cursor = db.rawQuery(HISTORY_COUNT_QUERY, null);
cursor.moveToFirst();
int historyCount = cursor.getInt(0);
Telemetry.HistogramAdd("BROWSERPROVIDER_XUL_IMPORT_HISTORY",
historyCount);
final String currentTime = Long.toString(System.currentTimeMillis());
final String[] queryParams = new String[] {
/* current time */
currentTime,
currentTime,
Integer.toString(maxEntries),
Integer.toString(currentEntries)
};
if (mHasFaviconGUID) {
cursor = db.rawQuery(HISTORY_QUERY_GUID, queryParams);
} else {
cursor = db.rawQuery(HISTORY_QUERY_NO_GUID, queryParams);
}
queryResultEntries = cursor.getCount();
final int urlCol = cursor.getColumnIndex(HISTORY_URL);
final int titleCol = cursor.getColumnIndex(HISTORY_TITLE);
final int dateCol = cursor.getColumnIndex(HISTORY_DATE);
final int visitsCol = cursor.getColumnIndex(HISTORY_VISITS);
final int faviconMimeCol = cursor.getColumnIndex(FAVICON_MIME);
final int faviconDataCol = cursor.getColumnIndex(FAVICON_DATA);
final int faviconUrlCol = cursor.getColumnIndex(FAVICON_URL);
// Safe even if it doesn't exist.
final int faviconGuidCol = cursor.getColumnIndex(FAVICON_GUID);
cursor.moveToFirst();
while (!cursor.isAfterLast()) {
String url = cursor.getString(urlCol);
String title = cursor.getString(titleCol);
long date = cursor.getLong(dateCol) / (long)1000;
int visits = cursor.getInt(visitsCol);
byte[] faviconDataBuff = cursor.getBlob(faviconDataCol);
String faviconMime = cursor.getString(faviconMimeCol);
String faviconUrl = cursor.getString(faviconUrlCol);
String faviconGuid = null;
if (mHasFaviconGUID) {
faviconGuid = cursor.getString(faviconGuidCol);
}
try {
placesHistory.add(url);
addFavicon(url, faviconUrl, faviconGuid,
faviconMime, faviconDataBuff);
updateBrowserHistory(url, title, date, visits);
} catch (Exception e) {
Log.e(LOGTAG, "Error adding history entry: ", e);
}
cursor.moveToNext();
}
cursor.close();
} catch (SQLiteBridgeException e) {
Log.e(LOGTAG, "Failed to get history: ", e);
// Do not try again.
setMigratedHistory();
return;
}
flushBatchOperations();
int totalEntries = currentEntries + queryResultEntries;
setMigratedHistoryEntries(totalEntries);
// Reached the end of the history list? Then stop.
// We're at the end if we got less results than requested.
if (queryResultEntries < mMaxEntries) {
setMigratedHistory();
}
// GlobalHistory access communicates with Gecko
// and must run on its thread.
GeckoAppShell.getHandler().post(new Runnable() {
public void run() {
for (String url : placesHistory) {
GlobalHistory.getInstance().addToGeckoOnly(url);
}
}
});
}
protected void migrateHistory(SQLiteBridge db) {
for (int i = 0; i < mMaxEntries; i += HISTORY_MAX_BATCH) {
int currentEntries = getMigratedHistoryEntries();
int fetchEntries = Math.min(mMaxEntries, HISTORY_MAX_BATCH);
Log.i(LOGTAG, "Processed " + currentEntries + " history entries");
Log.i(LOGTAG, "Fetching " + fetchEntries + " more history entries");
doMigrateHistoryBatch(db, fetchEntries, currentEntries);
}
}
protected void addBookmark(String url, String title, String guid,
long parent, long added,
long modified, long position,
String keyword, int type) {
// Translate the parent pointer if needed.
if (mRerootMap.containsKey(parent)) {
parent = mRerootMap.get(parent);
}
// The bookmark can only be one of the valid types.
final int newtype = (type == PLACES_TYPE_BOOKMARK ? Bookmarks.TYPE_BOOKMARK :
type == PLACES_TYPE_FOLDER ? Bookmarks.TYPE_FOLDER :
type == PLACES_TYPE_SEPARATOR ? Bookmarks.TYPE_SEPARATOR :
type == PLACES_TYPE_LIVEMARK ? Bookmarks.TYPE_LIVEMARK :
Bookmarks.TYPE_QUERY);
mDB.updateBookmarkInBatch(mCr, mOperations,
url, title, guid, parent, added,
modified, position, keyword, newtype);
}
protected Map<Long, List<AttributePair>> getBookmarkAttributes(SQLiteBridge db) {
Map<Long, List<AttributePair>> attributes =
new HashMap<Long, List<AttributePair>>();
Cursor cursor = null;
try {
cursor = db.rawQuery(BOOKMARK_QUERY_EXTRAS, null);
final int idCol = cursor.getColumnIndex(ANNO_ITEM_ID);
final int nameCol = cursor.getColumnIndex(ATTRIBUTE_NAME);
final int contentCol = cursor.getColumnIndex(ANNO_CONTENT);
cursor.moveToFirst();
while (!cursor.isAfterLast()) {
final long id = cursor.getLong(idCol);
final String attName = cursor.getString(nameCol);
final String content = cursor.getString(contentCol);
if (PLACES_ATTRIB_QUERY.equals(attName) ||
PLACES_ATTRIB_LIVEMARK_FEED.equals(attName) ||
PLACES_ATTRIB_LIVEMARK_SITE.equals(PLACES_ATTRIB_LIVEMARK_SITE)) {
AttributePair pair = new AttributePair(attName, content);
List<AttributePair> list = null;
if (attributes.containsKey(id)) {
list = attributes.get(id);
} else {
list = new ArrayList<AttributePair>();
}
list.add(pair);
attributes.put(id, list);
}
cursor.moveToNext();
}
} catch (SQLiteBridgeException e) {
Log.e(LOGTAG, "Failed to get bookmark attributes: ", e);
// Do not make this fatal.
} finally {
if (cursor != null)
cursor.close();
}
return attributes;
}
// Some bookmarks are normal folders in Places but actually have
// extra attributes turning them into something "special". In Firefox
// for Android these special bookmarks have a specific type, so we need
// to change the type from folder into this type if needed.
// We also need to translate the extra attributes from the Places
// database into extra parameters that are stored in the URL, hence
// "augmenting" the bookmark.
protected int augmentBookmark(final Map<Long, List<AttributePair>> attributes,
long id,
int type,
StringBuilder urlBuffer) {
// Queries don't necessarily have extra attributes,
// but are guaranteed to start like this.
if (urlBuffer.toString().startsWith("place:")) {
type = PLACES_TYPE_QUERY;
}
// No extra attributes, return immediately
if (!attributes.containsKey(id)) {
return type;
}
final List<AttributePair> list = attributes.get(id);
for (AttributePair pair: list) {
if (PLACES_ATTRIB_QUERY.equals(pair.name)) {
type = PLACES_TYPE_QUERY;
if (!TextUtils.isEmpty(pair.content)) {
if (urlBuffer.length() > 0) urlBuffer.append("&");
urlBuffer.append("queryId=" + Uri.encode(pair.content));
}
} else if (PLACES_ATTRIB_LIVEMARK_FEED.equals(pair.name)) {
type = PLACES_TYPE_LIVEMARK;
if (!TextUtils.isEmpty(pair.content)) {
if (urlBuffer.length() > 0) urlBuffer.append("&");
urlBuffer.append("feedUri=" + Uri.encode(pair.content));
}
} else if (PLACES_ATTRIB_LIVEMARK_SITE.equals(pair.name)) {
type = PLACES_TYPE_LIVEMARK;
if (!TextUtils.isEmpty(pair.content)) {
if (urlBuffer.length() > 0) urlBuffer.append("&");
urlBuffer.append("siteUri=" + Uri.encode(pair.content));
}
}
}
return type;
}
protected void migrateBookmarks(SQLiteBridge db) {
mOperations = new ArrayList<ContentProviderOperation>();
try {
Log.i(LOGTAG, "Fetching bookmarks from places");
Cursor cursor = null;
if (mHasFaviconGUID) {
cursor = db.rawQuery(BOOKMARK_QUERY_GUID, null);
} else {
cursor = db.rawQuery(BOOKMARK_QUERY_NO_GUID, null);
}
final int urlCol = cursor.getColumnIndex(BOOKMARK_URL);
final int titleCol = cursor.getColumnIndex(BOOKMARK_TITLE);
final int guidCol = cursor.getColumnIndex(BOOKMARK_GUID);
final int idCol = cursor.getColumnIndex(BOOKMARK_ID);
final int typeCol = cursor.getColumnIndex(BOOKMARK_TYPE);
final int parentCol = cursor.getColumnIndex(BOOKMARK_PARENT);
final int addedCol = cursor.getColumnIndex(BOOKMARK_ADDED);
final int modifiedCol = cursor.getColumnIndex(BOOKMARK_MODIFIED);
final int positionCol = cursor.getColumnIndex(BOOKMARK_POSITION);
final int keywordCol = cursor.getColumnIndex(KEYWORD_KEYWORD);
final int faviconMimeCol = cursor.getColumnIndex(FAVICON_MIME);
final int faviconDataCol = cursor.getColumnIndex(FAVICON_DATA);
final int faviconUrlCol = cursor.getColumnIndex(FAVICON_URL);
final int faviconGuidCol = cursor.getColumnIndex(FAVICON_GUID);
// Keep statistics
int bookmarkCount = cursor.getCount();
Telemetry.HistogramAdd("BROWSERPROVIDER_XUL_IMPORT_BOOKMARKS",
bookmarkCount);
// Get the extra bookmark attributes
Map<Long, List<AttributePair>> attributes = getBookmarkAttributes(db);
// The keys are places IDs.
Set<Long> openFolders = new HashSet<Long>();
Set<Long> knownFolders = new HashSet<Long>(mRerootMap.keySet());
// We iterate over all bookmarks, and add all bookmarks that
// have their parent folders present. If there are bookmarks
// that we can't add, we remember what these are and try again
// on the next iteration. The number of iterations scales
// according to the depth of the folders.
// No need to import root folders for which we have a remapping.
Set<Long> processedBookmarks = new HashSet<Long>(mRerootMap.keySet());
int iterations = 0;
do {
// Reset the set of missing folders that block us from
// adding entries.
openFolders.clear();
int added = 0;
int skipped = 0;
cursor.moveToFirst();
while (!cursor.isAfterLast()) {
long id = cursor.getLong(idCol);
// Already processed? if so just skip
if (processedBookmarks.contains(id)) {
cursor.moveToNext();
continue;
}
int type = cursor.getInt(typeCol);
long parent = cursor.getLong(parentCol);
// Places has an explicit root folder, id=1 parent=0. Skip that.
// Also, skip tags, since we don't use those in native fennec.
if ((id == 1 && parent == 0 && type == PLACES_TYPE_FOLDER) ||
parent == mTagsPlacesFolderId) {
cursor.moveToNext();
continue;
}
String url = cursor.getString(urlCol);
String title = cursor.getString(titleCol);
String guid = cursor.getString(guidCol);
long dateadded =
cursor.getLong(addedCol) / (long)1000;
long datemodified =
cursor.getLong(modifiedCol) / (long)1000;
long position = cursor.getLong(positionCol);
String keyword = cursor.getString(keywordCol);
byte[] faviconDataBuff = cursor.getBlob(faviconDataCol);
String faviconMime = cursor.getString(faviconMimeCol);
String faviconUrl = cursor.getString(faviconUrlCol);
String faviconGuid = null;
if (mHasFaviconGUID) {
faviconGuid = cursor.getString(faviconGuidCol);
}
StringBuilder urlBuffer;
if (url != null) {
urlBuffer = new StringBuilder(url);
} else {
urlBuffer = new StringBuilder();
}
type = augmentBookmark(attributes, id, type, urlBuffer);
// It's important we don't turn null URLs into empty
// URLs here, because null URL means the bookmark
// is identified by something else than the URL.
if (!TextUtils.isEmpty(urlBuffer)) {
url = urlBuffer.toString();
}
// Is the parent for this bookmark already added?
// If so, we can add the bookmark itself.
if (knownFolders.contains(parent)) {
try {
addBookmark(url, title, guid, parent,
dateadded, datemodified,
position, keyword, type);
addFavicon(url, faviconUrl, faviconGuid,
faviconMime, faviconDataBuff);
if (type == PLACES_TYPE_FOLDER) {
// We need to know the ID of the folder
// we just inserted. It's possible to
// make future database ops refer to the
// result of this operation, but that makes
// our algorithm to track dependencies too
// complicated. Just flush and be done with it.
flushBatchOperations();
long newFolderId = getFolderId(guid);
// Remap the folder IDs for parents.
mRerootMap.put(id, newFolderId);
knownFolders.add(id);
Log.d(LOGTAG, "Added folder: " + id);
}
processedBookmarks.add(id);
} catch (Exception e) {
Log.e(LOGTAG, "Error adding bookmark: ", e);
}
added++;
} else {
// We have to postpone until parent is processed;
openFolders.add(parent);
skipped++;
}
cursor.moveToNext();
}
// Now check if any of the new folders we added was a folder
// that we were blocked on, by intersecting openFolders and
// knownFolders. If this is empty, we're done because the next
// iteration can't make progress.
boolean changed = openFolders.retainAll(knownFolders);
// If there are no folders that we can add next iteration,
// but there were still folders before the intersection,
// those folders are orphans. Report this situation here.
if (openFolders.isEmpty() && changed) {
Log.w(LOGTAG, "Orphaned bookmarks found, not imported");
}
iterations++;
Log.i(LOGTAG, "Iteration = " + iterations + ", added " + added +
" bookmark(s), skipped " + skipped + " bookmark(s)");
} while (!openFolders.isEmpty());
cursor.close();
} catch (SQLiteBridgeException e) {
Log.e(LOGTAG, "Failed to get bookmarks: ", e);
// Do not try again.
setMigratedBookmarks();
return;
}
flushBatchOperations();
}
protected void flushBatchOperations() {
Log.i(LOGTAG, "Flushing " + mOperations.size() + " DB operations");
try {
// We don't really care for the results, this is best-effort.
mCr.applyBatch(BrowserContract.AUTHORITY, mOperations);
} catch (RemoteException e) {
Log.e(LOGTAG, "Remote exception while updating db: ", e);
} catch (OperationApplicationException e) {
// Bug 716729 means this happens even in normal circumstances
Log.i(LOGTAG, "Error while applying database updates: ", e);
}
mOperations.clear();
}
protected void migratePlaces(File aFile) {
// Typical case: nothing to do, we're done already.
if (hasMigrationFinished()) {
Log.i(LOGTAG, "Nothing to migrate, early exit.");
return;
}
String dbPath = aFile.getPath() + "/places.sqlite";
String dbPathWal = aFile.getPath() + "/places.sqlite-wal";
String dbPathShm = aFile.getPath() + "/places.sqlite-shm";
Log.i(LOGTAG, "Opening path: " + dbPath);
File dbFile = new File(dbPath);
if (!dbFile.exists()) {
Log.i(LOGTAG, "No database");
// Nothing to do, so mark as done.
setMigratedBookmarks();
setMigratedHistory();
return;
}
File dbFileWal = new File(dbPathWal);
File dbFileShm = new File(dbPathShm);
SQLiteBridge db = null;
GeckoAppShell.loadSQLiteLibs(mContext, mContext.getPackageResourcePath());
try {
db = new SQLiteBridge(dbPath);
if (!checkPlacesSchema(db)) {
// Incompatible schema. Bail out.
setMigratedBookmarks();
setMigratedHistory();
} else {
// Compatible schema. Let's go.
if (mLongOperationStartCallback != null) {
mLongOperationStartCallback.run();
mLongOperationStartRun = true;
}
calculateReroot(db);
if (!areBookmarksMigrated()) {
migrateBookmarks(db);
setMigratedBookmarks();
} else {
Log.i(LOGTAG, "Bookmarks already migrated. Skipping...");
}
if (!isHistoryMigrated()) {
migrateHistory(db);
} else {
Log.i(LOGTAG, "History already migrated. Skipping...");
}
}
db.close();
// Clean up if we finished this run. Bookmarks are always
// migrated if we get here.
if (isHistoryMigrated()) {
Log.i(LOGTAG, "Profile Migration has processed all entries. "
+" Purging old DB.");
dbFile.delete();
dbFileWal.delete();
dbFileShm.delete();
}
Log.i(LOGTAG, "Profile Migration run finished");
} catch (SQLiteBridgeException e) {
if (db != null) {
db.close();
}
Log.e(LOGTAG, "Error on places database:", e);
} finally {
if (mLongOperationStopCallback != null) {
if (mLongOperationStartRun) {
mLongOperationStopCallback.run();
}
}
}
}
@Override
public void run() {
migratePlaces(mProfileDir);
}
}
}