]> gitweb.stoutner.com Git - PrivacyBrowserAndroid.git/blobdiff - app/src/main/java/com/stoutner/privacybrowser/BookmarksDatabaseHandler.java
Refactor the code to make all the Java files lint free.
[PrivacyBrowserAndroid.git] / app / src / main / java / com / stoutner / privacybrowser / BookmarksDatabaseHandler.java
index bc17bc7dba7c4d4c068a36d08dca8f8f41efbb4d..3d4b7f817ae6170545d8bf3403bed4d3b8c1280a 100644 (file)
@@ -25,22 +25,22 @@ import android.database.Cursor;
 import android.database.DatabaseUtils;
 import android.database.sqlite.SQLiteDatabase;
 import android.database.sqlite.SQLiteOpenHelper;
-import android.provider.ContactsContract;
 
-public class BookmarksDatabaseHandler extends SQLiteOpenHelper {
+class BookmarksDatabaseHandler extends SQLiteOpenHelper {
     private static final int SCHEMA_VERSION = 1;
     private static final String BOOKMARKS_DATABASE = "bookmarks.db";
     private static final String BOOKMARKS_TABLE = "bookmarks";
 
-    public static final String _ID = "_id";
-    public static final String DISPLAY_ORDER = "displayorder";
-    public static final String BOOKMARK_NAME = "bookmarkname";
-    public static final String BOOKMARK_URL = "bookmarkurl";
-    public static final String PARENT_FOLDER = "parentfolder";
-    public static final String IS_FOLDER = "isfolder";
-    public static final String FAVORITE_ICON = "favoriteicon";
+    static final String _ID = "_id";
+    static final String DISPLAY_ORDER = "displayorder";
+    static final String BOOKMARK_NAME = "bookmarkname";
+    static final String BOOKMARK_URL = "bookmarkurl";
+    static final String PARENT_FOLDER = "parentfolder";
+    static final String IS_FOLDER = "isfolder";
+    static final String FAVORITE_ICON = "favoriteicon";
 
-    public BookmarksDatabaseHandler(Context context, String name, SQLiteDatabase.CursorFactory factory, int version) {
+    // Initialize the database.  The lint warnings for the unused parameters are suppressed.
+    BookmarksDatabaseHandler(Context context, @SuppressWarnings("UnusedParameters") String name, SQLiteDatabase.CursorFactory factory, @SuppressWarnings("UnusedParameters") int version) {
         super(context, BOOKMARKS_DATABASE, factory, SCHEMA_VERSION);
     }
 
@@ -64,7 +64,7 @@ public class BookmarksDatabaseHandler extends SQLiteOpenHelper {
         // Code for upgrading the database will be added here when the schema version > 1.
     }
 
-    public void createBookmark(String bookmarkName, String bookmarkURL, int displayOrder, String parentFolder, byte[] favoriteIcon) {
+    void createBookmark(String bookmarkName, String bookmarkURL, int displayOrder, String parentFolder, byte[] favoriteIcon) {
         ContentValues bookmarkContentValues = new ContentValues();
 
         // ID is created automatically.
@@ -85,7 +85,7 @@ public class BookmarksDatabaseHandler extends SQLiteOpenHelper {
         bookmarksDatabase.close();
     }
 
-    public void createFolder(String folderName, int displayOrder, String parentFolder, byte[] favoriteIcon) {
+    void createFolder(String folderName, int displayOrder, String parentFolder, byte[] favoriteIcon) {
         ContentValues bookmarkContentValues = new ContentValues();
 
         // ID is created automatically.
@@ -105,7 +105,7 @@ public class BookmarksDatabaseHandler extends SQLiteOpenHelper {
         bookmarksDatabase.close();
     }
 
-    public Cursor getBookmarkCursor(int databaseId) {
+    Cursor getBookmarkCursor(int databaseId) {
         // Get a readable database handle.
         SQLiteDatabase bookmarksDatabase = this.getReadableDatabase();
 
@@ -118,7 +118,30 @@ public class BookmarksDatabaseHandler extends SQLiteOpenHelper {
         return bookmarksDatabase.rawQuery(GET_ONE_BOOKMARK, null);
     }
 
-    public Cursor getFolderCursor(String folderName) {
+    String getFolderName (int databaseId) {
+        // Get a readable database handle.
+        SQLiteDatabase bookmarksDatabase = this.getReadableDatabase();
+
+        // Prepare the SQL statement to get the `Cursor` for the folder.
+        final String GET_FOLDER = "Select * FROM " + BOOKMARKS_TABLE +
+                " WHERE " + _ID + " = " + databaseId;
+
+        // Get `folderCursor`.  The second argument is `null` because there are no `selectionArgs`.
+        Cursor folderCursor = bookmarksDatabase.rawQuery(GET_FOLDER, null);
+
+        // Get `folderName`.
+        folderCursor.moveToFirst();
+        String folderName = folderCursor.getString(folderCursor.getColumnIndex(BOOKMARK_NAME));
+
+        // Close the cursor and the database handle.
+        folderCursor.close();
+        bookmarksDatabase.close();
+
+        // Return the folder name.
+        return folderName;
+    }
+
+    Cursor getFolderCursor(String folderName) {
         // Get a readable database handle.
         SQLiteDatabase bookmarksDatabase = this.getReadableDatabase();
 
@@ -135,7 +158,39 @@ public class BookmarksDatabaseHandler extends SQLiteOpenHelper {
         return bookmarksDatabase.rawQuery(GET_FOLDER, null);
     }
 
-    public String getParentFolder(String currentFolder) {
+    Cursor getFoldersCursorExcept(String exceptFolders) {
+        // Get a readable database handle.
+        SQLiteDatabase bookmarksDatabase = this.getReadableDatabase();
+
+        // Prepare the SQL statement to get the `Cursor` for the folders.
+        final String GET_FOLDERS_EXCEPT = "Select * FROM " + BOOKMARKS_TABLE +
+                " WHERE " + IS_FOLDER + " = " + 1 +
+                " AND " + BOOKMARK_NAME + " NOT IN (" + exceptFolders +
+                ") ORDER BY " + BOOKMARK_NAME + " ASC";
+
+        // Return the results as a `Cursor`.  The second argument is `null` because there are no `selectionArgs`.
+        // We can't close the `Cursor` because we need to use it in the parent activity.
+        return bookmarksDatabase.rawQuery(GET_FOLDERS_EXCEPT, null);
+    }
+
+    Cursor getSubfoldersCursor(String currentFolder) {
+        // Get a readable database handle.
+        SQLiteDatabase bookmarksDatabase = this.getReadableDatabase();
+
+        // SQL escape `currentFolder.
+        currentFolder = DatabaseUtils.sqlEscapeString(currentFolder);
+
+        // Prepare the SQL statement to get the `Cursor` for the subfolders.
+        final String GET_SUBFOLDERS = "Select * FROM " + BOOKMARKS_TABLE +
+                " WHERE " + PARENT_FOLDER + " = " + currentFolder +
+                " AND " + IS_FOLDER + " = " + 1;
+
+        // Return the results as a `Cursor`.  The second argument is `null` because there are no `selectionArgs`.
+        // We can't close the `Cursor` because we need to use it in the parent activity.
+        return bookmarksDatabase.rawQuery(GET_SUBFOLDERS, null);
+    }
+
+    String getParentFolder(String currentFolder) {
         // Get a readable database handle.
         SQLiteDatabase bookmarksDatabase = this.getReadableDatabase();
 
@@ -144,7 +199,8 @@ public class BookmarksDatabaseHandler extends SQLiteOpenHelper {
 
         // Prepare the SQL statement to get the parent folder.
         final String GET_PARENT_FOLDER = "Select * FROM " + BOOKMARKS_TABLE +
-                " WHERE " + IS_FOLDER + " = " + 1 + " AND " + BOOKMARK_NAME + " = " + currentFolder;
+                " WHERE " + IS_FOLDER + " = " + 1 +
+                " AND " + BOOKMARK_NAME + " = " + currentFolder;
 
         // The second argument is `null` because there are no `selectionArgs`.
         Cursor bookmarkCursor = bookmarksDatabase.rawQuery(GET_PARENT_FOLDER, null);
@@ -159,7 +215,7 @@ public class BookmarksDatabaseHandler extends SQLiteOpenHelper {
         return parentFolder;
     }
 
-    public Cursor getAllBookmarksCursor() {
+    Cursor getAllBookmarksCursor() {
         // Get a readable database handle.
         SQLiteDatabase bookmarksDatabase = this.getReadableDatabase();
 
@@ -171,7 +227,7 @@ public class BookmarksDatabaseHandler extends SQLiteOpenHelper {
         return bookmarksDatabase.rawQuery(GET_ALL_BOOKMARKS, null);
     }
 
-    public Cursor getAllBookmarksCursorByDisplayOrder(String folderName) {
+    Cursor getAllBookmarksCursorByDisplayOrder(String folderName) {
         // Get a readable database handle.
         SQLiteDatabase bookmarksDatabase = this.getReadableDatabase();
 
@@ -180,14 +236,15 @@ public class BookmarksDatabaseHandler extends SQLiteOpenHelper {
 
         // Get everything in the BOOKMARKS_TABLE.
         final String GET_ALL_BOOKMARKS = "Select * FROM " + BOOKMARKS_TABLE +
-                " WHERE " + PARENT_FOLDER + " = " + folderName + " ORDER BY " + DISPLAY_ORDER + " ASC";
+                " WHERE " + PARENT_FOLDER + " = " + folderName +
+                " ORDER BY " + DISPLAY_ORDER + " ASC";
 
         // Return the results as a Cursor.  The second argument is `null` because there are no selectionArgs.
         // We can't close the Cursor because we need to use it in the parent activity.
         return bookmarksDatabase.rawQuery(GET_ALL_BOOKMARKS, null);
     }
 
-    public Cursor getBookmarksCursorExcept(long[] exceptIdLongArray, String folderName) {
+    Cursor getBookmarksCursorExcept(long[] exceptIdLongArray, String folderName) {
         // Get a readable database handle.
         SQLiteDatabase bookmarksDatabase = this.getReadableDatabase();
 
@@ -208,14 +265,38 @@ public class BookmarksDatabaseHandler extends SQLiteOpenHelper {
 
         // Prepare the SQL statement to select all items except those with the specified IDs.
         final String GET_All_BOOKMARKS_EXCEPT_SPECIFIED = "Select * FROM " + BOOKMARKS_TABLE +
-                " WHERE " + PARENT_FOLDER + " = " + folderName + " AND " + _ID + " NOT IN (" + doNotGetIdsString + ") ORDER BY " + DISPLAY_ORDER + " ASC";
+                " WHERE " + PARENT_FOLDER + " = " + folderName +
+                " AND " + _ID + " NOT IN (" + doNotGetIdsString +
+                ") ORDER BY " + DISPLAY_ORDER + " ASC";
 
-        // Return the results as a `Cursor`.  The second argument is `null` because there are no selectionArgs.
+        // Return the results as a `Cursor`.  The second argument is `null` because there are no `selectionArgs`.
         // We can't close the `Cursor` because we need to use it in the parent activity.
         return bookmarksDatabase.rawQuery(GET_All_BOOKMARKS_EXCEPT_SPECIFIED, null);
     }
 
-    public void updateBookmark(int databaseId, String bookmarkName, String bookmarkUrl) {
+    boolean isFolder(int databaseId) {
+        // Get a readable database handle.
+        SQLiteDatabase bookmarksDatabase = this.getReadableDatabase();
+
+        // Prepare the SQL statement to determine if `databaseId` is a folder.
+        final String CHECK_IF_FOLDER = "Select * FROM " + BOOKMARKS_TABLE +
+                " WHERE " + _ID + " = " + databaseId;
+
+        // Populate folderCursor.  The second argument is `null` because there are no `selectionArgs`.
+        Cursor folderCursor = bookmarksDatabase.rawQuery(CHECK_IF_FOLDER, null);
+
+        // Ascertain if this database ID is a folder.
+        folderCursor.moveToFirst();
+        boolean isFolder = (folderCursor.getInt(folderCursor.getColumnIndex(IS_FOLDER)) == 1);
+
+        // Close the `Cursor` and the database handle.
+        folderCursor.close();
+        bookmarksDatabase.close();
+
+        return isFolder;
+    }
+
+    void updateBookmark(int databaseId, String bookmarkName, String bookmarkUrl) {
         // Store the updated values in `bookmarkContentValues`.
         ContentValues bookmarkContentValues = new ContentValues();
 
@@ -232,7 +313,7 @@ public class BookmarksDatabaseHandler extends SQLiteOpenHelper {
         bookmarksDatabase.close();
     }
 
-    public void updateBookmark(int databaseId, String bookmarkName, String bookmarkUrl, byte[] favoriteIcon) {
+    void updateBookmark(int databaseId, String bookmarkName, String bookmarkUrl, byte[] favoriteIcon) {
         // Store the updated values in `bookmarkContentValues`.
         ContentValues bookmarkContentValues = new ContentValues();
 
@@ -250,7 +331,7 @@ public class BookmarksDatabaseHandler extends SQLiteOpenHelper {
         bookmarksDatabase.close();
     }
 
-    public void updateFolder(int databaseId, String oldFolderName, String newFolderName) {
+    void updateFolder(int databaseId, String oldFolderName, String newFolderName) {
         // Get a writable database handle.
         SQLiteDatabase bookmarksDatabase = this.getWritableDatabase();
 
@@ -278,7 +359,7 @@ public class BookmarksDatabaseHandler extends SQLiteOpenHelper {
         bookmarksDatabase.close();
     }
 
-    public void updateFolder(int databaseId, String oldFolderName, String newFolderName, byte[] folderIcon) {
+    void updateFolder(int databaseId, String oldFolderName, String newFolderName, byte[] folderIcon) {
         // Get a writable database handle.
         SQLiteDatabase bookmarksDatabase = this.getWritableDatabase();
 
@@ -307,23 +388,54 @@ public class BookmarksDatabaseHandler extends SQLiteOpenHelper {
         bookmarksDatabase.close();
     }
 
-    public void updateBookmarkDisplayOrder(int databaseId, int displayOrder) {
-        // Store the updated values in `bookmarkContentValues`.
-        ContentValues bookmarkContentValues = new ContentValues();
+    void updateBookmarkDisplayOrder(int databaseId, int displayOrder) {
+        // Get a writable database handle.
+        SQLiteDatabase bookmarksDatabase = this.getWritableDatabase();
 
+        // Store the new display order in `bookmarkContentValues`.
+        ContentValues bookmarkContentValues = new ContentValues();
         bookmarkContentValues.put(DISPLAY_ORDER, displayOrder);
 
+        // Update the database.  The last argument is `null` because there are no `whereArgs`.
+        bookmarksDatabase.update(BOOKMARKS_TABLE, bookmarkContentValues, _ID + " = " + databaseId, null);
+
+        // Close the database handle.
+        bookmarksDatabase.close();
+    }
+
+    void moveToFolder(int databaseId, String newFolder) {
         // Get a writable database handle.
         SQLiteDatabase bookmarksDatabase = this.getWritableDatabase();
 
-        // Update the database.  The last argument is `null` because there are no `whereArgs`.
+        // Get the highest `DISPLAY_ORDER` in the new folder
+        String newFolderSqlEscaped = DatabaseUtils.sqlEscapeString(newFolder);
+        final String NEW_FOLDER = "Select * FROM " + BOOKMARKS_TABLE +
+                " WHERE " + PARENT_FOLDER + " = " + newFolderSqlEscaped +
+                " ORDER BY " + DISPLAY_ORDER + " ASC";
+        // The second argument is `null` because there are no `selectionArgs`.
+        Cursor newFolderCursor = bookmarksDatabase.rawQuery(NEW_FOLDER, null);
+        int displayOrder;
+        if (newFolderCursor.getCount() > 0) {
+            newFolderCursor.moveToLast();
+            displayOrder = newFolderCursor.getInt(newFolderCursor.getColumnIndex(DISPLAY_ORDER)) + 1;
+        } else {
+            displayOrder = 0;
+        }
+        newFolderCursor.close();
+
+        // Store the new values in `bookmarkContentValues`.
+        ContentValues bookmarkContentValues = new ContentValues();
+        bookmarkContentValues.put(DISPLAY_ORDER, displayOrder);
+        bookmarkContentValues.put(PARENT_FOLDER, newFolder);
+
+        // Update the database.  The last argument is 'null' because there are no 'whereArgs'.
         bookmarksDatabase.update(BOOKMARKS_TABLE, bookmarkContentValues, _ID + " = " + databaseId, null);
 
         // Close the database handle.
         bookmarksDatabase.close();
     }
 
-    public void deleteBookmark(int databaseId) {
+    void deleteBookmark(int databaseId) {
         // Get a writable database handle.
         SQLiteDatabase bookmarksDatabase = this.getWritableDatabase();