2 * Copyright © 2016-2019 Soren Stoutner <soren@stoutner.com>.
4 * This file is part of Privacy Browser <https://www.stoutner.com/privacy-browser>.
6 * Privacy Browser is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * Privacy Browser is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with Privacy Browser. If not, see <http://www.gnu.org/licenses/>.
20 package com.stoutner.privacybrowser.dialogs;
22 import android.annotation.SuppressLint;
23 import android.app.AlertDialog;
24 import android.app.Dialog;
25 import android.content.Context;
26 import android.content.DialogInterface;
27 import android.database.Cursor;
28 import android.database.DatabaseUtils;
29 import android.database.MatrixCursor;
30 import android.database.MergeCursor;
31 import android.graphics.Bitmap;
32 import android.graphics.BitmapFactory;
33 import android.os.Bundle;
34 import android.support.annotation.NonNull;
35 import android.support.v4.content.ContextCompat;
36 import android.support.v4.widget.ResourceCursorAdapter;
37 // `AppCompatDialogFragment` is required instead of `DialogFragment` or an error is produced on API <=22.
38 import android.support.v7.app.AppCompatDialogFragment;
39 import android.text.Editable;
40 import android.text.TextWatcher;
41 import android.view.KeyEvent;
42 import android.view.View;
43 import android.view.WindowManager;
44 import android.widget.AdapterView;
45 import android.widget.Button;
46 import android.widget.EditText;
47 import android.widget.ImageView;
48 import android.widget.RadioButton;
49 import android.widget.RadioGroup;
50 import android.widget.Spinner;
51 import android.widget.TextView;
53 import com.stoutner.privacybrowser.R;
54 import com.stoutner.privacybrowser.activities.MainWebViewActivity;
55 import com.stoutner.privacybrowser.helpers.BookmarksDatabaseHelper;
57 public class EditBookmarkFolderDatabaseViewDialog extends AppCompatDialogFragment {
58 // Instantiate the constants.
59 public static final int HOME_FOLDER_DATABASE_ID = -1;
61 // Instantiate the class variables.
62 private EditBookmarkFolderDatabaseViewListener editBookmarkFolderDatabaseViewListener;
63 private BookmarksDatabaseHelper bookmarksDatabaseHelper;
64 private StringBuilder exceptFolders;
65 private String currentFolderName;
66 private int currentParentFolderDatabaseId;
67 private String currentDisplayOrder;
68 private RadioButton currentIconRadioButton;
69 private EditText nameEditText;
70 private Spinner folderSpinner;
71 private EditText displayOrderEditText;
72 private Button editButton;
74 // The public interface is used to send information back to the parent activity.
75 public interface EditBookmarkFolderDatabaseViewListener {
76 void onSaveBookmarkFolder(AppCompatDialogFragment dialogFragment, int selectedFolderDatabaseId);
79 public void onAttach(Context context) {
80 // Run the default commands.
81 super.onAttach(context);
83 // Get a handle for `EditBookmarkDatabaseViewListener` from the launching context.
84 editBookmarkFolderDatabaseViewListener = (EditBookmarkFolderDatabaseViewListener) context;
87 // Store the database ID in the arguments bundle.
88 public static EditBookmarkFolderDatabaseViewDialog folderDatabaseId(int databaseId) {
90 Bundle bundle = new Bundle();
92 // Store the bookmark database ID in the bundle.
93 bundle.putInt("Database ID", databaseId);
95 // Add the bundle to the dialog.
96 EditBookmarkFolderDatabaseViewDialog editBookmarkFolderDatabaseViewDialog = new EditBookmarkFolderDatabaseViewDialog();
97 editBookmarkFolderDatabaseViewDialog.setArguments(bundle);
99 // Return the new dialog.
100 return editBookmarkFolderDatabaseViewDialog;
103 // `@SuppressLing("InflateParams")` removes the warning about using `null` as the parent view group when inflating the `AlertDialog`.
104 @SuppressLint("InflateParams")
107 public Dialog onCreateDialog(Bundle savedInstanceState) {
108 // Remove the incorrect lint warning that `getInt()` might be null.
109 assert getArguments() != null;
111 // Get the bookmark database ID from the bundle.
112 int folderDatabaseId = getArguments().getInt("Database ID");
114 // Initialize the database helper. The two `nulls` do not specify the database name or a `CursorFactory`. The `0` specifies a database version, but that is ignored and set instead using a constant in `BookmarksDatabaseHelper`.
115 bookmarksDatabaseHelper = new BookmarksDatabaseHelper(getContext(), null, null, 0);
117 // Get a `Cursor` with the selected bookmark and move it to the first position.
118 Cursor folderCursor = bookmarksDatabaseHelper.getBookmark(folderDatabaseId);
119 folderCursor.moveToFirst();
121 // Use an alert dialog builder to create the alert dialog.
122 AlertDialog.Builder dialogBuilder;
124 // Set the style according to the theme.
125 if (MainWebViewActivity.darkTheme) {
126 dialogBuilder = new AlertDialog.Builder(getActivity(), R.style.PrivacyBrowserAlertDialogDark);
128 dialogBuilder = new AlertDialog.Builder(getActivity(), R.style.PrivacyBrowserAlertDialogLight);
132 dialogBuilder.setTitle(R.string.edit_folder);
134 // Remove the incorrect lint warning that `getActivity()` might be null.
135 assert getActivity() != null;
137 // Set the view. The parent view is `null` because it will be assigned by `AlertDialog`.
138 dialogBuilder.setView(getActivity().getLayoutInflater().inflate(R.layout.edit_bookmark_folder_databaseview_dialog, null));
140 // Set the listener for the negative button.
141 dialogBuilder.setNegativeButton(R.string.cancel, (DialogInterface dialog, int which) -> {
142 // Do nothing. The `AlertDialog` will close automatically.
145 // Set the listener fo the positive button.
146 dialogBuilder.setPositiveButton(R.string.save, (DialogInterface dialog, int which) -> {
147 // Return the `DialogFragment` to the parent activity on save.
148 editBookmarkFolderDatabaseViewListener.onSaveBookmarkFolder(EditBookmarkFolderDatabaseViewDialog.this, folderDatabaseId);
151 // Create an alert dialog from the alert dialog builder.
152 final AlertDialog alertDialog = dialogBuilder.create();
154 // Remove the warning below that `getWindow()` might be null.
155 assert alertDialog.getWindow() != null;
157 // Disable screenshots if not allowed.
158 if (!MainWebViewActivity.allowScreenshots) {
159 alertDialog.getWindow().addFlags(WindowManager.LayoutParams.FLAG_SECURE);
162 // Set the keyboard to be hidden when the `AlertDialog` is first shown. If this is not set, the `AlertDialog` will not shrink when the keyboard is displayed.
163 alertDialog.getWindow().setSoftInputMode(WindowManager.LayoutParams.SOFT_INPUT_STATE_HIDDEN);
165 // The alert dialog must be shown before items in the layout can be modified.
168 // Get handles for the layout items.
169 TextView databaseIdTextView = alertDialog.findViewById(R.id.edit_folder_database_id_textview);
170 RadioGroup iconRadioGroup = alertDialog.findViewById(R.id.edit_folder_icon_radiogroup);
171 ImageView currentIconImageView = alertDialog.findViewById(R.id.edit_folder_current_icon_imageview);
172 ImageView newFavoriteIconImageView = alertDialog.findViewById(R.id.edit_folder_webpage_favorite_icon_imageview);
173 currentIconRadioButton = alertDialog.findViewById(R.id.edit_folder_current_icon_radiobutton);
174 nameEditText = alertDialog.findViewById(R.id.edit_folder_name_edittext);
175 folderSpinner = alertDialog.findViewById(R.id.edit_folder_parent_folder_spinner);
176 displayOrderEditText = alertDialog.findViewById(R.id.edit_folder_display_order_edittext);
177 editButton = alertDialog.getButton(AlertDialog.BUTTON_POSITIVE);
179 // Store the current folder values.
180 currentFolderName = folderCursor.getString(folderCursor.getColumnIndex(BookmarksDatabaseHelper.BOOKMARK_NAME));
181 currentDisplayOrder = folderCursor.getString(folderCursor.getColumnIndex(BookmarksDatabaseHelper.DISPLAY_ORDER));
182 String parentFolder = folderCursor.getString(folderCursor.getColumnIndex(BookmarksDatabaseHelper.PARENT_FOLDER));
184 // Set the database ID.
185 databaseIdTextView.setText(String.valueOf(folderCursor.getInt(folderCursor.getColumnIndex(BookmarksDatabaseHelper._ID))));
187 // Get the current favorite icon byte array from the `Cursor`.
188 byte[] currentIconByteArray = folderCursor.getBlob(folderCursor.getColumnIndex(BookmarksDatabaseHelper.FAVORITE_ICON));
190 // Convert the byte array to a `Bitmap` beginning at the first byte and ending at the last.
191 Bitmap currentIconBitmap = BitmapFactory.decodeByteArray(currentIconByteArray, 0, currentIconByteArray.length);
193 // Display the current icon bitmap in `edit_bookmark_current_icon`.
194 currentIconImageView.setImageBitmap(currentIconBitmap);
196 // Get a bitmap of the favorite icon from `MainWebViewActivity` and display it in `edit_bookmark_web_page_favorite_icon`.
197 newFavoriteIconImageView.setImageBitmap(MainWebViewActivity.favoriteIconBitmap);
199 // Populate the folder name edit text.
200 nameEditText.setText(currentFolderName);
202 // Setup a matrix cursor for "Home Folder".
203 String[] matrixCursorColumnNames = {BookmarksDatabaseHelper._ID, BookmarksDatabaseHelper.BOOKMARK_NAME};
204 MatrixCursor matrixCursor = new MatrixCursor(matrixCursorColumnNames);
205 matrixCursor.addRow(new Object[]{HOME_FOLDER_DATABASE_ID, getString(R.string.home_folder)});
207 // Initialize a string builder to track the folders not to display in the spinner and populate it with the current folder.
208 exceptFolders = new StringBuilder(DatabaseUtils.sqlEscapeString(currentFolderName));
210 // Add all subfolders of the current folder to the list of folders not to display.
211 addSubfoldersToExceptFolders(currentFolderName);
213 // Get a cursor with the list of all the folders.
214 Cursor foldersCursor = bookmarksDatabaseHelper.getFoldersExcept(exceptFolders.toString());
216 // Combine the matrix cursor and the folders cursor.
217 MergeCursor foldersMergeCursor = new MergeCursor(new Cursor[]{matrixCursor, foldersCursor});
219 // Remove the incorrect lint warning that `getContext()` might be null.
220 assert getContext() != null;
222 // Create a resource cursor adapter for the spinner.
223 ResourceCursorAdapter foldersCursorAdapter = new ResourceCursorAdapter(getContext(), R.layout.databaseview_spinner_item, foldersMergeCursor, 0) {
225 public void bindView(View view, Context context, Cursor cursor) {
226 // Get handles for the spinner views.
227 ImageView spinnerItemImageView = view.findViewById(R.id.spinner_item_imageview);
228 TextView spinnerItemTextView = view.findViewById(R.id.spinner_item_textview);
230 // Set the folder icon according to the type.
231 if (foldersMergeCursor.getPosition() == 0) { // Set the `Home Folder` icon.
232 // Set the gray folder image. `ContextCompat` must be used until the minimum API >= 21.
233 spinnerItemImageView.setImageDrawable(ContextCompat.getDrawable(context, R.drawable.folder_gray));
234 } else { // Set a user folder icon.
235 // Get the folder icon byte array.
236 byte[] folderIconByteArray = cursor.getBlob(cursor.getColumnIndex(BookmarksDatabaseHelper.FAVORITE_ICON));
238 // Convert the byte array to a bitmap beginning at the first byte and ending at the last.
239 Bitmap folderIconBitmap = BitmapFactory.decodeByteArray(folderIconByteArray, 0, folderIconByteArray.length);
241 // Set the folder icon.
242 spinnerItemImageView.setImageBitmap(folderIconBitmap);
245 // Set the text view to display the folder name.
246 spinnerItemTextView.setText(cursor.getString(cursor.getColumnIndex(BookmarksDatabaseHelper.BOOKMARK_NAME)));
250 // Set the `ResourceCursorAdapter` drop drown view resource.
251 foldersCursorAdapter.setDropDownViewResource(R.layout.databaseview_spinner_dropdown_items);
253 // Set the adapter for the folder `Spinner`.
254 folderSpinner.setAdapter(foldersCursorAdapter);
256 // Select the current folder in the `Spinner` if the bookmark isn't in the "Home Folder".
257 if (!parentFolder.equals("")) {
258 // Get the database ID of the parent folder.
259 int parentFolderDatabaseId = bookmarksDatabaseHelper.getFolderDatabaseId(folderCursor.getString(folderCursor.getColumnIndex(BookmarksDatabaseHelper.PARENT_FOLDER)));
261 // Initialize `parentFolderPosition` and the iteration variable.
262 int parentFolderPosition = 0;
265 // Find the parent folder position in folders `ResourceCursorAdapter`.
267 if (foldersCursorAdapter.getItemId(i) == parentFolderDatabaseId) {
268 // Store the current position for the parent folder.
269 parentFolderPosition = i;
271 // Try the next entry.
274 // Stop when the parent folder position is found or all the items in the `ResourceCursorAdapter` have been checked.
275 } while ((parentFolderPosition == 0) && (i < foldersCursorAdapter.getCount()));
277 // Select the parent folder in the `Spinner`.
278 folderSpinner.setSelection(parentFolderPosition);
281 // Store the current folder database ID.
282 currentParentFolderDatabaseId = (int) folderSpinner.getSelectedItemId();
284 // Populate the display order `EditText`.
285 displayOrderEditText.setText(String.valueOf(folderCursor.getInt(folderCursor.getColumnIndex(BookmarksDatabaseHelper.DISPLAY_ORDER))));
287 // Initially disable the edit button.
288 editButton.setEnabled(false);
290 // Update the edit button if the icon selection changes.
291 iconRadioGroup.setOnCheckedChangeListener((group, checkedId) -> {
292 // Update the edit button.
296 // Update the edit button if the bookmark name changes.
297 nameEditText.addTextChangedListener(new TextWatcher() {
299 public void beforeTextChanged(CharSequence s, int start, int count, int after) {
304 public void onTextChanged(CharSequence s, int start, int before, int count) {
309 public void afterTextChanged(Editable s) {
310 // Update the edit button.
315 // Update the edit button if the folder changes.
316 folderSpinner.setOnItemSelectedListener(new AdapterView.OnItemSelectedListener() {
318 public void onItemSelected(AdapterView<?> parent, View view, int position, long id) {
319 // Update the edit button.
324 public void onNothingSelected(AdapterView<?> parent) {
329 // Update the edit button if the display order changes.
330 displayOrderEditText.addTextChangedListener(new TextWatcher() {
332 public void beforeTextChanged(CharSequence s, int start, int count, int after) {
337 public void onTextChanged(CharSequence s, int start, int before, int count) {
342 public void afterTextChanged(Editable s) {
343 // Update the edit button.
348 // Allow the `enter` key on the keyboard to save the bookmark from the bookmark name `EditText`.
349 nameEditText.setOnKeyListener((View v, int keyCode, KeyEvent event) -> {
350 // Save the bookmark if the event is a key-down on the "enter" button.
351 if ((event.getAction() == KeyEvent.ACTION_DOWN) && (keyCode == KeyEvent.KEYCODE_ENTER) && editButton.isEnabled()) { // The enter key was pressed and the edit button is enabled.
352 // Trigger the `Listener` and return the `DialogFragment` to the parent activity.
353 editBookmarkFolderDatabaseViewListener.onSaveBookmarkFolder(EditBookmarkFolderDatabaseViewDialog.this, folderDatabaseId);
355 // Manually dismiss `alertDialog`.
356 alertDialog.dismiss();
358 // Consume the event.
360 } else { // If any other key was pressed, or if the edit button is currently disabled, do not consume the event.
365 // Allow the "enter" key on the keyboard to save the bookmark from the display order `EditText`.
366 displayOrderEditText.setOnKeyListener((View v, int keyCode, KeyEvent event) -> {
367 // Save the bookmark if the event is a key-down on the "enter" button.
368 if ((event.getAction() == KeyEvent.ACTION_DOWN) && (keyCode == KeyEvent.KEYCODE_ENTER) && editButton.isEnabled()) { // The enter key was pressed and the edit button is enabled.
369 // Trigger the `Listener` and return the `DialogFragment` to the parent activity.
370 editBookmarkFolderDatabaseViewListener.onSaveBookmarkFolder(EditBookmarkFolderDatabaseViewDialog.this, folderDatabaseId);
372 // Manually dismiss the `AlertDialog`.
373 alertDialog.dismiss();
375 // Consume the event.
377 } else { // If any other key was pressed, or if the edit button is currently disabled, do not consume the event.
382 // `onCreateDialog` requires the return of an `AlertDialog`.
386 private void updateEditButton() {
387 // Get the values from the dialog.
388 String newFolderName = nameEditText.getText().toString();
389 int newParentFolderDatabaseId = (int) folderSpinner.getSelectedItemId();
390 String newDisplayOrder = displayOrderEditText.getText().toString();
392 // Get a cursor for the new folder name if it exists.
393 Cursor folderExistsCursor = bookmarksDatabaseHelper.getFolder(newFolderName);
395 // Is the new folder name empty?
396 boolean folderNameNotEmpty = !newFolderName.isEmpty();
398 // Does the folder name already exist?
399 boolean folderNameAlreadyExists = (!newFolderName.equals(currentFolderName) && (folderExistsCursor.getCount() > 0));
401 // Has the favorite icon changed?
402 boolean iconChanged = !currentIconRadioButton.isChecked();
404 // Has the name been renamed?
405 boolean folderRenamed = (!newFolderName.equals(currentFolderName) && !folderNameAlreadyExists);
407 // Has the folder changed?
408 boolean parentFolderChanged = newParentFolderDatabaseId != currentParentFolderDatabaseId;
410 // Has the display order changed?
411 boolean displayOrderChanged = !newDisplayOrder.equals(currentDisplayOrder);
413 // Is the display order empty?
414 boolean displayOrderNotEmpty = !newDisplayOrder.isEmpty();
416 // Update the enabled status of the edit button.
417 editButton.setEnabled((iconChanged || folderRenamed || parentFolderChanged || displayOrderChanged) && folderNameNotEmpty && displayOrderNotEmpty);
420 private void addSubfoldersToExceptFolders(String folderName) {
421 // Get a `Cursor` will all the immediate subfolders.
422 Cursor subfoldersCursor = bookmarksDatabaseHelper.getSubfolders(folderName);
424 for (int i = 0; i < subfoldersCursor.getCount(); i++) {
425 // Move `subfolderCursor` to the current item.
426 subfoldersCursor.moveToPosition(i);
428 // Get the name of the subfolder.
429 String subfolderName = subfoldersCursor.getString(subfoldersCursor.getColumnIndex(BookmarksDatabaseHelper.BOOKMARK_NAME));
431 // Add the subfolder to `exceptFolders`.
432 exceptFolders.append(",");
433 exceptFolders.append(DatabaseUtils.sqlEscapeString(subfolderName));
435 // Run the same tasks for any subfolders of the subfolder.
436 addSubfoldersToExceptFolders(subfolderName);