app/src/main/java/com/stoutner/privacybrowser/dialogs/MoveToFolderDialog.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.graphics.drawable.BitmapDrawable;
  34 import android.graphics.drawable.Drawable;
  35 import android.os.Bundle;
  36 import android.support.annotation.NonNull;
  37 import android.support.v4.content.ContextCompat;
  38 // `AppCompatDialogFragment` must be used instead of `DialogFragment` or an error is produced on API <=22.
  39 import android.support.v7.app.AppCompatDialogFragment;
  40 import android.view.View;
  41 import android.view.ViewGroup;
  42 import android.widget.AdapterView;
  43 import android.widget.Button;
  44 import android.widget.CursorAdapter;
  45 import android.widget.ImageView;
  46 import android.widget.ListView;
  47 import android.widget.TextView;
  48
  49 import com.stoutner.privacybrowser.R;
  50 import com.stoutner.privacybrowser.activities.BookmarksActivity;
  51 import com.stoutner.privacybrowser.activities.MainWebViewActivity;
  52 import com.stoutner.privacybrowser.helpers.BookmarksDatabaseHelper;
  53
  54 import java.io.ByteArrayOutputStream;
  55
  56 public class MoveToFolderDialog extends AppCompatDialogFragment {
  57     // Instantiate class variables.
  58     private BookmarksDatabaseHelper bookmarksDatabaseHelper;
  59     private StringBuilder exceptFolders;
  60
  61     // The public interface is used to send information back to the parent activity.
  62     public interface MoveToFolderListener {
  63         void onMoveToFolder(AppCompatDialogFragment dialogFragment);
  64     }
  65
  66     // `moveToFolderListener` is used in `onAttach()` and `onCreateDialog`.
  67     private MoveToFolderListener moveToFolderListener;
  68
  69     public void onAttach(Context context) {
  70         super.onAttach(context);
  71
  72         // Get a handle for `MoveToFolderListener` from `parentActivity`.
  73         try {
  74             moveToFolderListener = (MoveToFolderListener) context;
  75         } catch(ClassCastException exception) {
  76             throw new ClassCastException(context.toString() + " must implement EditBookmarkFolderListener.");
  77         }
  78     }
  79
  80     // `@SuppressLing("InflateParams")` removes the warning about using `null` as the parent view group when inflating the `AlertDialog`.
  81     @SuppressLint("InflateParams")
  82     @Override
  83     @NonNull
  84     public Dialog onCreateDialog(Bundle savedInstanceState) {
  85         // 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`.
  86         bookmarksDatabaseHelper = new BookmarksDatabaseHelper(getContext(), null, null, 0);
  87
  88         // Use `AlertDialog.Builder` to create the `AlertDialog`.
  89         AlertDialog.Builder dialogBuilder;
  90
  91         // Set the style according to the theme.
  92         if (MainWebViewActivity.darkTheme) {
  93             dialogBuilder = new AlertDialog.Builder(getActivity(), R.style.PrivacyBrowserAlertDialogDark);
  94         } else {
  95             dialogBuilder = new AlertDialog.Builder(getActivity(), R.style.PrivacyBrowserAlertDialogLight);
  96         }
  97
  98         // Set the title.
  99         dialogBuilder.setTitle(R.string.move_to_folder);
 100
 101         // Set the view.  The parent view is `null` because it will be assigned by `AlertDialog`.
 102         dialogBuilder.setView(getActivity().getLayoutInflater().inflate(R.layout.move_to_folder_dialog, null));
 103
 104         // Set an `onClick()` listener for the negative button.
 105         dialogBuilder.setNegativeButton(R.string.cancel, (DialogInterface dialog, int which) -> {
 106             // Do nothing.  The `AlertDialog` will close automatically.
 107         });
 108
 109         // Set the `onClick()` listener fo the positive button.
 110         dialogBuilder.setPositiveButton(R.string.move, (DialogInterface dialog, int which) -> {
 111             // Return the `DialogFragment` to the parent activity on save.
 112             moveToFolderListener.onMoveToFolder(MoveToFolderDialog.this);
 113         });
 114
 115         // Create an `AlertDialog` from the `AlertDialog.Builder`.
 116         final AlertDialog alertDialog = dialogBuilder.create();
 117
 118         // Show the `AlertDialog` so the items in the layout can be modified.
 119         alertDialog.show();
 120
 121         // Get a handle for the positive button.
 122         final Button moveButton = alertDialog.getButton(AlertDialog.BUTTON_POSITIVE);
 123
 124         // Initially disable the positive button.
 125         moveButton.setEnabled(false);
 126
 127         // Initialize the variables.
 128         Cursor foldersCursor;
 129         CursorAdapter foldersCursorAdapter;
 130         exceptFolders = new StringBuilder();
 131
 132         // Check to see if we are in the `Home Folder`.
 133         if (BookmarksActivity.currentFolder.isEmpty()) {  // Don't display `Home Folder` at the top of the `ListView`.
 134             // If a folder is selected, add it and all children to the list of folders not to display.
 135             long[] selectedBookmarksLongArray = BookmarksActivity.checkedItemIds;
 136             for (long databaseIdLong : selectedBookmarksLongArray) {
 137                 // Get `databaseIdInt` for each selected bookmark.
 138                 int databaseIdInt = (int) databaseIdLong;
 139
 140                 // If `databaseIdInt` is a folder.
 141                 if (bookmarksDatabaseHelper.isFolder(databaseIdInt)) {
 142                     // Get the name of the selected folder.
 143                     String folderName = bookmarksDatabaseHelper.getFolderName(databaseIdInt);
 144
 145                     // Populate the list of folders not to get.
 146                     if (exceptFolders.toString().isEmpty()){
 147                         // Add the selected folder to the list of folders not to display.
 148                         exceptFolders.append(DatabaseUtils.sqlEscapeString(folderName));
 149                     } else {
 150                         // Add the selected folder to the end of the list of folders not to display.
 151                         exceptFolders.append(",");
 152                         exceptFolders.append(DatabaseUtils.sqlEscapeString(folderName));
 153                     }
 154
 155                     // Add the selected folder's subfolders to the list of folders not to display.
 156                     addSubfoldersToExceptFolders(folderName);
 157                 }
 158             }
 159
 160             // Get a `Cursor` containing the folders to display.
 161             foldersCursor = bookmarksDatabaseHelper.getFoldersCursorExcept(exceptFolders.toString());
 162
 163             // Setup `foldersCursorAdaptor` with `this` context.  `false` disables autoRequery.
 164             foldersCursorAdapter = new CursorAdapter(alertDialog.getContext(), foldersCursor, false) {
 165                 @Override
 166                 public View newView(Context context, Cursor cursor, ViewGroup parent) {
 167                     // Inflate the individual item layout.  `false` does not attach it to the root.
 168                     return getActivity().getLayoutInflater().inflate(R.layout.move_to_folder_item_linearlayout, parent, false);
 169                 }
 170
 171                 @Override
 172                 public void bindView(View view, Context context, Cursor cursor) {
 173                     // Get the folder icon from `cursor`.
 174                     byte[] folderIconByteArray = cursor.getBlob(cursor.getColumnIndex(BookmarksDatabaseHelper.FAVORITE_ICON));
 175                     // Convert the byte array to a `Bitmap` beginning at the first byte and ending at the last.
 176                     Bitmap folderIconBitmap = BitmapFactory.decodeByteArray(folderIconByteArray, 0, folderIconByteArray.length);
 177                     // Display `folderIconBitmap` in `move_to_folder_icon`.
 178                     ImageView folderIconImageView = view.findViewById(R.id.move_to_folder_icon);
 179                     folderIconImageView.setImageBitmap(folderIconBitmap);
 180
 181                     // Get the folder name from `cursor` and display it in `move_to_folder_name_textview`.
 182                     String folderName = cursor.getString(cursor.getColumnIndex(BookmarksDatabaseHelper.BOOKMARK_NAME));
 183                     TextView folderNameTextView = view.findViewById(R.id.move_to_folder_name_textview);
 184                     folderNameTextView.setText(folderName);
 185                 }
 186             };
 187         } else {  // Display `Home Folder` at the top of the `ListView`.
 188             // Get the home folder icon drawable and convert it to a `Bitmap`.  `this` specifies the current context.
 189             Drawable homeFolderIconDrawable = ContextCompat.getDrawable(getActivity().getApplicationContext(), R.drawable.folder_gray_bitmap);
 190             BitmapDrawable homeFolderIconBitmapDrawable = (BitmapDrawable) homeFolderIconDrawable;
 191             Bitmap homeFolderIconBitmap = homeFolderIconBitmapDrawable.getBitmap();
 192             // Convert the folder `Bitmap` to a byte array.  `0` is for lossless compression (the only option for a PNG).
 193             ByteArrayOutputStream homeFolderIconByteArrayOutputStream = new ByteArrayOutputStream();
 194             homeFolderIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, homeFolderIconByteArrayOutputStream);
 195             byte[] homeFolderIconByteArray = homeFolderIconByteArrayOutputStream.toByteArray();
 196
 197             // Setup a `MatrixCursor` for the `Home Folder`.
 198             String[] homeFolderMatrixCursorColumnNames = {BookmarksDatabaseHelper._ID, BookmarksDatabaseHelper.BOOKMARK_NAME, BookmarksDatabaseHelper.FAVORITE_ICON};
 199             MatrixCursor homeFolderMatrixCursor = new MatrixCursor(homeFolderMatrixCursorColumnNames);
 200             homeFolderMatrixCursor.addRow(new Object[]{0, getString(R.string.home_folder), homeFolderIconByteArray});
 201
 202             // Add the parent folder to the list of folders not to display.
 203             exceptFolders.append(DatabaseUtils.sqlEscapeString(BookmarksActivity.currentFolder));
 204
 205             // If a folder is selected, add it and all children to the list of folders not to display.
 206             long[] selectedBookmarksLongArray = BookmarksActivity.checkedItemIds;
 207             for (long databaseIdLong : selectedBookmarksLongArray) {
 208                 // Get `databaseIdInt` for each selected bookmark.
 209                 int databaseIdInt = (int) databaseIdLong;
 210
 211                 // If `databaseIdInt` is a folder.
 212                 if (bookmarksDatabaseHelper.isFolder(databaseIdInt)) {
 213                     // Get the name of the selected folder.
 214                     String folderName = bookmarksDatabaseHelper.getFolderName(databaseIdInt);
 215
 216                     // Add the selected folder to the end of the list of folders not to display.
 217                     exceptFolders.append(",");
 218                     exceptFolders.append(DatabaseUtils.sqlEscapeString(folderName));
 219
 220                     // Add the selected folder's subfolders to the list of folders not to display.
 221                     addSubfoldersToExceptFolders(folderName);
 222                 }
 223             }
 224
 225             // Get a `Cursor` containing the folders to display.
 226             foldersCursor = bookmarksDatabaseHelper.getFoldersCursorExcept(exceptFolders.toString());
 227
 228             // Combine `homeFolderMatrixCursor` and `foldersCursor`.
 229             MergeCursor foldersMergeCursor = new MergeCursor(new Cursor[]{homeFolderMatrixCursor, foldersCursor});
 230
 231             // Setup `foldersCursorAdaptor`.  `false` disables autoRequery.
 232             foldersCursorAdapter = new CursorAdapter(alertDialog.getContext(), foldersMergeCursor, false) {
 233                 @Override
 234                 public View newView(Context context, Cursor cursor, ViewGroup parent) {
 235                     // Inflate the individual item layout.  `false` does not attach it to the root.
 236                     return getActivity().getLayoutInflater().inflate(R.layout.move_to_folder_item_linearlayout, parent, false);
 237                 }
 238
 239                 @Override
 240                 public void bindView(View view, Context context, Cursor cursor) {
 241                     // Get the folder icon from `cursor`.
 242                     byte[] folderIconByteArray = cursor.getBlob(cursor.getColumnIndex(BookmarksDatabaseHelper.FAVORITE_ICON));
 243                     // Convert the byte array to a `Bitmap` beginning at the first byte and ending at the last.
 244                     Bitmap folderIconBitmap = BitmapFactory.decodeByteArray(folderIconByteArray, 0, folderIconByteArray.length);
 245                     // Display `folderIconBitmap` in `move_to_folder_icon`.
 246                     ImageView folderIconImageView = view.findViewById(R.id.move_to_folder_icon);
 247                     folderIconImageView.setImageBitmap(folderIconBitmap);
 248
 249                     // Get the folder name from `cursor` and display it in `move_to_folder_name_textview`.
 250                     String folderName = cursor.getString(cursor.getColumnIndex(BookmarksDatabaseHelper.BOOKMARK_NAME));
 251                     TextView folderNameTextView = view.findViewById(R.id.move_to_folder_name_textview);
 252                     folderNameTextView.setText(folderName);
 253                 }
 254             };
 255         }
 256
 257         // Display the ListView
 258         ListView foldersListView = alertDialog.findViewById(R.id.move_to_folder_listview);
 259         foldersListView.setAdapter(foldersCursorAdapter);
 260
 261         // Enable the move button when a folder is selected.
 262         foldersListView.setOnItemClickListener((AdapterView<?> parent, View view, int position, long id) -> {
 263             // Enable the move button.
 264             moveButton.setEnabled(true);
 265         });
 266
 267         // `onCreateDialog` requires the return of an `AlertDialog`.
 268         return alertDialog;
 269     }
 270
 271     private void addSubfoldersToExceptFolders(String folderName) {
 272         // Get a `Cursor` will all the immediate subfolders.
 273         Cursor subfoldersCursor = bookmarksDatabaseHelper.getSubfoldersCursor(folderName);
 274
 275         for (int i = 0; i < subfoldersCursor.getCount(); i++) {
 276             // Move `subfolderCursor` to the current item.
 277             subfoldersCursor.moveToPosition(i);
 278
 279             // Get the name of the subfolder.
 280             String subfolderName = subfoldersCursor.getString(subfoldersCursor.getColumnIndex(BookmarksDatabaseHelper.BOOKMARK_NAME));
 281
 282             // Add the subfolder to `exceptFolders`.
 283             exceptFolders.append(",");
 284             exceptFolders.append(DatabaseUtils.sqlEscapeString(subfolderName));
 285
 286             // Run the same tasks for any subfolders of the subfolder.
 287             addSubfoldersToExceptFolders(subfolderName);
 288         }
 289     }
 290 }