moparisthebest/open-keychain
1
0
Fork 0
mirror of https://github.com/moparisthebest/open-keychain synced 2024-11-16 13:55:03 -05:00
Code Issues Releases Wiki Activity

consolidate: a lot more log output, better recovery

Browse Source
This commit is contained in:
Vincent Breitmoser 2014-08-19 16:53:44 +02:00
parent c42f6a04ed
commit 9930ab7f6f
4 changed files with 109 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
OpenKeychain/src/main/java/org/sufficientlysecure/keychain/helper/Preferences.java
View File

@ -146,7 +146,7 @@ public class Preferences {
} }
public int getCachedConsolidateNumPublics() { public int getCachedConsolidateNumPublics() {
return mSharedPreferences.getInt(Pref.CACHED_CONSOLIDATE_PUBLICS, 100); return mSharedPreferences.getInt(Pref.CACHED_CONSOLIDATE_PUBLICS, -1);
} }
public void setCachedConsolidateNumPublics(int value) { public void setCachedConsolidateNumPublics(int value) {
@ -156,7 +156,7 @@ public class Preferences {
} }
public int getCachedConsolidateNumSecrets() { public int getCachedConsolidateNumSecrets() {
return mSharedPreferences.getInt(Pref.CACHED_CONSOLIDATE_SECRETS, 100); return mSharedPreferences.getInt(Pref.CACHED_CONSOLIDATE_SECRETS, -1);
} }
public void setCachedConsolidateNumSecrets(int value) { public void setCachedConsolidateNumSecrets(int value) {

86
OpenKeychain/src/main/java/org/sufficientlysecure/keychain/provider/ProviderHelper.java
View File

@ -829,12 +829,12 @@ public class ProviderHelper {
public ConsolidateResult consolidateDatabaseStep1(Progressable progress) { public ConsolidateResult consolidateDatabaseStep1(Progressable progress) {
// 1a. fetch all secret keyrings into a cache file // 1a. fetch all secret keyrings into a cache file
log(LogLevel.START, LogType.MSG_CON, mIndent); log(LogLevel.START, LogType.MSG_CON);
mIndent += 1; mIndent += 1;
try { try {
log(LogLevel.DEBUG, LogType.MSG_CON_SAVE_SECRET, mIndent); log(LogLevel.DEBUG, LogType.MSG_CON_SAVE_SECRET);
mIndent += 1; mIndent += 1;
final Cursor cursor = mContentResolver.query(KeyRings.buildUnifiedKeyRingsUri(), new String[]{ final Cursor cursor = mContentResolver.query(KeyRings.buildUnifiedKeyRingsUri(), new String[]{
@ -842,6 +842,7 @@ public class ProviderHelper {
}, KeyRings.HAS_ANY_SECRET + " = 1", null, null); }, KeyRings.HAS_ANY_SECRET + " = 1", null, null);
if (cursor == null || !cursor.moveToFirst()) { if (cursor == null || !cursor.moveToFirst()) {
log(LogLevel.ERROR, LogType.MSG_CON_ERROR_DB);
return new ConsolidateResult(ConsolidateResult.RESULT_ERROR, mLog); return new ConsolidateResult(ConsolidateResult.RESULT_ERROR, mLog);
} }
@ -883,7 +884,8 @@ public class ProviderHelper {
}); });
} catch (IOException e) { } catch (IOException e) {
Log.e(Constants.TAG, "error saving secret"); Log.e(Constants.TAG, "error saving secret", e);
log(LogLevel.ERROR, LogType.MSG_CON_ERROR_IO_SECRET);
return new ConsolidateResult(ConsolidateResult.RESULT_ERROR, mLog); return new ConsolidateResult(ConsolidateResult.RESULT_ERROR, mLog);
} finally { } finally {
mIndent -= 1; mIndent -= 1;
@ -892,7 +894,7 @@ public class ProviderHelper {
// 1b. fetch all public keyrings into a cache file // 1b. fetch all public keyrings into a cache file
try { try {
log(LogLevel.DEBUG, LogType.MSG_CON_SAVE_PUBLIC, mIndent); log(LogLevel.DEBUG, LogType.MSG_CON_SAVE_PUBLIC);
mIndent += 1; mIndent += 1;
final Cursor cursor = mContentResolver.query(KeyRings.buildUnifiedKeyRingsUri(), new String[]{ final Cursor cursor = mContentResolver.query(KeyRings.buildUnifiedKeyRingsUri(), new String[]{
@ -900,10 +902,11 @@ public class ProviderHelper {
}, null, null, null); }, null, null, null);
if (cursor == null || !cursor.moveToFirst()) { if (cursor == null || !cursor.moveToFirst()) {
log(LogLevel.ERROR, LogType.MSG_CON_ERROR_DB);
return new ConsolidateResult(ConsolidateResult.RESULT_ERROR, mLog); return new ConsolidateResult(ConsolidateResult.RESULT_ERROR, mLog);
} }
Preferences.getPreferences(mContext).setCachedConsolidateNumSecrets(cursor.getCount()); Preferences.getPreferences(mContext).setCachedConsolidateNumPublics(cursor.getCount());
FileImportCache<ParcelableKeyRing> cache = FileImportCache<ParcelableKeyRing> cache =
new FileImportCache<ParcelableKeyRing>(mContext, "consolidate_public.pcl"); new FileImportCache<ParcelableKeyRing>(mContext, "consolidate_public.pcl");
@ -941,31 +944,48 @@ public class ProviderHelper {
}); });
} catch (IOException e) { } catch (IOException e) {
Log.e(Constants.TAG, "error saving public"); Log.e(Constants.TAG, "error saving public", e);
log(LogLevel.ERROR, LogType.MSG_CON_ERROR_IO_PUBLIC);
return new ConsolidateResult(ConsolidateResult.RESULT_ERROR, mLog); return new ConsolidateResult(ConsolidateResult.RESULT_ERROR, mLog);
} finally { } finally {
mIndent -= 1; mIndent -= 1;
} }
log(LogLevel.INFO, LogType.MSG_CON_CRITICAL_IN);
Preferences.getPreferences(mContext).setCachedConsolidate(true); Preferences.getPreferences(mContext).setCachedConsolidate(true);
return consolidateDatabaseStep2(progress); return consolidateDatabaseStep2(progress, false);
} }
public ConsolidateResult consolidateDatabaseStep2(Progressable progress) { public ConsolidateResult consolidateDatabaseStep2(Progressable progress) {
return consolidateDatabaseStep2(progress, true);
}
private ConsolidateResult consolidateDatabaseStep2(Progressable progress, boolean recovery) {
Preferences prefs = Preferences.getPreferences(mContext); Preferences prefs = Preferences.getPreferences(mContext);
if ( ! prefs.getCachedConsolidate()) {
log(LogLevel.ERROR, LogType.MSG_CON_ERROR_BAD_STATE);
return new ConsolidateResult(ConsolidateResult.RESULT_ERROR, mLog);
}
// Set flag that we have a cached consolidation here // Set flag that we have a cached consolidation here
int numSecrets = prefs.getCachedConsolidateNumSecrets(); int numSecrets = prefs.getCachedConsolidateNumSecrets();
int numPublics = prefs.getCachedConsolidateNumPublics(); int numPublics = prefs.getCachedConsolidateNumPublics();
if (recovery) {
if (numSecrets >= 0 && numPublics >= 0) {
log(LogLevel.START, LogType.MSG_CON_RECOVER, numSecrets, Integer.toString(numPublics));
} else {
log(LogLevel.START, LogType.MSG_CON_RECOVER_UNKNOWN);
}
mIndent += 1;
}
if ( ! prefs.getCachedConsolidate()) {
log(LogLevel.ERROR, LogType.MSG_CON_ERROR_BAD_STATE);
return new ConsolidateResult(ConsolidateResult.RESULT_ERROR, mLog);
}
// 2. wipe database (IT'S DANGEROUS) // 2. wipe database (IT'S DANGEROUS)
log(LogLevel.DEBUG, LogType.MSG_CON_DB_CLEAR, mIndent); log(LogLevel.DEBUG, LogType.MSG_CON_DB_CLEAR);
new KeychainDatabase(mContext).clearDatabase(); new KeychainDatabase(mContext).clearDatabase();
FileImportCache<ParcelableKeyRing> cacheSecret = FileImportCache<ParcelableKeyRing> cacheSecret =
@ -974,51 +994,71 @@ public class ProviderHelper {
new FileImportCache<ParcelableKeyRing>(mContext, "consolidate_public.pcl"); new FileImportCache<ParcelableKeyRing>(mContext, "consolidate_public.pcl");
// 3. Re-Import secret keyrings from cache // 3. Re-Import secret keyrings from cache
try { if (numSecrets > 0) try {
log(LogLevel.DEBUG, LogType.MSG_CON_REIMPORT_SECRET, mIndent, numSecrets); log(LogLevel.DEBUG, LogType.MSG_CON_REIMPORT_SECRET, numSecrets);
mIndent += 1; mIndent += 1;
new PgpImportExport(mContext, this, new ProgressFixedScaler(progress, 10, 25, 100, R.string.progress_con_reimport)) new PgpImportExport(mContext, this,
new ProgressFixedScaler(progress, 10, 25, 100, R.string.progress_con_reimport))
.importKeyRings(cacheSecret.readCache(false), numSecrets); .importKeyRings(cacheSecret.readCache(false), numSecrets);
} catch (IOException e) { } catch (IOException e) {
Log.e(Constants.TAG, "error importing secret"); Log.e(Constants.TAG, "error importing secret", e);
log(LogLevel.ERROR, LogType.MSG_CON_ERROR_SECRET);
return new ConsolidateResult(ConsolidateResult.RESULT_ERROR, mLog); return new ConsolidateResult(ConsolidateResult.RESULT_ERROR, mLog);
} finally { } finally {
mIndent -= 1; mIndent -= 1;
} else {
log(LogLevel.DEBUG, LogType.MSG_CON_REIMPORT_SECRET_SKIP);
} }
// 4. Re-Import public keyrings from cache // 4. Re-Import public keyrings from cache
try { if (numPublics > 0) try {
log(LogLevel.DEBUG, LogType.MSG_CON_REIMPORT_PUBLIC, mIndent, numPublics); log(LogLevel.DEBUG, LogType.MSG_CON_REIMPORT_PUBLIC, numPublics);
mIndent += 1; mIndent += 1;
new PgpImportExport(mContext, this, new ProgressScaler(progress, 25, 99, 100)) new PgpImportExport(mContext, this,
new ProgressFixedScaler(progress, 25, 99, 100, R.string.progress_con_reimport))
.importKeyRings(cachePublic.readCache(false), numPublics); .importKeyRings(cachePublic.readCache(false), numPublics);
} catch (IOException e) { } catch (IOException e) {
Log.e(Constants.TAG, "error importing public"); Log.e(Constants.TAG, "error importing public", e);
log(LogLevel.ERROR, LogType.MSG_CON_ERROR_PUBLIC);
return new ConsolidateResult(ConsolidateResult.RESULT_ERROR, mLog); return new ConsolidateResult(ConsolidateResult.RESULT_ERROR, mLog);
} finally { } finally {
mIndent -= 1; mIndent -= 1;
} else {
log(LogLevel.DEBUG, LogType.MSG_CON_REIMPORT_PUBLIC_SKIP);
} }
log(LogLevel.INFO, LogType.MSG_CON_CRITICAL_OUT);
Preferences.getPreferences(mContext).setCachedConsolidate(false); Preferences.getPreferences(mContext).setCachedConsolidate(false);
// 5. Delete caches // 5. Delete caches
try { try {
log(LogLevel.DEBUG, LogType.MSG_CON_DELETE_SECRET);
mIndent += 1;
cacheSecret.delete(); cacheSecret.delete();
} catch (IOException e) { } catch (IOException e) {
// doesn't really matter // doesn't /really/ matter
Log.e(Constants.TAG, "IOException during delete of secret cache", e); Log.e(Constants.TAG, "IOException during delete of secret cache", e);
log(LogLevel.WARN, LogType.MSG_CON_WARN_DELETE_SECRET);
} finally {
mIndent -= 1;
} }
try { try {
log(LogLevel.DEBUG, LogType.MSG_CON_DELETE_PUBLIC);
mIndent += 1;
cachePublic.delete(); cachePublic.delete();
} catch (IOException e) { } catch (IOException e) {
// doesn't really matter // doesn't /really/ matter
Log.e(Constants.TAG, "IOException during deletion of public cache", e); Log.e(Constants.TAG, "IOException during deletion of public cache", e);
log(LogLevel.WARN, LogType.MSG_CON_WARN_DELETE_PUBLIC);
} finally {
mIndent -= 1;
} }
progress.setProgress(100, 100); progress.setProgress(100, 100);
log(LogLevel.OK, LogType.MSG_CON_SUCCESS, mIndent); log(LogLevel.OK, LogType.MSG_CON_SUCCESS);
mIndent -= 1; mIndent -= 1;
return new ConsolidateResult(ConsolidateResult.RESULT_OK, mLog); return new ConsolidateResult(ConsolidateResult.RESULT_OK, mLog);

27
OpenKeychain/src/main/java/org/sufficientlysecure/keychain/service/OperationResultParcel.java
View File

@ -390,14 +390,29 @@ public class OperationResultParcel implements Parcelable {
MSG_MF_UNLOCK (R.string.msg_mf_unlock), MSG_MF_UNLOCK (R.string.msg_mf_unlock),
// consolidate // consolidate
MSG_CON (R.string.msg_con), MSG_CON_CRITICAL_IN (R.string.msg_con_critical_in),
MSG_CON_ERROR_BAD_STATE (R.string.msg_con_error_bad_state), MSG_CON_CRITICAL_OUT (R.string.msg_con_critical_out),
MSG_CON_SAVE_SECRET (R.string.msg_con_save_secret),
MSG_CON_SAVE_PUBLIC (R.string.msg_con_save_public),
MSG_CON_DB_CLEAR (R.string.msg_con_db_clear), MSG_CON_DB_CLEAR (R.string.msg_con_db_clear),
MSG_CON_REIMPORT_SECRET (R.plurals.msg_con_reimport_secret), MSG_CON_DELETE_PUBLIC (R.string.msg_con_delete_public),
MSG_CON_REIMPORT_PUBLIC (R.plurals.msg_con_reimport_public), MSG_CON_DELETE_SECRET (R.string.msg_con_delete_secret),
MSG_CON_ERROR_BAD_STATE (R.string.msg_con_error_bad_state),
MSG_CON_ERROR_DB (R.string.msg_con_error_db),
MSG_CON_ERROR_IO_PUBLIC (R.string.msg_con_error_io_public),
MSG_CON_ERROR_IO_SECRET (R.string.msg_con_error_io_secret),
MSG_CON_ERROR_PUBLIC (R.string.msg_con_error_public),
MSG_CON_ERROR_SECRET (R.string.msg_con_error_secret),
MSG_CON_RECOVER (R.plurals.msg_con_recover),
MSG_CON_RECOVER_UNKNOWN (R.string.msg_con_recover_unknown),
MSG_CON_REIMPORT_PUBLIC (R.string.msg_con_reimport_public),
MSG_CON_REIMPORT_PUBLIC_SKIP (R.string.msg_con_reimport_public_skip),
MSG_CON_REIMPORT_SECRET (R.string.msg_con_reimport_secret),
MSG_CON_REIMPORT_SECRET_SKIP (R.string.msg_con_reimport_secret_skip),
MSG_CON (R.string.msg_con),
MSG_CON_SAVE_PUBLIC (R.string.msg_con_save_public),
MSG_CON_SAVE_SECRET (R.string.msg_con_save_secret),
MSG_CON_SUCCESS (R.string.msg_con_success), MSG_CON_SUCCESS (R.string.msg_con_success),
MSG_CON_WARN_DELETE_PUBLIC (R.string.msg_con_warn_delete_public),
MSG_CON_WARN_DELETE_SECRET (R.string.msg_con_warn_delete_secret),
; ;
private final int mMsgId; private final int mMsgId;

28
OpenKeychain/src/main/res/values/strings.xml
View File

@ -677,15 +677,33 @@
<string name="msg_con_save_secret">Saving secret keyrings</string> <string name="msg_con_save_secret">Saving secret keyrings</string>
<string name="msg_con_save_public">Saving public keyrings</string> <string name="msg_con_save_public">Saving public keyrings</string>
<string name="msg_con_db_clear">Clearing database</string> <string name="msg_con_db_clear">Clearing database</string>
<plurals name="msg_con_reimport_secret"> <string name="msg_con_success">Successfully consolidated database</string>
<item quantity="one">Reimporting one secret key</item> <string name="msg_con_critical_in">Entering critical phase</string>
<item quantity="other">Reimporting %d secret keys</item> <string name="msg_con_critical_out">Leaving critical phase</string>
<string name="msg_con_delete_public">Deleting public keyring cache file</string>
<string name="msg_con_delete_secret">Deleting secret keyring cache file</string>
<string name="msg_con_error_db">Error opening database!</string>
<string name="msg_con_error_io_public">IO error writing public keys to cache!</string>
<string name="msg_con_error_io_secret">IO error writing secret keys to cache!</string>
<string name="msg_con_error_public">Error reimporting public keys!</string>
<string name="msg_con_error_secret">Error reimporting secret keys!</string>
<plurals name="msg_con_recover">
<item quantity="one">Recovering consolidation with one secret and %s public keys</item>
<item quantity="many">Recovering consolidation with %d secret and %s public keys</item>
</plurals> </plurals>
<string name="msg_con_recover_unknown">Recovering from unknown state</string>
<plurals name="msg_con_reimport_public"> <plurals name="msg_con_reimport_public">
<item quantity="one">Reimporting one public key</item> <item quantity="one">Reimporting one public key</item>
<item quantity="other">Reimporting %d public keys</item> <item quantity="many">Reimporting %d public keys</item>
</plurals> </plurals>
<string name="msg_con_success">Successfully consolidated database</string> <string name="msg_con_reimport_public_skip">No public keys to reimport, skipping…</string>
<plurals name="msg_con_reimport_secret">
<item quantity="one">Reimporting one secret key</item>
<item quantity="many">Reimporting %d secret keys</item>
</plurals>
<string name="msg_con_reimport_secret_skip">No secret keys to reimport, skipping…</string>
<string name="msg_con_warn_delete_public">Exception deleting public cache file</string>
<string name="msg_con_warn_delete_secret">Exception deleting public cache file</string>
<!-- PassphraseCache --> <!-- PassphraseCache -->
<string name="passp_cache_notif_click_to_clear">Click to clear cached passphrases</string> <string name="passp_cache_notif_click_to_clear">Click to clear cached passphrases</string>