-
-
Notifications
You must be signed in to change notification settings - Fork 3.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add settings migration, improve share dialog and minimize to background by default #4259
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
140 changes: 140 additions & 0 deletions
140
app/src/main/java/org/schabi/newpipe/settings/SettingMigrations.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| package org.schabi.newpipe.settings; | ||
|
|
||
| import android.content.Context; | ||
| import android.content.SharedPreferences; | ||
| import android.util.Log; | ||
|
|
||
| import androidx.preference.PreferenceManager; | ||
|
|
||
| import org.schabi.newpipe.R; | ||
| import org.schabi.newpipe.report.ErrorActivity; | ||
| import org.schabi.newpipe.report.ErrorActivity.ErrorInfo; | ||
| import org.schabi.newpipe.report.UserAction; | ||
|
|
||
| import static org.schabi.newpipe.MainActivity.DEBUG; | ||
|
|
||
| public final class SettingMigrations { | ||
| private static final String TAG = SettingMigrations.class.toString(); | ||
| /** | ||
| * Version number for preferences. Must be incremented every time a migration is necessary. | ||
| */ | ||
| public static final int VERSION = 2; | ||
| private static SharedPreferences sp; | ||
|
|
||
| public static final Migration MIGRATION_0_1 = new Migration(0, 1) { | ||
| @Override | ||
| public void migrate(final Context context) { | ||
| // We changed the content of the dialog which opens when sharing a link to NewPipe | ||
| // by removing the "open detail page" option. | ||
| // Therefore, show the dialog once again to ensure users need to choose again and are | ||
| // aware of the changed dialog. | ||
| final SharedPreferences.Editor editor = sp.edit(); | ||
| editor.putString(context.getString(R.string.preferred_open_action_key), | ||
| context.getString(R.string.always_ask_open_action_key)); | ||
| editor.apply(); | ||
| } | ||
| }; | ||
|
|
||
| public static final Migration MIGRATION_1_2 = new Migration(1, 2) { | ||
| @Override | ||
| protected void migrate(final Context context) { | ||
| // The new application workflow introduced in #2907 allows minimizing videos | ||
| // while playing to do other stuff within the app. | ||
| // For an even better workflow, we minimize a stream when switching the app to play in | ||
| // background. | ||
| // Therefore, set default value to background, if it has not been changed yet. | ||
| final String minimizeOnExitKey = context.getString(R.string.minimize_on_exit_key); | ||
| if (sp.getString(minimizeOnExitKey, "") | ||
| .equals(context.getString(R.string.minimize_on_exit_none_key))) { | ||
| final SharedPreferences.Editor editor = sp.edit(); | ||
| editor.putString(minimizeOnExitKey, | ||
| context.getString(R.string.minimize_on_exit_background_key)); | ||
| editor.apply(); | ||
| } | ||
| } | ||
| }; | ||
|
|
||
| /** | ||
| * List of all implemented migrations. | ||
| * <p> | ||
| * <b>Append new migrations to the end of the list</b> to keep it sorted ascending. | ||
| * If not sorted correctly, migrations which depend on each other, may fail. | ||
| */ | ||
| private static final Migration[] SETTING_MIGRATIONS = { | ||
| MIGRATION_0_1, | ||
| MIGRATION_1_2 | ||
| }; | ||
|
|
||
|
|
||
| public static void initMigrations(final Context context, final boolean isFirstRun) { | ||
| // setup migrations and check if there is something to do | ||
| sp = PreferenceManager.getDefaultSharedPreferences(context); | ||
| final String lastPrefVersionKey = context.getString(R.string.last_used_preferences_version); | ||
| final int lastPrefVersion = sp.getInt(lastPrefVersionKey, 0); | ||
|
|
||
| // no migration to run, already up to date | ||
| if (isFirstRun) { | ||
| sp.edit().putInt(lastPrefVersionKey, VERSION).apply(); | ||
| return; | ||
| } else if (lastPrefVersion == VERSION) { | ||
Stypox marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| return; | ||
| } | ||
|
|
||
| // run migrations | ||
| int currentVersion = lastPrefVersion; | ||
| for (final Migration currentMigration : SETTING_MIGRATIONS) { | ||
| try { | ||
| if (currentMigration.shouldMigrate(currentVersion)) { | ||
| if (DEBUG) { | ||
| Log.d(TAG, "Migrating preferences from version " | ||
| + currentVersion + " to " + currentMigration.newVersion); | ||
| } | ||
| currentMigration.migrate(context); | ||
| currentVersion = currentMigration.newVersion; | ||
| } | ||
| } catch (final Exception e) { | ||
| // save the version with the last successful migration and report the error | ||
| sp.edit().putInt(lastPrefVersionKey, currentVersion).apply(); | ||
| final ErrorInfo errorInfo = ErrorInfo.make( | ||
| UserAction.PREFERENCES_MIGRATION, | ||
| "none", | ||
| "Migrating preferences from version " + lastPrefVersion + " to " | ||
| + VERSION + ". " | ||
| + "Error at " + currentVersion + " => " + ++currentVersion, | ||
| 0 | ||
| ); | ||
| ErrorActivity.reportError(context, e, SettingMigrations.class, null, errorInfo); | ||
| return; | ||
| } | ||
| } | ||
|
|
||
| // store the current preferences version | ||
| sp.edit().putInt(lastPrefVersionKey, currentVersion).apply(); | ||
| } | ||
|
|
||
| private SettingMigrations() { } | ||
|
|
||
| abstract static class Migration { | ||
| public final int oldVersion; | ||
| public final int newVersion; | ||
|
|
||
| protected Migration(final int oldVersion, final int newVersion) { | ||
| this.oldVersion = oldVersion; | ||
| this.newVersion = newVersion; | ||
| } | ||
|
|
||
| /** | ||
| * @param currentVersion current settings version | ||
| * @return Returns whether this migration should be run. | ||
| * A migration is necessary if the old version of this migration is lower than or equal to | ||
| * the current settings version. | ||
| */ | ||
| private boolean shouldMigrate(final int currentVersion) { | ||
| return oldVersion >= currentVersion; | ||
| } | ||
|
|
||
| protected abstract void migrate(Context context); | ||
|
|
||
| } | ||
|
|
||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not in this PR, but we may consider adding junit tests for migrations, using some kind of mocked shared preferences
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Completely agree with that.