Add editing functionality to the bookmarks database view. https://redmine.stoutner...
[PrivacyBrowser.git] / app / src / main / java / com / stoutner / privacybrowser / dialogs / EditBookmarkFolderDatabaseViewDialog.java
1 /*
2  * Copyright © 2016-2017 Soren Stoutner <soren@stoutner.com>.
3  *
4  * This file is part of Privacy Browser <https://www.stoutner.com/privacy-browser>.
5  *
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.
10  *
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.
15  *
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/>.
18  */
19
20 package com.stoutner.privacybrowser.dialogs;
21
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.widget.ResourceCursorAdapter;
36 // `AppCompatDialogFragment` is required instead of `DialogFragment` or an error is produced on API <=22.
37 import android.support.v7.app.AppCompatDialogFragment;
38 import android.text.Editable;
39 import android.text.TextWatcher;
40 import android.view.KeyEvent;
41 import android.view.View;
42 import android.view.WindowManager;
43 import android.widget.AdapterView;
44 import android.widget.Button;
45 import android.widget.EditText;
46 import android.widget.ImageView;
47 import android.widget.RadioButton;
48 import android.widget.RadioGroup;
49 import android.widget.Spinner;
50 import android.widget.TextView;
51
52 import com.stoutner.privacybrowser.R;
53 import com.stoutner.privacybrowser.activities.MainWebViewActivity;
54 import com.stoutner.privacybrowser.helpers.BookmarksDatabaseHelper;
55
56 public class EditBookmarkFolderDatabaseViewDialog extends AppCompatDialogFragment {
57     // Instantiate the constants.
58     public static final int HOME_FOLDER_DATABASE_ID = -1;
59
60     // Instantiate the class variables.
61     private EditBookmarkFolderDatabaseViewListener editBookmarkFolderDatabaseViewListener;
62     private BookmarksDatabaseHelper bookmarksDatabaseHelper;
63     private int folderDatabaseId;
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;
73
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);
77     }
78
79     public void onAttach(Context context) {
80         // Run the default commands.
81         super.onAttach(context);
82
83         // Get a handle for `EditBookmarkDatabaseViewListener` from `context`.
84         try {
85             editBookmarkFolderDatabaseViewListener = (EditBookmarkFolderDatabaseViewListener) context;
86         } catch(ClassCastException exception) {
87             throw new ClassCastException(context.toString() + " must implement EditBookmarkFolderDatabaseViewListener.");
88         }
89     }
90
91     // Store the database ID in the arguments bundle.
92     public static EditBookmarkFolderDatabaseViewDialog folderDatabaseId(int databaseId) {
93         // Create a bundle.
94         Bundle bundle = new Bundle();
95
96         // Store the bookmark database ID in the bundle.
97         bundle.putInt("Database ID", databaseId);
98
99         // Add the bundle to the dialog.
100         EditBookmarkFolderDatabaseViewDialog editBookmarkFolderDatabaseViewDialog = new EditBookmarkFolderDatabaseViewDialog();
101         editBookmarkFolderDatabaseViewDialog.setArguments(bundle);
102
103         // Return the new dialog.
104         return editBookmarkFolderDatabaseViewDialog;
105     }
106
107     @Override
108     public void onCreate(Bundle savedInstanceState) {
109         // Run the default commands.
110         super.onCreate(savedInstanceState);
111
112         // Store the bookmark database ID in the class variable.
113         folderDatabaseId = getArguments().getInt("Database ID");
114     }
115
116     // `@SuppressLing("InflateParams")` removes the warning about using `null` as the parent view group when inflating the `AlertDialog`.
117     @SuppressLint("InflateParams")
118     @Override
119     @NonNull
120     public Dialog onCreateDialog(Bundle savedInstanceState) {
121         // 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`.
122         bookmarksDatabaseHelper = new BookmarksDatabaseHelper(getContext(), null, null, 0);
123
124         // Get a `Cursor` with the selected bookmark and move it to the first position.
125         Cursor folderCursor = bookmarksDatabaseHelper.getBookmarkCursor(folderDatabaseId);
126         folderCursor.moveToFirst();
127
128         // Use `AlertDialog.Builder` to create the `AlertDialog`.
129         AlertDialog.Builder dialogBuilder;
130
131         // Set the style according to the theme.
132         if (MainWebViewActivity.darkTheme) {
133             dialogBuilder = new AlertDialog.Builder(getActivity(), R.style.PrivacyBrowserAlertDialogDark);
134         } else {
135             dialogBuilder = new AlertDialog.Builder(getActivity(), R.style.PrivacyBrowserAlertDialogLight);
136         }
137
138         // Set the title.
139         dialogBuilder.setTitle(R.string.edit_folder);
140
141         // Set the view.  The parent view is `null` because it will be assigned by `AlertDialog`.
142         dialogBuilder.setView(getActivity().getLayoutInflater().inflate(R.layout.edit_bookmark_folder_databaseview_dialog, null));
143
144         // Set an `onClick()` listener for the negative button.
145         dialogBuilder.setNegativeButton(R.string.cancel, (DialogInterface dialog, int which) -> {
146             // Do nothing.  The `AlertDialog` will close automatically.
147         });
148
149         // Set the `onClick()` listener fo the positive button.
150         dialogBuilder.setPositiveButton(R.string.save, (DialogInterface dialog, int which) -> {
151             // Return the `DialogFragment` to the parent activity on save.
152             editBookmarkFolderDatabaseViewListener.onSaveBookmarkFolder(EditBookmarkFolderDatabaseViewDialog.this, folderDatabaseId);
153         });
154
155         // Create an `AlertDialog` from the `AlertDialog.Builder`.
156         final AlertDialog alertDialog = dialogBuilder.create();
157
158         // Remove the warning below that `setSoftInputMode` might produce `java.lang.NullPointerException`.
159         assert alertDialog.getWindow() != null;
160
161         // 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.
162         alertDialog.getWindow().setSoftInputMode(WindowManager.LayoutParams.SOFT_INPUT_STATE_HIDDEN);
163
164         // The `AlertDialog` must be shown before items in the layout can be modified.
165         alertDialog.show();
166
167         // Get handles for the layout items.
168         TextView databaseIdTextView = alertDialog.findViewById(R.id.edit_folder_database_id_textview);
169         RadioGroup iconRadioGroup = alertDialog.findViewById(R.id.edit_folder_icon_radiogroup);
170         ImageView currentIconImageView = alertDialog.findViewById(R.id.edit_folder_current_icon_imageview);
171         ImageView newFavoriteIconImageView = alertDialog.findViewById(R.id.edit_folder_webpage_favorite_icon_imageview);
172         currentIconRadioButton = alertDialog.findViewById(R.id.edit_folder_current_icon_radiobutton);
173         nameEditText = alertDialog.findViewById(R.id.edit_folder_name_edittext);
174         folderSpinner = alertDialog.findViewById(R.id.edit_folder_parent_folder_spinner);
175         displayOrderEditText = alertDialog.findViewById(R.id.edit_folder_display_order_edittext);
176         editButton = alertDialog.getButton(AlertDialog.BUTTON_POSITIVE);
177
178         // Store the current folder values.
179         currentFolderName = folderCursor.getString(folderCursor.getColumnIndex(BookmarksDatabaseHelper.BOOKMARK_NAME));
180         currentDisplayOrder = folderCursor.getString(folderCursor.getColumnIndex(BookmarksDatabaseHelper.DISPLAY_ORDER));
181         String parentFolder = folderCursor.getString(folderCursor.getColumnIndex(BookmarksDatabaseHelper.PARENT_FOLDER));
182
183         // Set the database ID.
184         databaseIdTextView.setText(String.valueOf(folderCursor.getInt(folderCursor.getColumnIndex(BookmarksDatabaseHelper._ID))));
185
186         // Get the current favorite icon byte array from the `Cursor`.
187         byte[] currentIconByteArray = folderCursor.getBlob(folderCursor.getColumnIndex(BookmarksDatabaseHelper.FAVORITE_ICON));
188
189         // Convert the byte array to a `Bitmap` beginning at the first byte and ending at the last.
190         Bitmap currentIconBitmap = BitmapFactory.decodeByteArray(currentIconByteArray, 0, currentIconByteArray.length);
191
192         // Display `currentIconBitmap` in `edit_bookmark_current_icon`.
193         currentIconImageView.setImageBitmap(currentIconBitmap);
194
195         // Get a `Bitmap` of the favorite icon from `MainWebViewActivity` and display it in `edit_bookmark_web_page_favorite_icon`.
196         newFavoriteIconImageView.setImageBitmap(MainWebViewActivity.favoriteIconBitmap);
197
198         // Populate the folder name `EditText`.
199         nameEditText.setText(currentFolderName);
200
201         // Setup a `MatrixCursor` "Home Folder".
202         String[] matrixCursorColumnNames = {BookmarksDatabaseHelper._ID, BookmarksDatabaseHelper.BOOKMARK_NAME};
203         MatrixCursor matrixCursor = new MatrixCursor(matrixCursorColumnNames);
204         matrixCursor.addRow(new Object[]{HOME_FOLDER_DATABASE_ID, getString(R.string.home_folder)});
205
206         // Initialize a `StringBuilder` to track the folders not to display in the `Spinner` and populate it with the current folder.
207         exceptFolders = new StringBuilder(DatabaseUtils.sqlEscapeString(currentFolderName));
208
209         // Add all subfolders of the current folder to the list of folders not to display.
210         addSubfoldersToExceptFolders(currentFolderName);
211
212         // Get a `Cursor` with the list of all the folders.
213         Cursor foldersCursor = bookmarksDatabaseHelper.getFoldersCursorExcept(exceptFolders.toString());
214
215         // Combine `matrixCursor` and `foldersCursor`.
216         MergeCursor foldersMergeCursor = new MergeCursor(new Cursor[]{matrixCursor, foldersCursor});
217
218         // Create a `ResourceCursorAdapter` for the `Spinner`.  `0` specifies no flags.;
219         ResourceCursorAdapter foldersCursorAdapter = new ResourceCursorAdapter(getContext(), R.layout.edit_bookmark_databaseview_spinner_item, foldersMergeCursor, 0) {
220             @Override
221             public void bindView(View view, Context context, Cursor cursor) {
222                 // Get a handle for the `Spinner` item `TextView`.
223                 TextView spinnerItemTextView = view.findViewById(R.id.spinner_item_textview);
224
225                 // Set the `TextView` to display the folder name.
226                 spinnerItemTextView.setText(cursor.getString(cursor.getColumnIndex(BookmarksDatabaseHelper.BOOKMARK_NAME)));
227             }
228         };
229
230         // Set the `ResourceCursorAdapter` drop drown view resource.
231         foldersCursorAdapter.setDropDownViewResource(R.layout.edit_bookmark_databaseview_spinner_dropdown_item);
232
233         // Set the adapter for the folder `Spinner`.
234         folderSpinner.setAdapter(foldersCursorAdapter);
235
236         // Select the current folder in the `Spinner` if the bookmark isn't in the "Home Folder".
237         if (!parentFolder.equals("")) {
238             // Get the database ID of the parent folder.
239             int folderDatabaseId = bookmarksDatabaseHelper.getFolderDatabaseId(folderCursor.getString(folderCursor.getColumnIndex(BookmarksDatabaseHelper.PARENT_FOLDER)));
240
241             // Initialize `parentFolderPosition` and the iteration variable.
242             int parentFolderPosition = 0;
243             int i = 0;
244
245             // Find the parent folder position in folders `ResourceCursorAdapter`.
246             do {
247                 if (foldersCursorAdapter.getItemId(i) == folderDatabaseId) {
248                     // Store the current position for the parent folder.
249                     parentFolderPosition = i;
250                 } else {
251                     // Try the next entry.
252                     i++;
253                 }
254                 // Stop when the parent folder position is found or all the items in the `ResourceCursorAdapter` have been checked.
255             } while ((parentFolderPosition == 0) && (i < foldersCursorAdapter.getCount()));
256
257             // Select the parent folder in the `Spinner`.
258             folderSpinner.setSelection(parentFolderPosition);
259         }
260
261         // Store the current folder database ID.
262         currentParentFolderDatabaseId = (int) folderSpinner.getSelectedItemId();
263
264         // Populate the display order `EditText`.
265         displayOrderEditText.setText(String.valueOf(folderCursor.getInt(folderCursor.getColumnIndex(BookmarksDatabaseHelper.DISPLAY_ORDER))));
266
267         // Initially disable the edit button.
268         editButton.setEnabled(false);
269
270         // Update the edit button if the icon selection changes.
271         iconRadioGroup.setOnCheckedChangeListener((group, checkedId) -> {
272             // Update the edit button.
273             updateEditButton();
274         });
275
276         // Update the edit button if the bookmark name changes.
277         nameEditText.addTextChangedListener(new TextWatcher() {
278             @Override
279             public void beforeTextChanged(CharSequence s, int start, int count, int after) {
280                 // Do nothing.
281             }
282
283             @Override
284             public void onTextChanged(CharSequence s, int start, int before, int count) {
285                 // Do nothing.
286             }
287
288             @Override
289             public void afterTextChanged(Editable s) {
290                 // Update the edit button.
291                 updateEditButton();
292             }
293         });
294
295         // Update the edit button if the folder changes.
296         folderSpinner.setOnItemSelectedListener(new AdapterView.OnItemSelectedListener() {
297             @Override
298             public void onItemSelected(AdapterView<?> parent, View view, int position, long id) {
299                 // Update the edit button.
300                 updateEditButton();
301             }
302
303             @Override
304             public void onNothingSelected(AdapterView<?> parent) {
305
306             }
307         });
308
309         // Update the edit button if the display order changes.
310         displayOrderEditText.addTextChangedListener(new TextWatcher() {
311             @Override
312             public void beforeTextChanged(CharSequence s, int start, int count, int after) {
313                 // Do nothing.
314             }
315
316             @Override
317             public void onTextChanged(CharSequence s, int start, int before, int count) {
318                 // Do nothing.
319             }
320
321             @Override
322             public void afterTextChanged(Editable s) {
323                 // Update the edit button.
324                 updateEditButton();
325             }
326         });
327
328         // Allow the `enter` key on the keyboard to save the bookmark from the bookmark name `EditText`.
329         nameEditText.setOnKeyListener((View v, int keyCode, KeyEvent event) -> {
330             // Save the bookmark if the event is a key-down on the "enter" button.
331             if ((event.getAction() == KeyEvent.ACTION_DOWN) && (keyCode == KeyEvent.KEYCODE_ENTER) && editButton.isEnabled()) {  // The enter key was pressed and the edit button is enabled.
332                 // Trigger the `Listener` and return the `DialogFragment` to the parent activity.
333                 editBookmarkFolderDatabaseViewListener.onSaveBookmarkFolder(EditBookmarkFolderDatabaseViewDialog.this, folderDatabaseId);
334
335                 // Manually dismiss `alertDialog`.
336                 alertDialog.dismiss();
337
338                 // Consume the event.
339                 return true;
340             } else {  // If any other key was pressed, or if the edit button is currently disabled, do not consume the event.
341                 return false;
342             }
343         });
344
345         // Allow the "enter" key on the keyboard to save the bookmark from the display order `EditText`.
346         displayOrderEditText.setOnKeyListener((View v, int keyCode, KeyEvent event) -> {
347             // Save the bookmark if the event is a key-down on the "enter" button.
348             if ((event.getAction() == KeyEvent.ACTION_DOWN) && (keyCode == KeyEvent.KEYCODE_ENTER) && editButton.isEnabled()) {  // The enter key was pressed and the edit button is enabled.
349                 // Trigger the `Listener` and return the `DialogFragment` to the parent activity.
350                 editBookmarkFolderDatabaseViewListener.onSaveBookmarkFolder(EditBookmarkFolderDatabaseViewDialog.this, folderDatabaseId);
351
352                 // Manually dismiss the `AlertDialog`.
353                 alertDialog.dismiss();
354
355                 // Consume the event.
356                 return true;
357             } else { // If any other key was pressed, or if the edit button is currently disabled, do not consume the event.
358                 return false;
359             }
360         });
361
362         // `onCreateDialog` requires the return of an `AlertDialog`.
363         return alertDialog;
364     }
365
366     private void updateEditButton() {
367         // Get the values from the dialog.
368         String newFolderName = nameEditText.getText().toString();
369         int newParentFolderDatabaseId = (int) folderSpinner.getSelectedItemId();
370         String newDisplayOrder = displayOrderEditText.getText().toString();
371
372         // Get a cursor for the new folder name if it exists.
373         Cursor folderExistsCursor = bookmarksDatabaseHelper.getFolderCursor(newFolderName);
374
375         // Is the new folder name empty?
376         boolean folderNameNotEmpty = !newFolderName.isEmpty();
377
378         // Does the folder name already exist?
379         boolean folderNameAlreadyExists = (!newFolderName.equals(currentFolderName) && (folderExistsCursor.getCount() > 0));
380
381         // Has the favorite icon changed?
382         boolean iconChanged = !currentIconRadioButton.isChecked();
383
384         // Has the name been renamed?
385         boolean folderRenamed = (!newFolderName.equals(currentFolderName) && !folderNameAlreadyExists);
386
387         // Has the folder changed?
388         boolean parentFolderChanged = newParentFolderDatabaseId != currentParentFolderDatabaseId;
389
390         // Has the display order changed?
391         boolean displayOrderChanged = !newDisplayOrder.equals(currentDisplayOrder);
392
393         // Is the display order empty?
394         boolean displayOrderNotEmpty = !newDisplayOrder.isEmpty();
395
396         // Update the enabled status of the edit button.
397         editButton.setEnabled((iconChanged || folderRenamed || parentFolderChanged || displayOrderChanged) && folderNameNotEmpty && displayOrderNotEmpty);
398     }
399
400     private void addSubfoldersToExceptFolders(String folderName) {
401         // Get a `Cursor` will all the immediate subfolders.
402         Cursor subfoldersCursor = bookmarksDatabaseHelper.getSubfoldersCursor(folderName);
403
404         for (int i = 0; i < subfoldersCursor.getCount(); i++) {
405             // Move `subfolderCursor` to the current item.
406             subfoldersCursor.moveToPosition(i);
407
408             // Get the name of the subfolder.
409             String subfolderName = subfoldersCursor.getString(subfoldersCursor.getColumnIndex(BookmarksDatabaseHelper.BOOKMARK_NAME));
410
411             // Add the subfolder to `exceptFolders`.
412             exceptFolders.append(",");
413             exceptFolders.append(DatabaseUtils.sqlEscapeString(subfolderName));
414
415             // Run the same tasks for any subfolders of the subfolder.
416             addSubfoldersToExceptFolders(subfolderName);
417         }
418     }
419 }