it is now possible to cancel word importing

Author: sspanak

app/src/main/java/io/github/sspanak/tt9/db/customWords/AbstractFileProcessor.java

@@ -7,13 +7,18 @@
 import java.util.function.Consumer;
 
 abstract public class AbstractFileProcessor {
+	protected Runnable cancelHandler;
 	protected Runnable failureHandler;
 	protected Runnable startHandler;
 	protected Consumer<String> successHandler;
 
 	private Thread processThread;
 	protected String statusMessage = "";
 
+	public boolean isCanceled() {
+		return processThread != null && processThread.isInterrupted();
+	}
+
 	public boolean isRunning() {
 		return processThread != null && processThread.isAlive();
 	}
@@ -22,6 +27,12 @@ public String getStatusMessage() {
 		return statusMessage;
 	}
 
+	protected void sendCancel() {
+		if (cancelHandler != null) {
+			cancelHandler.run();
+		}
+	}
+
 	protected void sendFailure() {
 		if (failureHandler != null) {
 			failureHandler.run();
@@ -35,6 +46,10 @@ protected void sendStart(@NonNull String message) {
 		}
 	}
 
+	public void setCancelHandler(Runnable handler) {
+		cancelHandler = handler;
+	}
+
 	public void setFailureHandler(Runnable handler) {
 		failureHandler = handler;
 	}
@@ -47,6 +62,12 @@ public void setSuccessHandler(Consumer<String> handler) {
 		successHandler = handler;
 	}
 
+	public void cancel() {
+		if (isRunning()) {
+			processThread.interrupt();
+		}
+	}
+
 	public boolean run(@NonNull Activity activity) {
 		if (isRunning()) {
 			return false;

app/src/main/java/io/github/sspanak/tt9/db/customWords/CustomWordsImporter.java

@@ -51,6 +51,7 @@ private CustomWordsImporter(Context context) {
 
 
 	public void clearAllHandlers() {
+		cancelHandler = null;
 		failureHandler = null;
 		progressHandler = null;
 		successHandler = null;
@@ -107,8 +108,13 @@ protected void runSync(Activity activity) {
 
 		sendStart(resources.getString(R.string.dictionary_import_running));
 		if (isFileValid() && isThereRoomForMoreWords(activity) && isLineCountValid() && insertWords()) {
-			sendSuccess();
-			Logger.i(getClass().getSimpleName(), "Imported " + file.getName() + " in " + Timer.get(getClass().getSimpleName()) + " ms");
+			if (isCanceled()) {
+				sendCancel();
+				Logger.i(getClass().getSimpleName(), "Importing cancelled after " + Timer.get(getClass().getSimpleName()) + " ms");
+			} else {
+				sendSuccess();
+				Logger.i(getClass().getSimpleName(), "Imported " + file.getName() + " in " + Timer.get(getClass().getSimpleName()) + " ms");
+			}
 		} else {
 			Logger.e(getClass().getSimpleName(), "Failed to import " + file.getName());
 		}
@@ -136,6 +142,11 @@ private boolean insertWords() {
 			sqlite.beginTransaction();
 
 			for (String line; (line = reader.readLine()) != null; lineCount++) {
+				if (isCanceled()) {
+					sqlite.failTransaction();
+					return true;
+				}
+
 				CustomWord customWord = createCustomWord(line, lineCount);
 				if (customWord == null) {
 					sqlite.failTransaction();

app/src/main/java/io/github/sspanak/tt9/preferences/screens/languages/ItemImportCustomWords.java

@@ -37,9 +37,15 @@ protected CustomWordsImporter getProcessor() {
 	@Override
 	protected boolean onClick(Preference p) {
 		setDefaultHandlers();
+		getProcessor().setCancelHandler(this::onCancel);
 		getProcessor().setFailureHandler(this::onFailure);
 		getProcessor().setProgressHandler(this::onProgress);
-		browseFiles();
+
+		if (getProcessor().isRunning()) {
+			getProcessor().cancel();
+		} else {
+			browseFiles();
+		}
 		return true;
 	}
 
@@ -50,6 +56,18 @@ protected boolean onStartProcessing() {
 		return false;
 	}
 
+	private void onCancel() {
+		activity.runOnUiThread(() -> {
+			final String statusMsg = activity.getString(R.string.dictionary_import_canceled);
+
+			setAndNotifyReady();
+			DictionaryProgressNotification.getInstance(activity).showMessage("", statusMsg, statusMsg);
+
+			item.setTitle(R.string.dictionary_import_custom_words);
+			item.setSummary(statusMsg);
+		});
+	}
+
 	private void onProgress(float progress) {
 		final String numberFormat = (progress - lastProgress) < 2 ? "%1.3f%%" : "%1.0f%%";
 		final String loadingMsg = activity.getString(R.string.dictionary_import_progress, String.format(Locale.getDefault(), numberFormat, progress));
@@ -87,7 +105,12 @@ protected String getSuccessTitle() {
 	@Override
 	public void enable() {
 		item.setSummary(R.string.dictionary_import_custom_words_summary);
-		super.enable();
+	}
+
+	@Override
+	public void disable() {
+		// we don't really disable this item, we just prevent browsing for files
+		item.setTitle(R.string.dictionary_import_cancel);
 	}
 
 	void setBrowseFilesLauncher(ActivityResultLauncher<Intent> launcher) {

app/src/main/res/values-bg/strings.xml

@@ -203,6 +203,7 @@
 	<string name="function_redo">Повторение (Redo)</string>
 	<string name="function_voice_input">Гласово въвеждане</string>
 	<string name="add_word_no_confirmation">Добавяне без потвърждение</string>
+	<string name="dictionary_import_canceled">Импортирането е отменено.</string>
 	<string name="dictionary_import_custom_words">Импортирай</string>
 	<string name="dictionary_import_custom_words_summary">Импортиране на думи от по-рано експортирано CSV.</string>
 	<string name="dictionary_import_progress">Импортиране на CSV (%1$s)…</string>
@@ -271,4 +272,5 @@
 	<string name="edit_word_invalid_characters">Не може да се редактира „%1$s“, когато езикът е „%2$s“.</string>
 	<string name="edit_word_not_available_in_language">Редактирането на думи не е възможно за този език.</string>
 	<string name="dictionary_import_raise_import_limits">Повишаване на ограниченията за импорт</string>
+	<string name="dictionary_import_cancel">Отмяна на импортирането</string>
 </resources>

app/src/main/res/values-de/strings.xml

@@ -190,6 +190,7 @@
 	<string name="function_next_mode">Nächster Eingabemodus</string>
 	<string name="function_select_keyboard">Tastaturauswahl</string>
 	<string name="add_word_no_confirmation">Ohne Bestätigung hinzufügen</string>
+	<string name="dictionary_import_canceled">Import abgebrochen.</string>
 	<string name="dictionary_import_custom_words">Importieren</string>
 	<string name="dictionary_import_custom_words_summary">Wörter aus einer zuvor exportierten CSV-Datei importieren.</string>
 	<string name="dictionary_import_progress">CSV importieren (%1$s)…</string>
@@ -273,4 +274,5 @@
 	<string name="edit_word_invalid_characters">„%1$s“ kann nicht bearbeitet werden, wenn die Sprache „%2$s“ ist.</string>
 	<string name="edit_word_not_available_in_language">Das Bearbeiten von Wörtern ist in dieser Sprache nicht möglich.</string>
 	<string name="dictionary_import_raise_import_limits">Importbeschränkungen erhöhen</string>
+	<string name="dictionary_import_cancel">Import abbrechen</string>
 </resources>

app/src/main/res/values-es/strings.xml

@@ -203,6 +203,7 @@
 	<string name="virtual_numpad_alignment_right">A la derecha</string>
 	<string name="function_select_keyboard">Cambiar el teclado</string>
 	<string name="add_word_no_confirmation">Añadir sin confirmación</string>
+	<string name="dictionary_import_canceled">Importación cancelada.</string>
 	<string name="dictionary_import_custom_words">Importar</string>
 	<string name="dictionary_import_custom_words_summary">Importar palabras de un CSV previamente exportado.</string>
 	<string name="dictionary_import_progress">Importando CSV (%1$s)…</string>
@@ -271,4 +272,5 @@
 	<string name="edit_word_invalid_characters">No se puede editar \"%1$s\" cuando el idioma es \"%2$s\".</string>
 	<string name="edit_word_not_available_in_language">No es posible editar palabras en este idioma.</string>
 	<string name="dictionary_import_raise_import_limits">Aumentar restricciones de importación</string>
+	<string name="dictionary_import_cancel">Cancelar importación</string>
 </resources>

app/src/main/res/values-fr/strings.xml

@@ -201,6 +201,7 @@
 	<string name="virtual_numpad_alignment_right">À droite</string>
 	<string name="function_select_keyboard">Choisir le clavier</string>
 	<string name="add_word_no_confirmation">Ajouter sans confirmation</string>
+	<string name="dictionary_import_canceled">Importation annulée.</string>
 	<string name="dictionary_import_custom_words">Importer</string>
 	<string name="dictionary_import_custom_words_summary">Importer des mots à partir d\'un fichier CSV précédemment exporté.</string>
 	<string name="dictionary_import_progress">Importation de CSV (%1$s)…</string>
@@ -271,4 +272,5 @@
 	<string name="edit_word_invalid_characters">Impossible de modifier « %1$s » lorsque la langue est « %2$s ».</string>
 	<string name="edit_word_not_available_in_language">La modification des mots n’est pas possible dans cette langue.</string>
 	<string name="dictionary_import_raise_import_limits">Augmenter les restrictions d’importation</string>
+	<string name="dictionary_import_cancel">Annuler l’importation</string>
 </resources>

app/src/main/res/values-it/strings.xml

@@ -188,6 +188,7 @@
 	<string name="virtual_numpad_alignment_left">A sinistra</string>
 	<string name="virtual_numpad_alignment_right">A destra</string>
 	<string name="add_word_no_confirmation">Aggiungere senza conferma</string>
+	<string name="dictionary_import_canceled">Importazione annullata.</string>
 	<string name="dictionary_import_custom_words">Importare</string>
 	<string name="dictionary_import_custom_words_summary">Importare parole da un CSV precedentemente esportato.</string>
 	<string name="dictionary_import_progress">Importazione CSV (%1$s)…</string>
@@ -274,5 +275,6 @@
 	<string name="edit_word_invalid_characters">Impossibile modificare \"%1$s\" quando la lingua è \"%2$s\".</string>
 	<string name="edit_word_not_available_in_language">La modifica delle parole non è possibile in questa lingua.</string>
 	<string name="dictionary_import_raise_import_limits">Aumentare le restrizioni di importazione</string>
+	<string name="dictionary_import_cancel">Annulla importazione</string>
 </resources>
 

app/src/main/res/values-iw/strings.xml

@@ -202,6 +202,7 @@
 	<string name="virtual_numpad_alignment_right">ימינה</string>
 	<string name="function_select_keyboard">בחירת מקלדת</string>
 	<string name="add_word_no_confirmation">להוסיף ללא אישור</string>
+	<string name="dictionary_import_canceled">הייבוא בוטל.</string>
 	<string name="dictionary_import_custom_words">לְיַבֵּא</string>
 	<string name="dictionary_import_custom_words_summary">ייבוא מילים מקובץ CSV שיוצא קודם לכן.</string>
 	<string name="dictionary_import_progress">מייבא CSV (%1$s)…</string>
@@ -278,4 +279,5 @@
 	<string name="edit_word_invalid_characters">לא ניתן לערוך \"%1$s\" כאשר השפה היא \"%2$s\".</string>
 	<string name="edit_word_not_available_in_language">עריכת מילים אינה אפשרית בשפה זו.</string>
 	<string name="dictionary_import_raise_import_limits">הגדלת מגבלות הייבוא</string>
+	<string name="dictionary_import_cancel">ביטול הייבוא</string>
 </resources>

app/src/main/res/values-lt/strings.xml

@@ -212,6 +212,7 @@
 	<string name="virtual_numpad_alignment_right">Dešinėje</string>
 	<string name="function_select_keyboard">Keisti klaviatūrą</string>
 	<string name="add_word_no_confirmation">Pridėti be patvirtinimo</string>
+	<string name="dictionary_import_canceled">Importavimas atšauktas.</string>
 	<string name="dictionary_import_custom_words">Importuoti</string>
 	<string name="dictionary_import_custom_words_summary">Importuoti žodžius iš anksčiau eksportuoto CSV.</string>
 	<string name="dictionary_import_progress">Importuojamas CSV (%1$s)…</string>
@@ -280,4 +281,5 @@
 	<string name="edit_word_invalid_characters">Negalima redaguoti „%1$s“, kai kalba yra „%2$s“.</string>
 	<string name="edit_word_not_available_in_language">Žodžių redagavimas šia kalba negalimas.</string>
 	<string name="dictionary_import_raise_import_limits">Padidinti importo apribojimus</string>
+	<string name="dictionary_import_cancel">Atšaukti importavimą</string>
 </resources>