/*
- * Copyright © 2017 Soren Stoutner <soren@stoutner.com>.
+ * Copyright © 2017-2018 Soren Stoutner <soren@stoutner.com>.
*
* This file is part of Privacy Browser <https://www.stoutner.com/privacy-browser>.
*
import android.content.ContentValues;
import android.content.Context;
+import android.content.SharedPreferences;
import android.database.Cursor;
import android.database.sqlite.SQLiteDatabase;
import android.database.sqlite.SQLiteOpenHelper;
+import android.preference.PreferenceManager;
public class DomainsDatabaseHelper extends SQLiteOpenHelper {
- private static final int SCHEMA_VERSION = 2;
+ private static final int SCHEMA_VERSION = 5;
private static final String DOMAINS_DATABASE = "domains.db";
private static final String DOMAINS_TABLE = "domains";
public static final String ENABLE_THIRD_PARTY_COOKIES = "enablethirdpartycookies";
public static final String ENABLE_DOM_STORAGE = "enabledomstorage";
public static final String ENABLE_FORM_DATA = "enableformdata";
+ public static final String ENABLE_EASYLIST = "enableeasylist";
+ public static final String ENABLE_EASYPRIVACY = "enableeasyprivacy";
+ public static final String ENABLE_FANBOYS_ANNOYANCE_LIST = "enablefanboysannoyancelist";
+ public static final String ENABLE_FANBOYS_SOCIAL_BLOCKING_LIST = "enablefanboyssocialblockinglist";
public static final String USER_AGENT = "useragent";
public static final String FONT_SIZE = "fontsize";
public static final String DISPLAY_IMAGES = "displayimages";
-
+ public static final String NIGHT_MODE = "nightmode";
+ public static final String PINNED_SSL_CERTIFICATE = "pinnedsslcertificate";
+ public static final String SSL_ISSUED_TO_COMMON_NAME = "sslissuedtocommonname";
+ public static final String SSL_ISSUED_TO_ORGANIZATION = "sslissuedtoorganization";
+ public static final String SSL_ISSUED_TO_ORGANIZATIONAL_UNIT = "sslissuedtoorganizationalunit";
+ public static final String SSL_ISSUED_BY_COMMON_NAME = "sslissuedbycommonname";
+ public static final String SSL_ISSUED_BY_ORGANIZATION = "sslissuedbyorganization";
+ public static final String SSL_ISSUED_BY_ORGANIZATIONAL_UNIT = "sslissuedbyorganizationalunit";
+ public static final String SSL_START_DATE = "sslstartdate";
+ public static final String SSL_END_DATE = "sslenddate";
+
+ // Display webpage images constants.
public static final int DISPLAY_WEBPAGE_IMAGES_SYSTEM_DEFAULT = 0;
public static final int DISPLAY_WEBPAGE_IMAGES_ENABLED = 1;
public static final int DISPLAY_WEBPAGE_IMAGES_DISABLED = 2;
+ // Night mode constants.
+ public static final int NIGHT_MODE_SYSTEM_DEFAULT = 0;
+ public static final int NIGHT_MODE_ENABLED = 1;
+ public static final int NIGHT_MODE_DISABLED = 2;
+
+ private Context appContext;
+
// Initialize the database. The lint warnings for the unused parameters are suppressed.
public DomainsDatabaseHelper(Context context, @SuppressWarnings("UnusedParameters") String name, SQLiteDatabase.CursorFactory cursorFactory, @SuppressWarnings("UnusedParameters") int version) {
super(context, DOMAINS_DATABASE, cursorFactory, SCHEMA_VERSION);
+
+ // Store a handle for the context.
+ appContext = context;
}
@Override
public void onCreate(SQLiteDatabase domainsDatabase) {
// Setup the SQL string to create the `domains` table.
- final String CREATE_DOMAINS_TABLE = "CREATE TABLE " + DOMAINS_TABLE + " (" +
+ String CREATE_DOMAINS_TABLE = "CREATE TABLE " + DOMAINS_TABLE + " (" +
_ID + " INTEGER PRIMARY KEY, " +
DOMAIN_NAME + " TEXT, " +
ENABLE_JAVASCRIPT + " BOOLEAN, " +
ENABLE_THIRD_PARTY_COOKIES + " BOOLEAN, " +
ENABLE_DOM_STORAGE + " BOOLEAN, " +
ENABLE_FORM_DATA + " BOOLEAN, " +
+ ENABLE_EASYLIST + " BOOLEAN, " +
+ ENABLE_EASYPRIVACY + " BOOLEAN, " +
+ ENABLE_FANBOYS_ANNOYANCE_LIST + " BOOLEAN, " +
+ ENABLE_FANBOYS_SOCIAL_BLOCKING_LIST + " BOOLEAN, " +
USER_AGENT + " TEXT, " +
FONT_SIZE + " INTEGER, " +
- DISPLAY_IMAGES + " INTEGER);";
-
- // Create the `domains` table if it doesn't exist.
+ DISPLAY_IMAGES + " INTEGER, " +
+ NIGHT_MODE + " INTEGER, " +
+ PINNED_SSL_CERTIFICATE + " BOOLEAN, " +
+ SSL_ISSUED_TO_COMMON_NAME + " TEXT, " +
+ SSL_ISSUED_TO_ORGANIZATION + " TEXT, " +
+ SSL_ISSUED_TO_ORGANIZATIONAL_UNIT + " TEXT, " +
+ SSL_ISSUED_BY_COMMON_NAME + " TEXT, " +
+ SSL_ISSUED_BY_ORGANIZATION + " TEXT, " +
+ SSL_ISSUED_BY_ORGANIZATIONAL_UNIT + " TEXT, " +
+ SSL_START_DATE + " INTEGER, " +
+ SSL_END_DATE + " INTEGER);";
+
+ // Make it so.
domainsDatabase.execSQL(CREATE_DOMAINS_TABLE);
}
@Override
public void onUpgrade(SQLiteDatabase domainsDatabase, int oldVersion, int newVersion) {
- // Upgrade `DOMAINS_TABLE`.
+ // Upgrade the database table.
switch (oldVersion) {
- // Upgrade from `SCHEMA_VERSION` 1.
+ // Upgrade from schema version 1.
case 1:
- // Add the `DISPLAY_IMAGES` column.
+ // Add the display images column.
domainsDatabase.execSQL("ALTER TABLE " + DOMAINS_TABLE + " ADD COLUMN " + DISPLAY_IMAGES + " INTEGER");
+
+ // Upgrade from schema version 2.
+ case 2:
+ // Add the SSL certificate columns.
+ domainsDatabase.execSQL("ALTER TABLE " + DOMAINS_TABLE + " ADD COLUMN " + PINNED_SSL_CERTIFICATE + " BOOLEAN");
+ domainsDatabase.execSQL("ALTER TABLE " + DOMAINS_TABLE + " ADD COLUMN " + SSL_ISSUED_TO_COMMON_NAME + " TEXT");
+ domainsDatabase.execSQL("ALTER TABLE " + DOMAINS_TABLE + " ADD COLUMN " + SSL_ISSUED_TO_ORGANIZATION + " TEXT");
+ domainsDatabase.execSQL("ALTER TABLE " + DOMAINS_TABLE + " ADD COLUMN " + SSL_ISSUED_TO_ORGANIZATIONAL_UNIT + " TEXT");
+ domainsDatabase.execSQL("ALTER TABLE " + DOMAINS_TABLE + " ADD COLUMN " + SSL_ISSUED_BY_COMMON_NAME + " TEXT");
+ domainsDatabase.execSQL("ALTER TABLE " + DOMAINS_TABLE + " ADD COLUMN " + SSL_ISSUED_BY_ORGANIZATION + " TEXT");
+ domainsDatabase.execSQL("ALTER TABLE " + DOMAINS_TABLE + " ADD COLUMN " + SSL_ISSUED_BY_ORGANIZATIONAL_UNIT + " TEXT");
+ domainsDatabase.execSQL("ALTER TABLE " + DOMAINS_TABLE + " ADD COLUMN " + SSL_START_DATE + " INTEGER");
+ domainsDatabase.execSQL("ALTER TABLE " + DOMAINS_TABLE + " ADD COLUMN " + SSL_END_DATE + " INTEGER");
+
+ // Upgrade from schema version 3.
+ case 3:
+ // Add the `NIGHT_MODE` column.
+ domainsDatabase.execSQL("ALTER TABLE " + DOMAINS_TABLE + " ADD COLUMN " + NIGHT_MODE + " INTEGER");
+
+ // Upgrade from schema version 4.
+ case 4:
+ // Add the block lists columns.
+ domainsDatabase.execSQL("ALTER TABLE " + DOMAINS_TABLE + " ADD COLUMN " + ENABLE_EASYLIST + " BOOLEAN");
+ domainsDatabase.execSQL("ALTER TABLE " + DOMAINS_TABLE + " ADD COLUMN " + ENABLE_EASYPRIVACY + " BOOLEAN");
+ domainsDatabase.execSQL("ALTER TABLE " + DOMAINS_TABLE + " ADD COLUMN " + ENABLE_FANBOYS_ANNOYANCE_LIST + " BOOLEAN");
+ domainsDatabase.execSQL("ALTER TABLE " + DOMAINS_TABLE + " ADD COLUMN " + ENABLE_FANBOYS_SOCIAL_BLOCKING_LIST + " BOOLEAN");
+
+ // Get a handle for the shared preference.
+ SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(appContext);
+
+ // Get the default block list settings.
+ boolean easyListEnabled = sharedPreferences.getBoolean("easylist", true);
+ boolean easyPrivacyEnabled = sharedPreferences.getBoolean("easyprivacy", true);
+ boolean fanboyAnnoyanceListEnabled = sharedPreferences.getBoolean("fanboy_annoyance_list", true);
+ boolean fanboySocialBlockingListEnabled = sharedPreferences.getBoolean("fanboy_social_blocking_list", true);
+
+ // Set EasyList for existing rows according to the current system-wide default.
+ if (easyListEnabled) {
+ domainsDatabase.execSQL("UPDATE " + DOMAINS_TABLE + " SET " + ENABLE_EASYLIST + " = " + 1);
+ } else {
+ domainsDatabase.execSQL("UPDATE " + DOMAINS_TABLE + " SET " + ENABLE_EASYLIST + " = " + 0);
+ }
+
+ // Set EasyPrivacy for existing rows according to the current system-wide default.
+ if (easyPrivacyEnabled) {
+ domainsDatabase.execSQL("UPDATE " + DOMAINS_TABLE + " SET " + ENABLE_EASYPRIVACY + " = " + 1);
+ } else {
+ domainsDatabase.execSQL("UPDATE " + DOMAINS_TABLE + " SET " + ENABLE_EASYPRIVACY + " = " + 0);
+ }
+
+ // Set Fanboy's Annoyance List for existing rows according to the current system-wide default.
+ if (fanboyAnnoyanceListEnabled) {
+ domainsDatabase.execSQL("UPDATE " + DOMAINS_TABLE + " SET " + ENABLE_FANBOYS_ANNOYANCE_LIST + " = " + 1);
+ } else {
+ domainsDatabase.execSQL("UPDATE " + DOMAINS_TABLE + " SET " + ENABLE_FANBOYS_ANNOYANCE_LIST + " = " + 0);
+ }
+
+ // Set Fanboy's Social Blocking List for existing rows according to the current system-wide default.
+ if (fanboySocialBlockingListEnabled) {
+ domainsDatabase.execSQL("UPDATE " + DOMAINS_TABLE + " SET " + ENABLE_FANBOYS_SOCIAL_BLOCKING_LIST + " = " + 1);
+ } else {
+ domainsDatabase.execSQL("UPDATE " + DOMAINS_TABLE + " SET " + ENABLE_FANBOYS_SOCIAL_BLOCKING_LIST + " = " + 0);
+ }
}
}
return domainsDatabase.rawQuery(GET_CURSOR_FOR_DOMAIN_NAME, null);
}
- public void addDomain(String domainName) {
+ public int addDomain(String domainName) {
// Store the domain data in a `ContentValues`.
ContentValues domainContentValues = new ContentValues();
- // Create entries for each field in the database. The ID is created automatically.
+ // Get a handle for the shared preference.
+ SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(appContext);
+
+ // Get the default settings.
+ boolean javaScriptEnabled = sharedPreferences.getBoolean("javascript_enabled", false);
+ boolean firstPartyCookiesEnabled = sharedPreferences.getBoolean("first_party_cookies_enabled", false);
+ boolean thirdPartyCookiesEnabled = sharedPreferences.getBoolean("third_party_cookies_enabled", false);
+ boolean domStorageEnabled = sharedPreferences.getBoolean("dom_storage_enabled", false);
+ boolean saveFormDataEnabled = sharedPreferences.getBoolean("save_form_data_enabled", false);
+ boolean easyListEnabled = sharedPreferences.getBoolean("easylist", true);
+ boolean easyPrivacyEnabled = sharedPreferences.getBoolean("easyprivacy", true);
+ boolean fanboyAnnoyanceListEnabled = sharedPreferences.getBoolean("fanboy_annoyance_list", true);
+ boolean fanboySocialBlockingListEnabled = sharedPreferences.getBoolean("fanboy_social_blocking_list", true);
+
+ // Create entries for the database fields. The ID is created automatically. The pinned SSL certificate information is not created unless added by the user.
domainContentValues.put(DOMAIN_NAME, domainName);
- domainContentValues.put(ENABLE_JAVASCRIPT, false);
- domainContentValues.put(ENABLE_FIRST_PARTY_COOKIES, false);
- domainContentValues.put(ENABLE_THIRD_PARTY_COOKIES, false);
- domainContentValues.put(ENABLE_DOM_STORAGE, false);
- domainContentValues.put(ENABLE_FORM_DATA, false);
+ domainContentValues.put(ENABLE_JAVASCRIPT, javaScriptEnabled);
+ domainContentValues.put(ENABLE_FIRST_PARTY_COOKIES, firstPartyCookiesEnabled);
+ domainContentValues.put(ENABLE_THIRD_PARTY_COOKIES, thirdPartyCookiesEnabled);
+ domainContentValues.put(ENABLE_DOM_STORAGE, domStorageEnabled);
+ domainContentValues.put(ENABLE_FORM_DATA, saveFormDataEnabled);
+ domainContentValues.put(ENABLE_EASYLIST, easyListEnabled);
+ domainContentValues.put(ENABLE_EASYPRIVACY, easyPrivacyEnabled);
+ domainContentValues.put(ENABLE_FANBOYS_ANNOYANCE_LIST, fanboyAnnoyanceListEnabled);
+ domainContentValues.put(ENABLE_FANBOYS_SOCIAL_BLOCKING_LIST, fanboySocialBlockingListEnabled);
domainContentValues.put(USER_AGENT, "System default user agent");
domainContentValues.put(FONT_SIZE, 0);
domainContentValues.put(DISPLAY_IMAGES, 0);
+ domainContentValues.put(NIGHT_MODE, 0);
// Get a writable database handle.
SQLiteDatabase domainsDatabase = this.getWritableDatabase();
- // Insert a new row. The second argument is `null`, which makes it so that a completely null row cannot be created.
- domainsDatabase.insert(DOMAINS_TABLE, null, domainContentValues);
+ // Insert a new row and store the resulting database ID. The second argument is `null`, which makes it so that a completely null row cannot be created.
+ int newDomainDatabaseId = (int) domainsDatabase.insert(DOMAINS_TABLE, null, domainContentValues);
// Close the database handle.
domainsDatabase.close();
+
+ // Return the new domain database ID.
+ return newDomainDatabaseId;
}
- public void saveDomain(int databaseId, String domainName, boolean javaScriptEnabled, boolean firstPartyCookiesEnabled, boolean thirdPartyCookiesEnabled, boolean domStorageEnabled, boolean formDataEnabled, String userAgent, int fontSize,
- int displayImages) {
+ public void updateDomainExceptCertificate(int databaseId, String domainName, boolean javaScriptEnabled, boolean firstPartyCookiesEnabled, boolean thirdPartyCookiesEnabled, boolean domStorageEnabled,
+ boolean formDataEnabled, boolean easyListEnabled, boolean easyPrivacyEnabled, boolean fanboysAnnoyanceEnabled, boolean fanboysSocialBlockingEnabled,
+ String userAgent, int fontSize, int displayImages, int nightMode, boolean pinnedSslCertificate) {
+
// Store the domain data in a `ContentValues`.
ContentValues domainContentValues = new ContentValues();
domainContentValues.put(ENABLE_THIRD_PARTY_COOKIES, thirdPartyCookiesEnabled);
domainContentValues.put(ENABLE_DOM_STORAGE, domStorageEnabled);
domainContentValues.put(ENABLE_FORM_DATA, formDataEnabled);
+ domainContentValues.put(ENABLE_EASYLIST, easyListEnabled);
+ domainContentValues.put(ENABLE_EASYPRIVACY, easyPrivacyEnabled);
+ domainContentValues.put(ENABLE_FANBOYS_ANNOYANCE_LIST, fanboysAnnoyanceEnabled);
+ domainContentValues.put(ENABLE_FANBOYS_SOCIAL_BLOCKING_LIST, fanboysSocialBlockingEnabled);
domainContentValues.put(USER_AGENT, userAgent);
domainContentValues.put(FONT_SIZE, fontSize);
domainContentValues.put(DISPLAY_IMAGES, displayImages);
+ domainContentValues.put(NIGHT_MODE, nightMode);
+ domainContentValues.put(PINNED_SSL_CERTIFICATE, pinnedSslCertificate);
+
+ // Get a writable database handle.
+ SQLiteDatabase domainsDatabase = this.getWritableDatabase();
+
+ // Update the row for `databaseId`. The last argument is `null` because there are no `whereArgs`.
+ domainsDatabase.update(DOMAINS_TABLE, domainContentValues, _ID + " = " + databaseId, null);
+
+ // Close the database handle.
+ domainsDatabase.close();
+ }
+
+ public void updateDomainWithCertificate(int databaseId, String domainName, boolean javaScriptEnabled, boolean firstPartyCookiesEnabled, boolean thirdPartyCookiesEnabled, boolean domStorageEnabled,
+ boolean formDataEnabled, boolean easyListEnabled, boolean easyPrivacyEnabled, boolean fanboysAnnoyanceEnabled, boolean fanboysSocialBlockingEnabled, String userAgent,
+ int fontSize, int displayImages, int nightMode, boolean pinnedSslCertificate, String sslIssuedToCommonName, String sslIssuedToOrganization,
+ String sslIssuedToOrganizationalUnit, String sslIssuedByCommonName, String sslIssuedByOrganization, String sslIssuedByOrganizationalUnit, long sslStartDate,
+ long sslEndDate) {
+
+ // Store the domain data in a `ContentValues`.
+ ContentValues domainContentValues = new ContentValues();
+
+ // Add entries for each field in the database.
+ domainContentValues.put(DOMAIN_NAME, domainName);
+ domainContentValues.put(ENABLE_JAVASCRIPT, javaScriptEnabled);
+ domainContentValues.put(ENABLE_FIRST_PARTY_COOKIES, firstPartyCookiesEnabled);
+ domainContentValues.put(ENABLE_THIRD_PARTY_COOKIES, thirdPartyCookiesEnabled);
+ domainContentValues.put(ENABLE_DOM_STORAGE, domStorageEnabled);
+ domainContentValues.put(ENABLE_FORM_DATA, formDataEnabled);
+ domainContentValues.put(ENABLE_EASYLIST, easyListEnabled);
+ domainContentValues.put(ENABLE_EASYPRIVACY, easyPrivacyEnabled);
+ domainContentValues.put(ENABLE_FANBOYS_ANNOYANCE_LIST, fanboysAnnoyanceEnabled);
+ domainContentValues.put(ENABLE_FANBOYS_SOCIAL_BLOCKING_LIST, fanboysSocialBlockingEnabled);
+ domainContentValues.put(USER_AGENT, userAgent);
+ domainContentValues.put(FONT_SIZE, fontSize);
+ domainContentValues.put(DISPLAY_IMAGES, displayImages);
+ domainContentValues.put(NIGHT_MODE, nightMode);
+ domainContentValues.put(PINNED_SSL_CERTIFICATE, pinnedSslCertificate);
+ domainContentValues.put(SSL_ISSUED_TO_COMMON_NAME, sslIssuedToCommonName);
+ domainContentValues.put(SSL_ISSUED_TO_ORGANIZATION, sslIssuedToOrganization);
+ domainContentValues.put(SSL_ISSUED_TO_ORGANIZATIONAL_UNIT, sslIssuedToOrganizationalUnit);
+ domainContentValues.put(SSL_ISSUED_BY_COMMON_NAME, sslIssuedByCommonName);
+ domainContentValues.put(SSL_ISSUED_BY_ORGANIZATION, sslIssuedByOrganization);
+ domainContentValues.put(SSL_ISSUED_BY_ORGANIZATIONAL_UNIT, sslIssuedByOrganizationalUnit);
+ domainContentValues.put(SSL_START_DATE, sslStartDate);
+ domainContentValues.put(SSL_END_DATE, sslEndDate);
+
+ // Get a writable database handle.
+ SQLiteDatabase domainsDatabase = this.getWritableDatabase();
+
+ // Update the row for `databaseId`. The last argument is `null` because there are no `whereArgs`.
+ domainsDatabase.update(DOMAINS_TABLE, domainContentValues, _ID + " = " + databaseId, null);
+
+ // Close the database handle.
+ domainsDatabase.close();
+ }
+
+ public void updateCertificate(int databaseId, String sslIssuedToCommonName, String sslIssuedToOrganization, String sslIssuedToOrganizationalUnit, String sslIssuedByCommonName,
+ String sslIssuedByOrganization, String sslIssuedByOrganizationalUnit, long sslStartDate, long sslEndDate) {
+ // Store the domain data in a `ContentValues`.
+ ContentValues domainContentValues = new ContentValues();
+
+ // Add entries for each field in the certificate.
+ domainContentValues.put(SSL_ISSUED_TO_COMMON_NAME, sslIssuedToCommonName);
+ domainContentValues.put(SSL_ISSUED_TO_ORGANIZATION, sslIssuedToOrganization);
+ domainContentValues.put(SSL_ISSUED_TO_ORGANIZATIONAL_UNIT, sslIssuedToOrganizationalUnit);
+ domainContentValues.put(SSL_ISSUED_BY_COMMON_NAME, sslIssuedByCommonName);
+ domainContentValues.put(SSL_ISSUED_BY_ORGANIZATION, sslIssuedByOrganization);
+ domainContentValues.put(SSL_ISSUED_BY_ORGANIZATIONAL_UNIT, sslIssuedByOrganizationalUnit);
+ domainContentValues.put(SSL_START_DATE, sslStartDate);
+ domainContentValues.put(SSL_END_DATE, sslEndDate);
// Get a writable database handle.
SQLiteDatabase domainsDatabase = this.getWritableDatabase();