@ -26,31 +26,25 @@ import net.micode.notes.data.Notes.DataColumns;
import net.micode.notes.data.Notes.DataConstants ;
import net.micode.notes.data.Notes.NoteColumns ;
/ * *
* 笔 记 数 据 库 帮 助
* 负 责 数 据 库 的 创 建 、 升 级 和 维 护
* /
public class NotesDatabaseHelper extends SQLiteOpenHelper {
private static final String DB_NAME = "note.db" ; // 数据库名称
private static final int DB_VERSION = 4 ; // 数据库版本
;
/ * *
* 数 据 库 表 名 定 义 接 口
* /
private static final String DB_NAME = "note.db" ;
private static final int DB_VERSION = 6 ;
public interface TABLE {
/** 笔记表名 */
public static final String NOTE = "note" ;
/** 数据表名 */
public static final String DATA = "data" ;
}
private static final String TAG = "NotesDatabaseHelper" ; // 日志标签
private static NotesDatabaseHelper mInstance ; // 单例实例
public static final String TRASH = "trash_note" ;
public static final String ENCRYPTED_NOTE_PASSWORD = "encrypted_note_password" ;
}
/** 数据库帮助类的单例实例 */
private static final String TAG = "NotesDatabaseHelper" ;
private static NotesDatabaseHelper mInstance ;
private static final String CREATE_NOTE_TABLE_SQL =
"CREATE TABLE " + TABLE . NOTE + "(" +
@ -70,10 +64,10 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
NoteColumns . LOCAL_MODIFIED + " INTEGER NOT NULL DEFAULT 0," +
NoteColumns . ORIGIN_PARENT_ID + " INTEGER NOT NULL DEFAULT 0," +
NoteColumns . GTASK_ID + " TEXT NOT NULL DEFAULT ''," +
NoteColumns . VERSION + " INTEGER NOT NULL DEFAULT 0" +
NoteColumns . VERSION + " INTEGER NOT NULL DEFAULT 0," +
NoteColumns . IS_ENCRYPTED + " INTEGER NOT NULL DEFAULT 0" +
")" ;
// 创建笔记数据表的SQL语句
private static final String CREATE_DATA_TABLE_SQL =
"CREATE TABLE " + TABLE . DATA + "(" +
DataColumns . ID + " INTEGER PRIMARY KEY," +
@ -89,18 +83,54 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
DataColumns . DATA5 + " TEXT NOT NULL DEFAULT ''" +
")" ;
// 创建笔记数据表中note_id列的索引
private static final String CREATE_DATA_NOTE_ID_INDEX_SQL =
"CREATE INDEX IF NOT EXISTS note_id_index ON " +
TABLE . DATA + "(" + DataColumns . NOTE_ID + ");" ;
private static final String CREATE_TRASH_TABLE_SQL =
"CREATE TABLE " + TABLE . TRASH + "(" +
NoteColumns . ID + " INTEGER PRIMARY KEY," +
NoteColumns . PARENT_ID + " INTEGER NOT NULL DEFAULT 0," +
NoteColumns . ALERTED_DATE + " INTEGER NOT NULL DEFAULT 0," +
NoteColumns . BG_COLOR_ID + " INTEGER NOT NULL DEFAULT 0," +
NoteColumns . CREATED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," +
NoteColumns . HAS_ATTACHMENT + " INTEGER NOT NULL DEFAULT 0," +
NoteColumns . MODIFIED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," +
NoteColumns . NOTES_COUNT + " INTEGER NOT NULL DEFAULT 0," +
NoteColumns . SNIPPET + " TEXT NOT NULL DEFAULT ''," +
NoteColumns . TYPE + " INTEGER NOT NULL DEFAULT 0," +
NoteColumns . WIDGET_ID + " INTEGER NOT NULL DEFAULT 0," +
NoteColumns . WIDGET_TYPE + " INTEGER NOT NULL DEFAULT -1," +
NoteColumns . SYNC_ID + " INTEGER NOT NULL DEFAULT 0," +
NoteColumns . LOCAL_MODIFIED + " INTEGER NOT NULL DEFAULT 0," +
NoteColumns . ORIGIN_PARENT_ID + " INTEGER NOT NULL DEFAULT 0," +
NoteColumns . GTASK_ID + " TEXT NOT NULL DEFAULT ''," +
NoteColumns . VERSION + " INTEGER NOT NULL DEFAULT 0," +
NoteColumns . IS_ENCRYPTED + " INTEGER NOT NULL DEFAULT 0," +
"deleted_date INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)" +
")" ;
private static final String CREATE_ENCRYPTED_NOTE_PASSWORD_TABLE_SQL =
"CREATE TABLE " + TABLE . ENCRYPTED_NOTE_PASSWORD + "(" +
NoteColumns . ID + " INTEGER PRIMARY KEY," +
"password TEXT NOT NULL," +
"FOREIGN KEY(" + NoteColumns . ID + ") REFERENCES " + TABLE . NOTE + "(" + NoteColumns . ID + ") ON DELETE CASCADE" +
")" ;
/ * *
* 当 笔 记 移 动 到 文 件 夹 时 增 加 文 件 夹 的 笔 记 计 数
* Increase folder ' s note count when move note to the folder
* /
private static final String NOTE_INCREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER = "CREATE TRIGGER increase_folder_count_on_update " + " AFTER UPDATE OF " + NoteColumns . PARENT_ID + " ON " + TABLE . NOTE + " BEGIN " + " UPDATE " + TABLE . NOTE + " SET " + NoteColumns . NOTES_COUNT + "=" + NoteColumns . NOTES_COUNT + " + 1" + " WHERE " + NoteColumns . ID + "=new." + NoteColumns . PARENT_ID + ";" + " END" ;
private static final String NOTE_INCREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER =
"CREATE TRIGGER increase_folder_count_on_update " +
" AFTER UPDATE OF " + NoteColumns . PARENT_ID + " ON " + TABLE . NOTE +
" BEGIN " +
" UPDATE " + TABLE . NOTE +
" SET " + NoteColumns . NOTES_COUNT + "=" + NoteColumns . NOTES_COUNT + " + 1" +
" WHERE " + NoteColumns . ID + "=new." + NoteColumns . PARENT_ID + ";" +
" END" ;
/ * *
* 当 笔 记 从 文 件 夹 移 走 时 减 少 文 件 夹 的 笔 记 计 数
* Decrease folder ' s note count when move note from folder
* /
private static final String NOTE_DECREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER =
"CREATE TRIGGER decrease_folder_count_on_update " +
@ -113,7 +143,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
" END" ;
/ * *
* 当 向 文 件 夹 中 插 入 新 笔 记 时 增 加 文 件 夹 的 笔 记 计 数
* Increase folder ' s note count when insert new note to the folder
* /
private static final String NOTE_INCREASE_FOLDER_COUNT_ON_INSERT_TRIGGER =
"CREATE TRIGGER increase_folder_count_on_insert " +
@ -125,7 +155,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
" END" ;
/ * *
* 当 从 文 件 夹 中 删 除 笔 记 时 减 少 文 件 夹 的 笔 记 计 数
* Decrease folder ' s note count when delete note from the folder
* /
private static final String NOTE_DECREASE_FOLDER_COUNT_ON_DELETE_TRIGGER =
"CREATE TRIGGER decrease_folder_count_on_delete " +
@ -137,7 +167,9 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
" AND " + NoteColumns . NOTES_COUNT + ">0;" +
" END" ;
/**插入 TEXT_NOTE 类型的数据行时,用数据内容刷新 note.snippet */
/ * *
* Update note ' s content when insert data with type { @link DataConstants # NOTE }
* /
private static final String DATA_UPDATE_NOTE_CONTENT_ON_INSERT_TRIGGER =
"CREATE TRIGGER update_note_content_on_insert " +
" AFTER INSERT ON " + TABLE . DATA +
@ -148,7 +180,9 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
" WHERE " + NoteColumns . ID + "=new." + DataColumns . NOTE_ID + ";" +
" END" ;
/**更新 TEXT_NOTE 数据行时,同步更新 note.snippet */
/ * *
* Update note ' s content when data with { @link DataConstants # NOTE } type has changed
* /
private static final String DATA_UPDATE_NOTE_CONTENT_ON_UPDATE_TRIGGER =
"CREATE TRIGGER update_note_content_on_update " +
" AFTER UPDATE ON " + TABLE . DATA +
@ -159,7 +193,9 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
" WHERE " + NoteColumns . ID + "=new." + DataColumns . NOTE_ID + ";" +
" END" ;
/** 删除 TEXT_NOTE 数据行时,清空 note.snippet */
/ * *
* Update note ' s content when data with { @link DataConstants # NOTE } type has deleted
* /
private static final String DATA_UPDATE_NOTE_CONTENT_ON_DELETE_TRIGGER =
"CREATE TRIGGER update_note_content_on_delete " +
" AFTER delete ON " + TABLE . DATA +
@ -171,7 +207,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
" END" ;
/ * *
* 删 除 已 删 除 笔 记 的 数 据
* Delete datas belong to note which has been deleted
* /
private static final String NOTE_DELETE_DATA_ON_DELETE_TRIGGER =
"CREATE TRIGGER delete_data_on_delete " +
@ -182,7 +218,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
" END" ;
/ * *
* 删 除 已 删 除 文 件 夹 下 的 所 有 笔 记
* Delete notes belong to folder which has been deleted
* /
private static final String FOLDER_DELETE_NOTES_ON_DELETE_TRIGGER =
"CREATE TRIGGER folder_delete_notes_on_delete " +
@ -193,7 +229,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
" END" ;
/ * *
* 当 文 件 夹 被 移 到 回 收 站 时 , 将 其 所 有 笔 记 也 移 到 回 收 站
* Move notes belong to folder which has been moved to trash folder
* /
private static final String FOLDER_MOVE_NOTES_ON_TRASH_TRIGGER =
"CREATE TRIGGER folder_move_notes_on_trash " +
@ -205,31 +241,18 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
" WHERE " + NoteColumns . PARENT_ID + "=old." + NoteColumns . ID + ";" +
" END" ;
/ * *
* 构 造 方 法
* @param context 上 下 文 对 象
* /
public NotesDatabaseHelper ( Context context ) {
super ( context , DB_NAME , null , DB_VERSION ) ;
}
/ * *
* 创 建 笔 记 表
* @param db 数 据 库 对 象
* /
public void createNoteTable ( SQLiteDatabase db ) {
db . execSQL ( CREATE_NOTE_TABLE_SQL ) ; // 创建笔记表结构
reCreateNoteTableTriggers ( db ) ; // 重建笔记表触发器
createSystemFolder ( db ) ; // 创建系统文件夹
db . execSQL ( CREATE_NOTE_TABLE_SQL ) ;
reCreateNoteTableTriggers ( db ) ;
createSystemFolder ( db ) ;
Log . d ( TAG , "note table has been created" ) ;
}
/ * *
* 重 建 笔 记 表 的 触 发 器
* @param db 数 据 库 对 象
* /
private void reCreateNoteTableTriggers ( SQLiteDatabase db ) {
// 删除现有触发器
db . execSQL ( "DROP TRIGGER IF EXISTS increase_folder_count_on_update" ) ;
db . execSQL ( "DROP TRIGGER IF EXISTS decrease_folder_count_on_update" ) ;
db . execSQL ( "DROP TRIGGER IF EXISTS decrease_folder_count_on_delete" ) ;
@ -238,7 +261,6 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
db . execSQL ( "DROP TRIGGER IF EXISTS folder_delete_notes_on_delete" ) ;
db . execSQL ( "DROP TRIGGER IF EXISTS folder_move_notes_on_trash" ) ;
// 创建新触发器
db . execSQL ( NOTE_INCREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER ) ;
db . execSQL ( NOTE_DECREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER ) ;
db . execSQL ( NOTE_DECREASE_FOLDER_COUNT_ON_DELETE_TRIGGER ) ;
@ -248,171 +270,172 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
db . execSQL ( FOLDER_MOVE_NOTES_ON_TRASH_TRIGGER ) ;
}
/ * *
* 创 建 系 统 文 件 夹
* @param db 数 据 库 对 象
* /
private void createSystemFolder ( SQLiteDatabase db ) {
ContentValues values = new ContentValues ( ) ;
/ * *
* 通 话 记 录 文 件 夹 , 用 于 存 储 通 话 记 录 笔 记
* call record foler for call notes
* /
values . put ( NoteColumns . ID , Notes . ID_CALL_RECORD_FOLDER ) ;
values . put ( NoteColumns . TYPE , Notes . TYPE_SYSTEM ) ;
db . insert ( TABLE . NOTE , null , values ) ;
// 创建根文件夹(默认文件夹)
/ * *
* root folder which is default folder
* /
values . clear ( ) ;
values . put ( NoteColumns . ID , Notes . ID_ROOT_FOLDER ) ;
values . put ( NoteColumns . TYPE , Notes . TYPE_SYSTEM ) ;
db . insert ( TABLE . NOTE , null , values ) ;
// 创建临时文件夹(用于移动笔记)
/ * *
* temporary folder which is used for moving note
* /
values . clear ( ) ;
values . put ( NoteColumns . ID , Notes . ID_TEMPARAY_FOLDER ) ;
values . put ( NoteColumns . TYPE , Notes . TYPE_SYSTEM ) ;
db . insert ( TABLE . NOTE , null , values ) ;
// 创建回收站文件夹
/ * *
* create trash folder
* /
values . clear ( ) ;
values . put ( NoteColumns . ID , Notes . ID_TRASH_FOLER ) ;
values . put ( NoteColumns . TYPE , Notes . TYPE_SYSTEM ) ;
db . insert ( TABLE . NOTE , null , values ) ;
}
/ * *
* 创 建 笔 记 数 据 表
* @param db 数 据 库 对 象
* /
public void createDataTable ( SQLiteDatabase db ) {
db . execSQL ( CREATE_DATA_TABLE_SQL ) ; // 创建笔记数据表结构
reCreateDataTableTriggers ( db ) ; // 重建笔记数据表触发器
db . execSQL ( CREATE_DATA_NOTE_ID_INDEX_SQL ) ; // 创建note_id列索引
db . execSQL ( CREATE_DATA_TABLE_SQL ) ;
reCreateDataTableTriggers ( db ) ;
db . execSQL ( CREATE_DATA_NOTE_ID_INDEX_SQL ) ;
Log . d ( TAG , "data table has been created" ) ;
}
/ * *
* 重 建 笔 记 数 据 表 的 触 发 器
* @param db 数 据 库 对 象
* /
public void createTrashTable ( SQLiteDatabase db ) {
db . execSQL ( CREATE_TRASH_TABLE_SQL ) ;
Log . d ( TAG , "trash_note table has been created" ) ;
}
private void reCreateDataTableTriggers ( SQLiteDatabase db ) {
// 删除现有触发器
db . execSQL ( "DROP TRIGGER IF EXISTS update_note_content_on_insert" ) ;
db . execSQL ( "DROP TRIGGER IF EXISTS update_note_content_on_update" ) ;
db . execSQL ( "DROP TRIGGER IF EXISTS update_note_content_on_delete" ) ;
// 创建新触发器
db . execSQL ( DATA_UPDATE_NOTE_CONTENT_ON_INSERT_TRIGGER ) ;
db . execSQL ( DATA_UPDATE_NOTE_CONTENT_ON_UPDATE_TRIGGER ) ;
db . execSQL ( DATA_UPDATE_NOTE_CONTENT_ON_DELETE_TRIGGER ) ;
}
/ * *
* 获 取 NotesDatabaseHelper 的 单 例 实 例
* @param context 上 下 文 对 象
* @return NotesDatabaseHelper 的 单 例 实 例
* /
static synchronized NotesDatabaseHelper getInstance ( Context context ) {
public static synchronized NotesDatabaseHelper getInstance ( Context context ) {
if ( mInstance = = null ) {
mInstance = new NotesDatabaseHelper ( context ) ;
}
return mInstance ;
}
/** 创建数据库:依次创建 note 表与 data 表 */
@Override
public void onCreate ( SQLiteDatabase db ) {
createNoteTable ( db ) ; // 创建笔记表
createDataTable ( db ) ; // 创建笔记数据表
createNoteTable ( db ) ;
createDataTable ( db ) ;
createTrashTable ( db ) ;
createEncryptedNotePasswordTable ( db ) ;
}
/ * *
* 当 数 据 库 版 本 需 要 更 新 时 调 用
* @param db 数 据 库 对 象
* @param oldVersion 旧 版 本 号
* @param newVersion 新 版 本 号
* /
@Override
public void onUpgrade ( SQLiteDatabase db , int oldVersion , int newVersion ) {
boolean reCreateTriggers = false ; // 是否需要重建触发器
boolean skipV2 = false ; // 是否跳过版本2的升级
boolean reCreateTriggers = false ;
boolean skipV2 = false ;
// 从版本1升级
if ( oldVersion = = 1 ) {
upgradeToV2 ( db ) ;
skipV2 = true ; // this upgrade including the upgrade from v2 to v3
oldVersion + + ;
}
// 从版本2升级( 跳过已在版本1升级中处理的情况)
if ( oldVersion = = 2 & & ! skipV2 ) {
upgradeToV3 ( db ) ;
reCreateTriggers = true ;
oldVersion + + ;
}
// 从版本3升级
if ( oldVersion = = 3 ) {
upgradeToV4 ( db ) ;
oldVersion + + ;
}
// 如果需要,重建触发器
if ( oldVersion = = 4 ) {
upgradeToV5 ( db ) ;
oldVersion + + ;
}
if ( oldVersion = = 5 ) {
upgradeToV6 ( db ) ;
oldVersion + + ;
}
if ( reCreateTriggers ) {
reCreateNoteTableTriggers ( db ) ;
reCreateDataTableTriggers ( db ) ;
}
// 检查升级是否成功
if ( oldVersion ! = newVersion ) {
throw new IllegalStateException ( "Upgrade notes database to version " + newVersion ) ;
throw new IllegalStateException ( "Upgrade notes database to version " + newVersion
+ "fails" ) ;
}
}
/ * *
* 将 数 据 库 升 级 到 版 本 2
* @param db 数 据 库 对 象
* /
private void upgradeToV2 ( SQLiteDatabase db ) {
// 删除旧表
db . execSQL ( "DROP TABLE IF EXISTS " + TABLE . NOTE ) ;
db . execSQL ( "DROP TABLE IF EXISTS " + TABLE . DATA ) ;
// 创建新表
createNoteTable ( db ) ;
createDataTable ( db ) ;
}
/ * *
* 将 数 据 库 升 级 到 版 本 3
* @param db 数 据 库 对 象
* /
private void upgradeToV3 ( SQLiteDatabase db ) {
// 删除不再使用的触发器
// drop unused triggers
db . execSQL ( "DROP TRIGGER IF EXISTS update_note_modified_date_on_insert" ) ;
db . execSQL ( "DROP TRIGGER IF EXISTS update_note_modified_date_on_delete" ) ;
db . execSQL ( "DROP TRIGGER IF EXISTS update_note_modified_date_on_update" ) ;
// 添加gtask_id列用于同步
// add a column for gtask id
db . execSQL ( "ALTER TABLE " + TABLE . NOTE + " ADD COLUMN " + NoteColumns . GTASK_ID
+ " TEXT NOT NULL DEFAULT ''" ) ;
// 添加回收站系统文件夹
// add a trash system folder
ContentValues values = new ContentValues ( ) ;
values . put ( NoteColumns . ID , Notes . ID_TRASH_FOLER ) ;
values . put ( NoteColumns . TYPE , Notes . TYPE_SYSTEM ) ;
db . insert ( TABLE . NOTE , null , values ) ;
}
/ * *
* 将 数 据 库 升 级 到 版 本 4
* @param db 数 据 库 对 象
* /
private void upgradeToV4 ( SQLiteDatabase db ) {
db . execSQL ( "ALTER TABLE " + TABLE . NOTE + " ADD COLUMN " + NoteColumns . VERSION
+ " INTEGER NOT NULL DEFAULT 0" ) ;
}
private void upgradeToV5 ( SQLiteDatabase db ) {
createTrashTable ( db ) ;
Log . d ( TAG , "Upgraded to version 5: created trash_note table" ) ;
}
private void upgradeToV6 ( SQLiteDatabase db ) {
// 添加is_encrypted字段到note表
db . execSQL ( "ALTER TABLE " + TABLE . NOTE + " ADD COLUMN " + NoteColumns . IS_ENCRYPTED
+ " INTEGER NOT NULL DEFAULT 0" ) ;
// 添加is_encrypted字段到trash_note表( 如果表已存在)
try {
db . execSQL ( "ALTER TABLE " + TABLE . TRASH + " ADD COLUMN " + NoteColumns . IS_ENCRYPTED
+ " INTEGER NOT NULL DEFAULT 0" ) ;
} catch ( Exception e ) {
// 如果表不存在或字段已存在,忽略错误
Log . d ( TAG , "trash_note table may not exist or column already exists: " + e . getMessage ( ) ) ;
}
// 创建加密便签密码表
createEncryptedNotePasswordTable ( db ) ;
Log . d ( TAG , "Upgraded to version 6: added is_encrypted column and encrypted_note_password table" ) ;
}
public void createEncryptedNotePasswordTable ( SQLiteDatabase db ) {
db . execSQL ( CREATE_ENCRYPTED_NOTE_PASSWORD_TABLE_SQL ) ;
Log . d ( TAG , "encrypted_note_password table has been created" ) ;
}
}