]> gitweb.stoutner.com Git - PrivacyBrowserAndroid.git/blobdiff - app/src/main/java/com/stoutner/privacybrowser/helpers/BookmarksDatabaseHelper.java
Remove Google's Ad Consent library. https://redmine.stoutner.com/issues/329
[PrivacyBrowserAndroid.git] / app / src / main / java / com / stoutner / privacybrowser / helpers / BookmarksDatabaseHelper.java
index 532c771d51e4c93d0b82ff6d6cc363e5b337f827..7eb584b52763b5f0fde25ae4390f443a27de740c 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright © 2016-2017 Soren Stoutner <soren@stoutner.com>.
+ * Copyright © 2016-2018 Soren Stoutner <soren@stoutner.com>.
  *
  * This file is part of Privacy Browser <https://www.stoutner.com/privacy-browser>.
  *
@@ -28,17 +28,26 @@ import android.database.sqlite.SQLiteOpenHelper;
 
 public class BookmarksDatabaseHelper extends SQLiteOpenHelper {
     private static final int SCHEMA_VERSION = 1;
-    private static final String BOOKMARKS_DATABASE = "bookmarks.db";
-    private static final String BOOKMARKS_TABLE = "bookmarks";
+    static final String BOOKMARKS_DATABASE = "bookmarks.db";
+    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 DISPLAY_ORDER = "displayorder";
     public static final String IS_FOLDER = "isfolder";
     public static final String FAVORITE_ICON = "favoriteicon";
 
+    static final String CREATE_BOOKMARKS_TABLE = "CREATE TABLE " + BOOKMARKS_TABLE + " (" +
+            _ID + " INTEGER PRIMARY KEY, " +
+            BOOKMARK_NAME + " TEXT, " +
+            BOOKMARK_URL + " TEXT, " +
+            PARENT_FOLDER + " TEXT, " +
+            DISPLAY_ORDER + " INTEGER, " +
+            IS_FOLDER + " BOOLEAN, " +
+            FAVORITE_ICON + " BLOB)";
+
     // Initialize the database.  The lint warnings for the unused parameters are suppressed.
     public BookmarksDatabaseHelper(Context context, @SuppressWarnings("UnusedParameters") String name, SQLiteDatabase.CursorFactory cursorFactory, @SuppressWarnings("UnusedParameters") int version) {
         super(context, BOOKMARKS_DATABASE, cursorFactory, SCHEMA_VERSION);
@@ -46,17 +55,7 @@ public class BookmarksDatabaseHelper extends SQLiteOpenHelper {
 
     @Override
     public void onCreate(SQLiteDatabase bookmarksDatabase) {
-        // Setup the SQL string to create the `bookmarks` table.
-        final String CREATE_BOOKMARKS_TABLE = "CREATE TABLE " + BOOKMARKS_TABLE + " (" +
-                _ID + " integer primary key, " +
-                DISPLAY_ORDER + " integer, " +
-                BOOKMARK_NAME + " text, " +
-                BOOKMARK_URL + " text, " +
-                PARENT_FOLDER + " text, " +
-                IS_FOLDER + " boolean, " +
-                FAVORITE_ICON + " blob);";
-
-        // Create the `bookmarks` table.
+        // Create the bookmarks table.
         bookmarksDatabase.execSQL(CREATE_BOOKMARKS_TABLE);
     }
 
@@ -66,15 +65,15 @@ public class BookmarksDatabaseHelper extends SQLiteOpenHelper {
     }
 
     // Create a bookmark.
-    public void createBookmark(String bookmarkName, String bookmarkURL, int displayOrder, String parentFolder, byte[] favoriteIcon) {
-        // We need to store the bookmark data in a `ContentValues`.
+    public void createBookmark(String bookmarkName, String bookmarkURL, String parentFolder, int displayOrder, byte[] favoriteIcon) {
+        // Store the bookmark data in a `ContentValues`.
         ContentValues bookmarkContentValues = new ContentValues();
 
         // ID is created automatically.
-        bookmarkContentValues.put(DISPLAY_ORDER, displayOrder);
         bookmarkContentValues.put(BOOKMARK_NAME, bookmarkName);
         bookmarkContentValues.put(BOOKMARK_URL, bookmarkURL);
         bookmarkContentValues.put(PARENT_FOLDER, parentFolder);
+        bookmarkContentValues.put(DISPLAY_ORDER, displayOrder);
         bookmarkContentValues.put(IS_FOLDER, false);
         bookmarkContentValues.put(FAVORITE_ICON, favoriteIcon);
 
@@ -88,14 +87,26 @@ public class BookmarksDatabaseHelper extends SQLiteOpenHelper {
         bookmarksDatabase.close();
     }
 
+    // Create a bookmark from content values.
+    void createBookmark(ContentValues contentValues) {
+        // Get a writable database.
+        SQLiteDatabase bookmarksDatabase = this.getWritableDatabase();
+
+        // Insert a new row.  The second argument is `null`, which makes it so that a completely null row cannot be created.
+        bookmarksDatabase.insert(BOOKMARKS_TABLE, null, contentValues);
+
+        // Close the database handle.
+        bookmarksDatabase.close();
+    }
+
     // Create a folder.
-    public void createFolder(String folderName, int displayOrder, String parentFolder, byte[] favoriteIcon) {
+    public void createFolder(String folderName, String parentFolder, byte[] favoriteIcon) {
         ContentValues bookmarkContentValues = new ContentValues();
 
-        // ID is created automatically.
-        bookmarkContentValues.put(DISPLAY_ORDER, displayOrder);
+        // ID is created automatically.  Folders are always created at the top of the list.
         bookmarkContentValues.put(BOOKMARK_NAME, folderName);
         bookmarkContentValues.put(PARENT_FOLDER, parentFolder);
+        bookmarkContentValues.put(DISPLAY_ORDER, 0);
         bookmarkContentValues.put(IS_FOLDER, true);
         bookmarkContentValues.put(FAVORITE_ICON, favoriteIcon);
 
@@ -114,8 +125,8 @@ public class BookmarksDatabaseHelper extends SQLiteOpenHelper {
         // Get a readable database handle.
         SQLiteDatabase bookmarksDatabase = this.getReadableDatabase();
 
-        // Prepare the SQL statement to get the `Cursor` for `databaseId`
-        final String GET_ONE_BOOKMARK = "SELECT * FROM " + BOOKMARKS_TABLE +
+        // Prepare the SQL statement to get the cursor for the database ID.
+        String GET_ONE_BOOKMARK = "SELECT * FROM " + BOOKMARKS_TABLE +
                 " WHERE " + _ID + " = " + databaseId;
 
         // 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.
@@ -127,14 +138,14 @@ public class BookmarksDatabaseHelper extends SQLiteOpenHelper {
         // 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 +
+        // Prepare the SQL statement to get the cursor for the folder.
+        String GET_FOLDER = "SELECT * FROM " + BOOKMARKS_TABLE +
                 " WHERE " + _ID + " = " + databaseId;
 
-        // Get `folderCursor`.  The second argument is `null` because there are no `selectionArgs`.
+        // Get a folder cursor.
         Cursor folderCursor = bookmarksDatabase.rawQuery(GET_FOLDER, null);
 
-        // Get `folderName`.
+        // Get the folder name.
         folderCursor.moveToFirst();
         String folderName = folderCursor.getString(folderCursor.getColumnIndex(BOOKMARK_NAME));
 
@@ -146,6 +157,34 @@ public class BookmarksDatabaseHelper extends SQLiteOpenHelper {
         return folderName;
     }
 
+    // The the database ID for the specified folder name.
+    public int getFolderDatabaseId (String folderName) {
+        // Get a readable database handle.
+        SQLiteDatabase bookmarksDatabase = this.getReadableDatabase();
+
+        // SQL escape `folderName`.
+        folderName = DatabaseUtils.sqlEscapeString(folderName);
+
+        // Prepare the SQL statement to get the `Cursor` for the folder.
+        final String GET_FOLDER = "SELECT * FROM " + BOOKMARKS_TABLE +
+                " WHERE " + BOOKMARK_NAME + " = " + folderName +
+                " AND " + IS_FOLDER + " = " + 1;
+
+        // Get `folderCursor`.  The second argument is `null` because there are no `selectionArgs`.
+        Cursor folderCursor = bookmarksDatabase.rawQuery(GET_FOLDER, null);
+
+        // Get the database ID.
+        folderCursor.moveToFirst();
+        int databaseId = folderCursor.getInt(folderCursor.getColumnIndex(_ID));
+
+        // Close the cursor and the database handle.
+        folderCursor.close();
+        bookmarksDatabase.close();
+
+        // Return the database ID.
+        return databaseId;
+    }
+
     // Get a `Cursor` for the specified folder name.
     public Cursor getFolderCursor(String folderName) {
         // Get a readable database handle.
@@ -211,7 +250,7 @@ public class BookmarksDatabaseHelper extends SQLiteOpenHelper {
                 " WHERE " + IS_FOLDER + " = " + 1 +
                 " AND " + BOOKMARK_NAME + " = " + currentFolder;
 
-        // The second argument is `null` because there are no `selectionArgs`.
+        // Get the bookmark cursor and move to the first entry.
         Cursor bookmarkCursor = bookmarksDatabase.rawQuery(GET_PARENT_FOLDER, null);
         bookmarkCursor.moveToFirst();
 
@@ -244,11 +283,10 @@ public class BookmarksDatabaseHelper extends SQLiteOpenHelper {
         // Get a readable database handle.
         SQLiteDatabase bookmarksDatabase = this.getReadableDatabase();
 
-        // Get everything in `BOOKMARKS_TABLE`.
+        // Get everything in in the bookmarks table.
         final String GET_ALL_BOOKMARKS = "SELECT * FROM " + BOOKMARKS_TABLE;
 
-        // 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 the results as a Cursor.  The second argument is `null` because there are no selectionArgs.  The Cursor cannot be closed because it is used in the parent activity.
         return bookmarksDatabase.rawQuery(GET_ALL_BOOKMARKS, null);
     }
 
@@ -260,11 +298,11 @@ public class BookmarksDatabaseHelper extends SQLiteOpenHelper {
         // SQL escape `folderName`.
         folderName = DatabaseUtils.sqlEscapeString(folderName);
 
-        // Get everything in the `BOOKMARKS_TABLE` with `folderName` as the `PARENT_FOLDER`.
+        // Get everything in the bookmarks table with `folderName` as the `PARENT_FOLDER`.
         final String GET_ALL_BOOKMARKS = "SELECT * FROM " + BOOKMARKS_TABLE +
                 " WHERE " + PARENT_FOLDER + " = " + folderName;
 
-        // 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 the results as a `Cursor`.  The second argument is `null` because there are no `selectionArgs`.  The Cursor cannot be closed because it is used in the parent activity.
         return bookmarksDatabase.rawQuery(GET_ALL_BOOKMARKS, null);
     }
 
@@ -281,7 +319,7 @@ public class BookmarksDatabaseHelper extends SQLiteOpenHelper {
                 " 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 the results as a `Cursor`.  The second argument is `null` because there are no `selectionArgs`.  The Cursor cannot be closed because it is used in the parent activity.
         return bookmarksDatabase.rawQuery(GET_ALL_BOOKMARKS, null);
     }
 
@@ -290,15 +328,17 @@ public class BookmarksDatabaseHelper extends SQLiteOpenHelper {
         // Get a readable database handle.
         SQLiteDatabase bookmarksDatabase = this.getReadableDatabase();
 
-        // Prepare a string that contains the comma-separated list of IDs not to get.
-        String doNotGetIdsString = "";
+        // Prepare a string builder that contains the comma-separated list of IDs not to get.
+        StringBuilder doNotGetIdsStringBuilder = new StringBuilder();
+
         // Extract the array to `doNotGetIdsString`.
         for (long databaseIdLong : exceptIdLongArray) {
             // If this is the first number, only add the number.
-            if (doNotGetIdsString.isEmpty()) {
-                doNotGetIdsString = String.valueOf(databaseIdLong);
-            } else {  // If there already is a number in the string, place a `,` before the number.
-                doNotGetIdsString = doNotGetIdsString + "," + databaseIdLong;
+            if (doNotGetIdsStringBuilder.toString().isEmpty()) {
+                doNotGetIdsStringBuilder.append(databaseIdLong);
+            } else {  // If there already is a number in the string, place a `,` before the new number.
+                doNotGetIdsStringBuilder.append(",");
+                doNotGetIdsStringBuilder.append(databaseIdLong);
             }
         }
 
@@ -308,7 +348,7 @@ public class BookmarksDatabaseHelper 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 +
+                " AND " + _ID + " NOT IN (" + doNotGetIdsStringBuilder.toString() +
                 ") ORDER BY " + DISPLAY_ORDER + " ASC";
 
         // Return the results as a `Cursor`.  The second argument is `null` because there are no `selectionArgs`.
@@ -341,11 +381,33 @@ public class BookmarksDatabaseHelper extends SQLiteOpenHelper {
 
     // Update the bookmark name and URL.
     public void updateBookmark(int databaseId, String bookmarkName, String bookmarkUrl) {
-        // Store the updated values in `bookmarkContentValues`.
+        // Initialize a `ContentValues`.
+        ContentValues bookmarkContentValues = new ContentValues();
+
+        // Store the updated values.
+        bookmarkContentValues.put(BOOKMARK_NAME, bookmarkName);
+        bookmarkContentValues.put(BOOKMARK_URL, bookmarkUrl);
+
+        // Get a writable database handle.
+        SQLiteDatabase bookmarksDatabase = this.getWritableDatabase();
+
+        // Update the bookmark.  The last argument is `null` because there are no `whereArgs`.
+        bookmarksDatabase.update(BOOKMARKS_TABLE, bookmarkContentValues, _ID + " = " + databaseId, null);
+
+        // Close the database handle.
+        bookmarksDatabase.close();
+    }
+
+    // Update the bookmark name, URL, parent folder, and display order.
+    public void updateBookmark(int databaseId, String bookmarkName, String bookmarkUrl, String parentFolder, int displayOrder) {
+        // Initialize a `ContentValues`.
         ContentValues bookmarkContentValues = new ContentValues();
 
+        // Store the updated values.
         bookmarkContentValues.put(BOOKMARK_NAME, bookmarkName);
         bookmarkContentValues.put(BOOKMARK_URL, bookmarkUrl);
+        bookmarkContentValues.put(PARENT_FOLDER, parentFolder);
+        bookmarkContentValues.put(DISPLAY_ORDER, displayOrder);
 
         // Get a writable database handle.
         SQLiteDatabase bookmarksDatabase = this.getWritableDatabase();
@@ -359,9 +421,10 @@ public class BookmarksDatabaseHelper extends SQLiteOpenHelper {
 
     // Update the bookmark name, URL, and favorite icon.
     public void updateBookmark(int databaseId, String bookmarkName, String bookmarkUrl, byte[] favoriteIcon) {
-        // Store the updated values in `bookmarkContentValues`.
+        // Initialize a `ContentValues`.
         ContentValues bookmarkContentValues = new ContentValues();
 
+        // Store the updated values.
         bookmarkContentValues.put(BOOKMARK_NAME, bookmarkName);
         bookmarkContentValues.put(BOOKMARK_URL, bookmarkUrl);
         bookmarkContentValues.put(FAVORITE_ICON, favoriteIcon);
@@ -376,6 +439,28 @@ public class BookmarksDatabaseHelper extends SQLiteOpenHelper {
         bookmarksDatabase.close();
     }
 
+    // Update the bookmark name, URL, parent folder, display order, and favorite icon.
+    public void updateBookmark(int databaseId, String bookmarkName, String bookmarkUrl, String parentFolder, int displayOrder, byte[] favoriteIcon) {
+        // Initialize a `ContentValues`.
+        ContentValues bookmarkContentValues = new ContentValues();
+
+        // Store the updated values.
+        bookmarkContentValues.put(BOOKMARK_NAME, bookmarkName);
+        bookmarkContentValues.put(BOOKMARK_URL, bookmarkUrl);
+        bookmarkContentValues.put(PARENT_FOLDER, parentFolder);
+        bookmarkContentValues.put(DISPLAY_ORDER, displayOrder);
+        bookmarkContentValues.put(FAVORITE_ICON, favoriteIcon);
+
+        // Get a writable database handle.
+        SQLiteDatabase bookmarksDatabase = this.getWritableDatabase();
+
+        // Update the bookmark.  The last argument is `null` because there are no `whereArgs`.
+        bookmarksDatabase.update(BOOKMARKS_TABLE, bookmarkContentValues, _ID + " = " + databaseId, null);
+
+        // Close the database handle.
+        bookmarksDatabase.close();
+    }
+
     // Update the folder name.
     public void updateFolder(int databaseId, String oldFolderName, String newFolderName) {
         // Get a writable database handle.
@@ -418,6 +503,34 @@ public class BookmarksDatabaseHelper extends SQLiteOpenHelper {
         bookmarksDatabase.close();
     }
 
+    // Update the folder name, parent folder, and display order.
+    public void updateFolder(int databaseId, String oldFolderName, String newFolderName, String parentFolder, int displayOrder) {
+        // Get a writable database handle.
+        SQLiteDatabase bookmarksDatabase = this.getWritableDatabase();
+
+        // Update the folder first.  Store the new folder name in `folderContentValues`.
+        ContentValues folderContentValues = new ContentValues();
+        folderContentValues.put(BOOKMARK_NAME, newFolderName);
+        folderContentValues.put(PARENT_FOLDER, parentFolder);
+        folderContentValues.put(DISPLAY_ORDER, displayOrder);
+
+        // Run the update on the folder.  The last argument is `null` because there are no `whereArgs`.
+        bookmarksDatabase.update(BOOKMARKS_TABLE, folderContentValues, _ID + " = " + databaseId, null);
+
+        // Update the bookmarks inside the folder.  Store the new parent folder name in `bookmarkContentValues`.
+        ContentValues bookmarkContentValues = new ContentValues();
+        bookmarkContentValues.put(PARENT_FOLDER, newFolderName);
+
+        // SQL escape `oldFolderName`.
+        oldFolderName = DatabaseUtils.sqlEscapeString(oldFolderName);
+
+        // Run the update on all the bookmarks that currently list `oldFolderName` as their parent folder.  The last argument is `null` because there are no `whereArgs`.
+        bookmarksDatabase.update(BOOKMARKS_TABLE, bookmarkContentValues, PARENT_FOLDER + " = " + oldFolderName, null);
+
+        // Close the database handle.
+        bookmarksDatabase.close();
+    }
+
     // Update the folder name and icon.
     public void updateFolder(int databaseId, String oldFolderName, String newFolderName, byte[] folderIcon) {
         // Get a writable database handle.
@@ -445,6 +558,35 @@ public class BookmarksDatabaseHelper extends SQLiteOpenHelper {
         bookmarksDatabase.close();
     }
 
+    // Update the folder name and icon.
+    public void updateFolder(int databaseId, String oldFolderName, String newFolderName, String parentFolder, int displayOrder, byte[] folderIcon) {
+        // Get a writable database handle.
+        SQLiteDatabase bookmarksDatabase = this.getWritableDatabase();
+
+        // Update the folder first.  Store the updated values in `folderContentValues`.
+        ContentValues folderContentValues = new ContentValues();
+        folderContentValues.put(BOOKMARK_NAME, newFolderName);
+        folderContentValues.put(PARENT_FOLDER, parentFolder);
+        folderContentValues.put(DISPLAY_ORDER, displayOrder);
+        folderContentValues.put(FAVORITE_ICON, folderIcon);
+
+        // Run the update on the folder.  The last argument is `null` because there are no `whereArgs`.
+        bookmarksDatabase.update(BOOKMARKS_TABLE, folderContentValues, _ID + " = " + databaseId, null);
+
+        // Update the bookmarks inside the folder.  Store the new parent folder name in `bookmarkContentValues`.
+        ContentValues bookmarkContentValues = new ContentValues();
+        bookmarkContentValues.put(PARENT_FOLDER, newFolderName);
+
+        // SQL escape `oldFolderName`.
+        oldFolderName = DatabaseUtils.sqlEscapeString(oldFolderName);
+
+        // Run the update on all the bookmarks that currently list `oldFolderName` as their parent folder.  The last argument is `null` because there are no `whereArgs`.
+        bookmarksDatabase.update(BOOKMARKS_TABLE, bookmarkContentValues, PARENT_FOLDER + " = " + oldFolderName, null);
+
+        // Close the database handle.
+        bookmarksDatabase.close();
+    }
+
     // Update the display order for one bookmark or folder.
     public void updateDisplayOrder(int databaseId, int displayOrder) {
         // Get a writable database handle.