use of com.ichi2.async.Connection.ConflictResolution.FULL_DOWNLOAD in project Anki-Android by ankidroid.
the class Connection method doInBackgroundSync.
/**
* In the payload, success means that the sync did occur correctly and that a change did occur.
* So success can be false without error, if no change occurred at all.
*/
private Payload doInBackgroundSync(Payload data) {
sIsCancellable = true;
Timber.d("doInBackgroundSync()");
// Block execution until any previous background task finishes, or timeout after 5s
boolean ok = TaskManager.waitToFinish(5);
// Unique key allowing to identify the user to AnkiWeb without password
String hkey = (String) data.data[0];
// Whether media should be synced too
boolean media = (Boolean) data.data[1];
// If normal sync can't occur, what to do
ConflictResolution conflictResolution = (ConflictResolution) data.data[2];
// A number AnkiWeb told us to send back. Probably to choose the best server for the user
HostNum hostNum = (HostNum) data.data[3];
// Use safe version that catches exceptions so that full sync is still possible
Collection col = CollectionHelper.getInstance().getColSafe(AnkiDroidApp.getInstance());
boolean colCorruptFullSync = false;
if (!CollectionHelper.getInstance().colIsOpen() || !ok) {
if (FULL_DOWNLOAD == conflictResolution) {
colCorruptFullSync = true;
} else {
return returnGenericError(data);
}
}
try {
CollectionHelper.getInstance().lockCollection();
RemoteServer remoteServer = new RemoteServer(this, hkey, hostNum);
Syncer client = new Syncer(col, remoteServer, hostNum);
// run sync and check state
boolean noChanges = false;
if (conflictResolution == null) {
Timber.i("Sync - starting sync");
publishProgress(R.string.sync_prepare_syncing);
Pair<ConnectionResultType, Object> ret = client.sync(this);
data.message = client.getSyncMsg();
if (ret == null) {
return returnGenericError(data);
}
if (NO_CHANGES != ret.first && SUCCESS != ret.first) {
data.success = false;
data.resultType = ret.first;
data.result = new Object[] { ret.second };
// Check if there was a sanity check error
if (SANITY_CHECK_ERROR == ret.first) {
// Force full sync next time
col.modSchemaNoCheck();
col.save();
}
return data;
}
// save and note success state
if (NO_CHANGES == ret.first) {
// publishProgress(R.string.sync_no_changes_message);
noChanges = true;
}
} else {
try {
// Disable sync cancellation for full-sync
sIsCancellable = false;
FullSyncer fullSyncServer = new FullSyncer(col, hkey, this, hostNum);
switch(conflictResolution) {
case FULL_UPLOAD:
{
Timber.i("Sync - fullsync - upload collection");
publishProgress(R.string.sync_preparing_full_sync_message);
Pair<ConnectionResultType, Object[]> ret = fullSyncServer.upload();
col.reopen();
if (ret == null) {
return returnGenericError(data);
}
if (ret.first == ARBITRARY_STRING && !ret.second[0].equals(HttpSyncer.ANKIWEB_STATUS_OK)) {
data.success = false;
data.resultType = ret.first;
data.result = ret.second;
return data;
}
break;
}
case FULL_DOWNLOAD:
{
Timber.i("Sync - fullsync - download collection");
publishProgress(R.string.sync_downloading_message);
ConnectionResultType ret = fullSyncServer.download();
if (ret == null) {
Timber.w("Sync - fullsync - unknown error");
return returnGenericError(data);
}
if (SUCCESS == ret) {
data.success = true;
col.reopen();
}
if (SUCCESS != ret) {
Timber.w("Sync - fullsync - download failed");
data.success = false;
data.resultType = ret;
if (!colCorruptFullSync) {
col.reopen();
}
return data;
}
break;
}
default:
}
} catch (OutOfMemoryError e) {
Timber.w(e);
AnkiDroidApp.sendExceptionReport(e, "doInBackgroundSync-fullSync");
data.success = false;
data.resultType = OUT_OF_MEMORY_ERROR;
data.result = new Object[0];
return data;
} catch (RuntimeException e) {
Timber.w(e);
if (timeoutOccurred(e)) {
data.resultType = CONNECTION_ERROR;
} else if (USER_ABORTED_SYNC.toString().equals(e.getMessage())) {
data.resultType = USER_ABORTED_SYNC;
} else {
AnkiDroidApp.sendExceptionReport(e, "doInBackgroundSync-fullSync");
data.resultType = IO_EXCEPTION;
}
data.result = new Object[] { e };
data.success = false;
return data;
}
}
// clear undo to avoid non syncing orphans (because undo resets usn too
if (!noChanges) {
col.clearUndo();
}
// then move on to media sync
sIsCancellable = true;
boolean noMediaChanges = false;
String mediaError = null;
if (media) {
RemoteMediaServer mediaServer = new RemoteMediaServer(col, hkey, this, hostNum);
MediaSyncer mediaClient = new MediaSyncer(col, mediaServer, this);
Pair<ConnectionResultType, String> ret;
try {
Timber.i("Sync - Performing media sync");
ret = mediaClient.sync();
if (ret == null || ret.first == null) {
mediaError = AnkiDroidApp.getAppResources().getString(R.string.sync_media_error);
} else {
if (CORRUPT == ret.first) {
mediaError = AnkiDroidApp.getAppResources().getString(R.string.sync_media_db_error);
noMediaChanges = true;
}
if (NO_CHANGES == ret.first) {
publishProgress(R.string.sync_media_no_changes);
noMediaChanges = true;
}
if (MEDIA_SANITY_FAILED == ret.first) {
mediaError = AnkiDroidApp.getAppResources().getString(R.string.sync_media_sanity_failed);
} else {
publishProgress(R.string.sync_media_success);
}
}
} catch (RuntimeException e) {
Timber.w(e);
if (timeoutOccurred(e)) {
data.resultType = CONNECTION_ERROR;
data.result = new Object[] { e };
} else if (USER_ABORTED_SYNC.toString().equals(e.getMessage())) {
data.resultType = USER_ABORTED_SYNC;
data.result = new Object[] { e };
}
int downloadedCount = mediaClient.getDownloadCount();
int uploadedCount = mediaClient.getUploadCount();
if (downloadedCount == 0 && uploadedCount == 0) {
mediaError = AnkiDroidApp.getAppResources().getString(R.string.sync_media_error) + "\n\n" + e.getLocalizedMessage();
} else {
mediaError = AnkiDroidApp.getAppResources().getString(R.string.sync_media_partial_updated, downloadedCount, uploadedCount) + "\n\n" + e.getLocalizedMessage();
}
}
}
if (noChanges && (!media || noMediaChanges)) {
// This means that there is no change at all, neither media nor collection. Not that there was an error.
data.success = false;
data.resultType = NO_CHANGES;
data.result = new Object[0];
} else {
data.success = true;
data.data = new Object[] { conflictResolution, col, mediaError };
}
return data;
} catch (MediaSyncException e) {
Timber.e("Media sync rejected by server");
data.success = false;
data.resultType = MEDIA_SYNC_SERVER_ERROR;
data.result = new Object[] { e };
AnkiDroidApp.sendExceptionReport(e, "doInBackgroundSync");
return data;
} catch (UnknownHttpResponseException e) {
Timber.e(e, "doInBackgroundSync -- unknown response code error");
data.success = false;
int code = e.getResponseCode();
String msg = e.getLocalizedMessage();
data.resultType = ERROR;
data.result = new Object[] { code, msg };
return data;
} catch (Exception e) {
// Global error catcher.
// Try to give a human readable error, otherwise print the raw error message
Timber.e(e, "doInBackgroundSync error");
data.success = false;
if (timeoutOccurred(e)) {
data.resultType = CONNECTION_ERROR;
data.result = new Object[] { e };
} else if (USER_ABORTED_SYNC.toString().equals(e.getMessage())) {
data.resultType = USER_ABORTED_SYNC;
data.result = new Object[] { e };
} else {
AnkiDroidApp.sendExceptionReport(e, "doInBackgroundSync");
data.resultType = ARBITRARY_STRING;
data.result = new Object[] { e.getLocalizedMessage(), e };
}
return data;
} finally {
Timber.i("Sync Finished - Closing Collection");
// don't bump mod time unless we explicitly save
if (col != null) {
col.close(false);
}
CollectionHelper.getInstance().unlockCollection();
}
}
Aggregations