diff --git a/app/src/main/AndroidManifest.xml b/app/src/main/AndroidManifest.xml index b8f47183..261db7d7 100644 --- a/app/src/main/AndroidManifest.xml +++ b/app/src/main/AndroidManifest.xml @@ -27,6 +27,7 @@ + ) getIntent().getSerializableExtra(EXTRA_CLASS)).getConstructor(Activity.class).newInstance(this); + } catch (Exception e) { + AndroidUtils.assertError("Unable to instantiate the JsonEditorInterface", e); + Toast.makeText(this, R.string.invalid, Toast.LENGTH_SHORT).show(); + finish(); + return; + } + + info = findViewById(R.id.info); + this.findViewById(R.id.description).setText(provider.getEditorDescription()); + + editor = findViewById(R.id.data); + editor.setText(noFailToString(provider.getJson())); + + } + + @Override + public boolean onCreateOptionsMenu(Menu menu) { + getMenuInflater().inflate(R.menu.activity_json_editor, menu); + AndroidUtils.fixMenuIconColor(menu.findItem(R.id.menu_format), this); + return super.onCreateOptionsMenu(menu); + } + + @Override + public boolean onOptionsItemSelected(MenuItem item) { + switch (item.getItemId()) { + // press the 'back' button in the action bar to go back + case android.R.id.home -> onBackPressed(); + // format content + case R.id.menu_format -> format(); + // save + case R.id.menu_save -> save(); + // discard + case R.id.menu_discard -> discard(); + // reset + case R.id.menu_reset -> reset(); + // toggle info visibility + case R.id.menu_show_info -> { + item.setChecked(!item.isChecked()); + info.setVisibility(item.isChecked() ? View.VISIBLE : View.GONE); + } + + default -> { + return super.onOptionsItemSelected(item); + } + } + return true; + } + + @Override + public void onBackPressed() { + // validate + JSONObject currentData; + try { + currentData = new JSONObject(editor.getText().toString()); + } catch (JSONException e) { + new AlertDialog.Builder(this) + .setTitle(R.string.invalid) + .setMessage(R.string.json_ignore) + .setPositiveButton(R.string.json_discard_close, (dialog, which) -> finish()) + .setNegativeButton(android.R.string.cancel, null) + .show(); + return; + } + + // check changes, exit if there are none + if (Objects.equals(noFailToString(currentData), noFailToString(provider.getJson()))) { + finish(); + return; + } + + // ask to save or discard + new AlertDialog.Builder(this) + .setTitle(R.string.save) + .setMessage(R.string.json_save) + .setPositiveButton(R.string.save, (dialog, which) -> { + var result = provider.saveJson(currentData); + if (result == null) { + // all ok, exit + finish(); + } else { + // error while saving + new AlertDialog.Builder(this) + .setTitle(R.string.invalid) + .setMessage(getString(R.string.json_save_error, result)) + .setPositiveButton(android.R.string.ok, null) + .show(); + } + }) + .setNeutralButton(R.string.discard, (dialog, which) -> finish()) + .setNegativeButton(android.R.string.cancel, null) + .show(); + } + + /* ------------------- actions ------------------- */ + + /** Formats the editor content, shows a dialog if invalid */ + private void format() { + try { + editor.setText(new JSONObject(editor.getText().toString()).toString(INDENT_SPACES)); + } catch (JSONException e) { + // invalid json + new AlertDialog.Builder(this) + .setTitle(R.string.invalid) + .setMessage(R.string.json_format_error) + .setPositiveButton(android.R.string.ok, null) + .show(); + } + } + + /** Discard the editor changes and restore the saved contents */ + private void discard() { + new AlertDialog.Builder(this) + .setTitle(R.string.discard) + .setMessage(R.string.json_discard) + .setPositiveButton(android.R.string.yes, (dialog, which) -> editor.setText(noFailToString(provider.getJson()))) + .setNegativeButton(android.R.string.cancel, null) + .show(); + } + + /** Discard the editor changes and restore the built-in contents */ + private void reset() { + new AlertDialog.Builder(this) + .setTitle(R.string.reset) + .setMessage(R.string.json_reset) + .setPositiveButton(android.R.string.yes, (dialog, which) -> editor.setText(noFailToString(provider.getBuiltInJson()))) + .setNegativeButton(android.R.string.cancel, null) + .show(); + } + + /** Saved current content. Display a dialog if it's not valid json or the saving failed */ + private void save() { + String result; + try { + result = provider.saveJson(new JSONObject(editor.getText().toString())); + } catch (JSONException e) { + // invalid json + result = getString(R.string.json_format_error); + } + + if (result != null) { + // error while saving + new AlertDialog.Builder(this) + .setTitle(R.string.invalid) + .setMessage(getString(R.string.json_save_error, result)) + .setPositiveButton(android.R.string.ok, null) + .show(); + } + } + + /* ------------------- utils ------------------- */ + + /** Formats a json into a valid string that doesn't throws a JSON exception */ + private static String noFailToString(JSONObject content) { + try { + return content.toString(INDENT_SPACES); + } catch (JSONException e) { + // panic, don't format then + return content.toString(); + } + } + +} diff --git a/app/src/main/java/com/trianguloy/urlchecker/activities/JsonEditorInterface.java b/app/src/main/java/com/trianguloy/urlchecker/activities/JsonEditorInterface.java new file mode 100644 index 00000000..6ea976a7 --- /dev/null +++ b/app/src/main/java/com/trianguloy/urlchecker/activities/JsonEditorInterface.java @@ -0,0 +1,37 @@ +package com.trianguloy.urlchecker.activities; + +import static com.trianguloy.urlchecker.activities.JsonEditorActivity.EXTRA_CLASS; + +import android.content.Context; +import android.content.Intent; + +import org.json.JSONObject; + +/** + * If a class implements this, it will be able to show a JSON editor. + * IMPORTANT! The class must also have a constructor with a single Activity parameter. + */ +public interface JsonEditorInterface { + + /* ------------------------- implementation ------------------------- */ + + /** Should return the currently saved json */ + JSONObject getJson(); + + /** Should return the built-in json */ + JSONObject getBuiltInJson(); + + /** Should saves a json. Return null if all ok, a message string to display if not */ + String saveJson(JSONObject data); + + /** The string id of the description to show in the editor */ + String getEditorDescription(); + + /* ------------------------- usage ------------------------- */ + + /** Displays a generic editor for json content. */ + default void showEditor(Context cntx) { + cntx.startActivity(new Intent(cntx, JsonEditorActivity.class) + .putExtra(EXTRA_CLASS, this.getClass())); + } +} diff --git a/app/src/main/java/com/trianguloy/urlchecker/dialogs/JsonEditor.java b/app/src/main/java/com/trianguloy/urlchecker/dialogs/JsonEditor.java deleted file mode 100644 index 6cdcb16d..00000000 --- a/app/src/main/java/com/trianguloy/urlchecker/dialogs/JsonEditor.java +++ /dev/null @@ -1,94 +0,0 @@ -package com.trianguloy.urlchecker.dialogs; - -import android.app.Activity; -import android.app.AlertDialog; -import android.view.View; -import android.view.WindowManager; -import android.widget.EditText; -import android.widget.TextView; -import android.widget.Toast; - -import com.trianguloy.urlchecker.R; - -import org.json.JSONException; -import org.json.JSONObject; - -/** - * @see this#show - */ -public class JsonEditor { - - public interface Listener { - /** - * Current data that the user wants to save. - * Return true if it is ok and the dialog should be dismissed, false otherwise. - */ - boolean onSave(JSONObject content); - } - - /** - * Displays a generic editor for json content. - */ - public static void show(JSONObject content, JSONObject reset, String description, Activity cntx, Listener onSave) { - - // prepare dialog content - View views = cntx.getLayoutInflater().inflate(R.layout.json_editor, null); - views.findViewById(R.id.description).setText(description); - - // init rules - EditText data = views.findViewById(R.id.data); - data.setText(noFailToString(content)); - - // formatter - views.findViewById(R.id.format).setOnClickListener(v -> { - try { - data.setText(new JSONObject(data.getText().toString()).toString(2)); - } catch (JSONException e) { - e.printStackTrace(); - Toast.makeText(cntx, R.string.toast_invalid, Toast.LENGTH_SHORT).show(); - } - }); - - // prepare dialog - AlertDialog dialog = new AlertDialog.Builder(cntx) - .setView(views) - .setPositiveButton(R.string.save, null) // set below - .setNegativeButton(android.R.string.cancel, null) - .setNeutralButton(R.string.reset, null) // set below - .setCancelable(false) - .show(); - - dialog.getWindow().setSoftInputMode(WindowManager.LayoutParams.SOFT_INPUT_ADJUST_RESIZE); - - // prepare more dialog - // these are configured here to disable automatic auto-closing when they are pressed - dialog.getButton(AlertDialog.BUTTON_POSITIVE).setOnClickListener(v -> { - try { - if (onSave.onSave(new JSONObject(data.getText().toString()))) { - dialog.dismiss(); - } - } catch (JSONException e) { - e.printStackTrace(); - Toast.makeText(cntx, R.string.toast_invalid, Toast.LENGTH_SHORT).show(); - } - }); - dialog.getButton(AlertDialog.BUTTON_NEUTRAL).setOnClickListener(v -> { - // clear catalog and reload internal - data.setText(noFailToString(reset)); - }); - } - - /** - * Formats a json into a valid string that doesn't throws a JSON exception - * (as a function because I needed a final string) - */ - private static String noFailToString(JSONObject content) { - try { - return content.toString(2); - } catch (JSONException e) { - // panic, don't format then - return content.toString(); - } - } - -} diff --git a/app/src/main/java/com/trianguloy/urlchecker/dialogs/MainDialog.java b/app/src/main/java/com/trianguloy/urlchecker/dialogs/MainDialog.java index c5e7c1cb..289d03a2 100644 --- a/app/src/main/java/com/trianguloy/urlchecker/dialogs/MainDialog.java +++ b/app/src/main/java/com/trianguloy/urlchecker/dialogs/MainDialog.java @@ -233,7 +233,7 @@ protected void onCreate(Bundle savedInstanceState) { switch (links.size()) { case 0: // no links, invalid - Toast.makeText(this, R.string.toast_invalid, Toast.LENGTH_SHORT).show(); + Toast.makeText(this, R.string.invalid, Toast.LENGTH_SHORT).show(); finish(); break; case 1: diff --git a/app/src/main/java/com/trianguloy/urlchecker/modules/companions/ClearUrlCatalog.java b/app/src/main/java/com/trianguloy/urlchecker/modules/companions/ClearUrlCatalog.java index bc8ae090..eb82ffbf 100644 --- a/app/src/main/java/com/trianguloy/urlchecker/modules/companions/ClearUrlCatalog.java +++ b/app/src/main/java/com/trianguloy/urlchecker/modules/companions/ClearUrlCatalog.java @@ -11,7 +11,7 @@ import android.widget.Toast; import com.trianguloy.urlchecker.R; -import com.trianguloy.urlchecker.dialogs.JsonEditor; +import com.trianguloy.urlchecker.activities.JsonEditorInterface; import com.trianguloy.urlchecker.utilities.generics.GenericPref; import com.trianguloy.urlchecker.utilities.methods.AndroidUtils; import com.trianguloy.urlchecker.utilities.methods.HttpUtils; @@ -31,7 +31,7 @@ /** * Manages the local catalog with the rules */ -public class ClearUrlCatalog { +public class ClearUrlCatalog implements JsonEditorInterface { /* ------------------- constants ------------------- */ @@ -182,16 +182,33 @@ public void clear() { * Show the rules editor dialog */ public void showEditor() { - JsonEditor.show(getCatalog(), getBuiltIn(), cntx.getString(R.string.mClear_editor), cntx, content -> { - if (setRules(content, false) != Result.ERROR) { - // saved data, close dialog - return true; - } else { - // invalid data, keep dialog and show why - Toast.makeText(cntx, R.string.toast_invalid, Toast.LENGTH_LONG).show(); - return false; - } - }); + showEditor(cntx); + } + + @Override + public JSONObject getJson() { + return getCatalog(); + } + + @Override + public JSONObject getBuiltInJson() { + return getBuiltIn(); + } + + @Override + public String saveJson(JSONObject data) { + if (setRules(data, false) != Result.ERROR) { + // saved data, close dialog + return null; + } else { + // invalid data, keep dialog and return why + return cntx.getString(R.string.invalid); + } + } + + @Override + public String getEditorDescription() { + return cntx.getString(R.string.mClear_editor); } /** @@ -315,7 +332,7 @@ private int _updateCatalog() { json = new JSONObject(rawRules); } catch (JSONException e) { e.printStackTrace(); - return R.string.toast_invalid; + return R.string.invalid; } // valid, save and update @@ -327,7 +344,7 @@ private int _updateCatalog() { return R.string.mClear_upToDate; case ERROR: default: - return R.string.toast_invalid; + return R.string.invalid; } } diff --git a/app/src/main/java/com/trianguloy/urlchecker/modules/companions/Hosts.java b/app/src/main/java/com/trianguloy/urlchecker/modules/companions/Hosts.java index 9cf2492b..c482900d 100644 --- a/app/src/main/java/com/trianguloy/urlchecker/modules/companions/Hosts.java +++ b/app/src/main/java/com/trianguloy/urlchecker/modules/companions/Hosts.java @@ -50,7 +50,7 @@ public void build(boolean showEditor, Runnable onFinished) { ); if (showEditor) builder - .setNeutralButton(R.string.json_edit, (dialog, which) -> data.showEditor()); + .setNeutralButton(R.string.json_editor, (dialog, which) -> data.showEditor()); builder.show(); } diff --git a/app/src/main/java/com/trianguloy/urlchecker/modules/list/FlagsModule.java b/app/src/main/java/com/trianguloy/urlchecker/modules/list/FlagsModule.java index 709c9e41..4af4ba42 100644 --- a/app/src/main/java/com/trianguloy/urlchecker/modules/list/FlagsModule.java +++ b/app/src/main/java/com/trianguloy/urlchecker/modules/list/FlagsModule.java @@ -437,7 +437,7 @@ private void storePreferences(ViewGroup vg, InternalFile file, String group) { file.set(newSettings.toString()); } catch (JSONException e) { e.printStackTrace(); - Toast.makeText(getActivity(), R.string.toast_invalid, Toast.LENGTH_SHORT).show(); + Toast.makeText(getActivity(), R.string.invalid, Toast.LENGTH_SHORT).show(); } } diff --git a/app/src/main/java/com/trianguloy/urlchecker/utilities/generics/JsonCatalog.java b/app/src/main/java/com/trianguloy/urlchecker/utilities/generics/JsonCatalog.java index 83afa68e..8441ba7a 100644 --- a/app/src/main/java/com/trianguloy/urlchecker/utilities/generics/JsonCatalog.java +++ b/app/src/main/java/com/trianguloy/urlchecker/utilities/generics/JsonCatalog.java @@ -3,7 +3,8 @@ import android.app.Activity; import android.content.Context; -import com.trianguloy.urlchecker.dialogs.JsonEditor; +import com.trianguloy.urlchecker.R; +import com.trianguloy.urlchecker.activities.JsonEditorInterface; import com.trianguloy.urlchecker.utilities.wrappers.InternalFile; import org.json.JSONException; @@ -12,7 +13,7 @@ /** * Represents a generic catalog */ -public abstract class JsonCatalog { +public abstract class JsonCatalog implements JsonEditorInterface { private final Activity cntx; private final InternalFile custom; @@ -75,11 +76,30 @@ public boolean save(JSONObject content) { return custom.set(content.toString()); } - /** - * Shows a dialog to manually edit the catalog - */ + + @Override + public JSONObject getJson() { + return getCatalog(); + } + + @Override + public JSONObject getBuiltInJson() { + return getBuiltIn(); + } + + @Override + public String saveJson(JSONObject data) { + return save(data) ? null : cntx.getString(R.string.invalid); + } + + @Override + public String getEditorDescription() { + return editorDescription; + } + + /** Displays a generic editor for json content. */ public void showEditor() { - JsonEditor.show(getCatalog(), getBuiltIn(), editorDescription, cntx, this::save); + showEditor(cntx); } } \ No newline at end of file diff --git a/app/src/main/java/com/trianguloy/urlchecker/utilities/methods/JavaUtils.java b/app/src/main/java/com/trianguloy/urlchecker/utilities/methods/JavaUtils.java index 5389d1f9..480f7399 100644 --- a/app/src/main/java/com/trianguloy/urlchecker/utilities/methods/JavaUtils.java +++ b/app/src/main/java/com/trianguloy/urlchecker/utilities/methods/JavaUtils.java @@ -15,9 +15,7 @@ */ public interface JavaUtils { - /** - * Converts an iterator to a list - */ + /** Converts an iterator to a list */ static List toList(Iterator iterator) { List list = new ArrayList<>(); while (iterator.hasNext()) { @@ -35,9 +33,7 @@ static List mapEach(List list, Function mapper) { return result; } - /** - * Converts a string into a json object, returns empty on failure - */ + /**Converts a string into a json object, returns empty on failure */ static JSONObject toJson(String content) { try { return new JSONObject(content); @@ -85,9 +81,7 @@ static T getAsOrCrash(Object object, Class clazz) throws ClassCastExcepti } } - /** - * Clamps a value between two other values. - */ + /** Clamps a value between two other values. */ static int clamp(int min, int value, int max) { return min <= max ? Math.max(min, Math.min(value, max)) // just in case @@ -179,9 +173,7 @@ static Function negate(Function function) { return t -> !function.apply(t); } - /** - * java.util.function.UnaryOperator requires api 24 - */ + /** java.util.function.UnaryOperator requires api 24 */ @FunctionalInterface interface UnaryOperator extends Function { } diff --git a/app/src/main/res/drawable/format.xml b/app/src/main/res/drawable/format.xml index 7edc1b43..d10bbc2f 100644 --- a/app/src/main/res/drawable/format.xml +++ b/app/src/main/res/drawable/format.xml @@ -5,6 +5,6 @@ android:width="24dp" xmlns:android="http://schemas.android.com/apk/res/android"> diff --git a/app/src/main/res/layout/activity_automation.xml b/app/src/main/res/layout/activity_automation.xml index db9bf40c..469ebad0 100644 --- a/app/src/main/res/layout/activity_automation.xml +++ b/app/src/main/res/layout/activity_automation.xml @@ -43,7 +43,7 @@ android:layout_width="match_parent" android:layout_height="wrap_content" android:onClick="openJsonEditor" - android:text="@string/json_edit" /> + android:text="@string/json_editor" /> \ No newline at end of file diff --git a/app/src/main/res/layout/activity_json_editor.xml b/app/src/main/res/layout/activity_json_editor.xml new file mode 100644 index 00000000..8577c076 --- /dev/null +++ b/app/src/main/res/layout/activity_json_editor.xml @@ -0,0 +1,36 @@ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/app/src/main/res/layout/config_clearurls.xml b/app/src/main/res/layout/config_clearurls.xml index cc1e914f..7e9381fe 100644 --- a/app/src/main/res/layout/config_clearurls.xml +++ b/app/src/main/res/layout/config_clearurls.xml @@ -53,7 +53,7 @@ android:layout_width="0dp" android:layout_height="wrap_content" android:layout_weight="1" - android:text="@string/json_edit" /> + android:text="@string/json_editor" /> \ No newline at end of file diff --git a/app/src/main/res/layout/config_hosts.xml b/app/src/main/res/layout/config_hosts.xml index de08e1fd..557a140b 100644 --- a/app/src/main/res/layout/config_hosts.xml +++ b/app/src/main/res/layout/config_hosts.xml @@ -14,13 +14,13 @@ android:layout_width="match_parent" android:layout_height="wrap_content" android:orientation="horizontal"> -