|
|
/*
|
|
|
* Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net)
|
|
|
*
|
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
* you may not use this file except in compliance with the License.
|
|
|
* You may obtain a copy of the License at
|
|
|
*
|
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
|
*
|
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
* See the License for the specific language governing permissions and
|
|
|
* limitations under the License.
|
|
|
*/
|
|
|
|
|
|
package net.micode.notes.data;
|
|
|
|
|
|
import android.content.ContentValues;
|
|
|
import android.content.Context;
|
|
|
import android.database.sqlite.SQLiteDatabase;
|
|
|
import android.database.sqlite.SQLiteOpenHelper;
|
|
|
import android.util.Log;
|
|
|
|
|
|
import net.micode.notes.data.Notes.DataColumns;
|
|
|
import net.micode.notes.data.Notes.DataConstants;
|
|
|
import net.micode.notes.data.Notes.NoteColumns;
|
|
|
//笔记数据库帮助类，负责创建和管理笔记应用的SQLite数据库
|
|
|
|
|
|
public class NotesDatabaseHelper extends SQLiteOpenHelper { // 数据库名称
|
|
|
private static final String DB_NAME = "note.db"; // 数据库版本号
|
|
|
|
|
|
private static final int DB_VERSION = 4; // 数据库表名接口
|
|
|
|
|
|
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; // 单例实例
|
|
|
// 创建笔记表的SQL语句
|
|
|
private static final String CREATE_NOTE_TABLE_SQL =
|
|
|
"CREATE TABLE " + TABLE.NOTE + "(" +
|
|
|
NoteColumns.ID + " INTEGER PRIMARY KEY," + // 笔记ID
|
|
|
NoteColumns.PARENT_ID + " INTEGER NOT NULL DEFAULT 0," +// 父笔记ID
|
|
|
NoteColumns.ALERTED_DATE + " INTEGER NOT NULL DEFAULT 0," +// 提醒日期
|
|
|
NoteColumns.BG_COLOR_ID + " INTEGER NOT NULL DEFAULT 0," + // 背景颜色ID
|
|
|
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," +// 小部件ID
|
|
|
NoteColumns.WIDGET_TYPE + " INTEGER NOT NULL DEFAULT -1," +// 小部件类型
|
|
|
NoteColumns.SYNC_ID + " INTEGER NOT NULL DEFAULT 0," +// 同步ID
|
|
|
NoteColumns.LOCAL_MODIFIED + " INTEGER NOT NULL DEFAULT 0," + // 本地修改标记
|
|
|
NoteColumns.ORIGIN_PARENT_ID + " INTEGER NOT NULL DEFAULT 0," +// 原始父ID
|
|
|
NoteColumns.GTASK_ID + " TEXT NOT NULL DEFAULT ''," + // Google任务ID
|
|
|
NoteColumns.VERSION + " INTEGER NOT NULL DEFAULT 0" +// 版本号
|
|
|
")";
|
|
|
|
|
|
|
|
|
private static final String CREATE_DATA_TABLE_SQL =// 创建数据表的SQL语句
|
|
|
"CREATE TABLE " + TABLE.DATA + "(" +
|
|
|
DataColumns.ID + " INTEGER PRIMARY KEY," +// 数据ID
|
|
|
DataColumns.MIME_TYPE + " TEXT NOT NULL," +// MIME类型
|
|
|
DataColumns.NOTE_ID + " INTEGER NOT NULL DEFAULT 0," +// 关联的笔记ID
|
|
|
NoteColumns.CREATED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," +// 创建日期
|
|
|
NoteColumns.MODIFIED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," +// 修改日期
|
|
|
DataColumns.CONTENT + " TEXT NOT NULL DEFAULT ''," +// 内容
|
|
|
DataColumns.DATA1 + " INTEGER," +// 额外数据字段1
|
|
|
DataColumns.DATA2 + " INTEGER," +// 额外数据字段2
|
|
|
DataColumns.DATA3 + " TEXT NOT NULL DEFAULT ''," +// 额外数据字段3
|
|
|
DataColumns.DATA4 + " TEXT NOT NULL DEFAULT ''," +// 额外数据字段4
|
|
|
DataColumns.DATA5 + " TEXT NOT NULL DEFAULT ''" +// 额外数据字段5
|
|
|
")";
|
|
|
|
|
|
private static final String CREATE_DATA_NOTE_ID_INDEX_SQL = // 创建数据表note_id索引的SQL语句
|
|
|
"CREATE INDEX IF NOT EXISTS note_id_index ON " +
|
|
|
TABLE.DATA + "(" + DataColumns.NOTE_ID + ");";//当更新笔记的父ID(移动笔记到文件夹)时增加文件夹的笔记计数
|
|
|
|
|
|
/**
|
|
|
* 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";//当更新笔记的父ID(从文件夹移出笔记)时减少文件夹的笔记计数
|
|
|
|
|
|
/**
|
|
|
* 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 " +
|
|
|
" AFTER UPDATE OF " + NoteColumns.PARENT_ID + " ON " + TABLE.NOTE +
|
|
|
" BEGIN " +
|
|
|
" UPDATE " + TABLE.NOTE +
|
|
|
" SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + "-1" +
|
|
|
" WHERE " + NoteColumns.ID + "=old." + NoteColumns.PARENT_ID +
|
|
|
" AND " + NoteColumns.NOTES_COUNT + ">0" + ";" +
|
|
|
" 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 " +
|
|
|
" AFTER INSERT 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 delete note from the folder
|
|
|
*/
|
|
|
private static final String NOTE_DECREASE_FOLDER_COUNT_ON_DELETE_TRIGGER =
|
|
|
"CREATE TRIGGER decrease_folder_count_on_delete " +
|
|
|
" AFTER DELETE ON " + TABLE.NOTE +
|
|
|
" BEGIN " +
|
|
|
" UPDATE " + TABLE.NOTE +
|
|
|
" SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + "-1" +
|
|
|
" WHERE " + NoteColumns.ID + "=old." + NoteColumns.PARENT_ID +
|
|
|
" AND " + NoteColumns.NOTES_COUNT + ">0;" +
|
|
|
" END";//当插入类型为NOTE的数据时更新笔记内容
|
|
|
|
|
|
/**
|
|
|
* 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 +
|
|
|
" WHEN new." + DataColumns.MIME_TYPE + "='" + DataConstants.NOTE + "'" +
|
|
|
" BEGIN" +
|
|
|
" UPDATE " + TABLE.NOTE +
|
|
|
" SET " + NoteColumns.SNIPPET + "=new." + DataColumns.CONTENT +
|
|
|
" WHERE " + NoteColumns.ID + "=new." + DataColumns.NOTE_ID + ";" +
|
|
|
" END";// 当更新类型为NOTE的数据时更新笔记内容
|
|
|
|
|
|
/**
|
|
|
* 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 +
|
|
|
" WHEN old." + DataColumns.MIME_TYPE + "='" + DataConstants.NOTE + "'" +
|
|
|
" BEGIN" +
|
|
|
" UPDATE " + TABLE.NOTE +
|
|
|
" SET " + NoteColumns.SNIPPET + "=new." + DataColumns.CONTENT +
|
|
|
" WHERE " + NoteColumns.ID + "=new." + DataColumns.NOTE_ID + ";" +
|
|
|
" END";
|
|
|
//当删除类型为NOTE的数据时清空笔记内容
|
|
|
/**
|
|
|
* 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 +
|
|
|
" WHEN old." + DataColumns.MIME_TYPE + "='" + DataConstants.NOTE + "'" +
|
|
|
" BEGIN" +
|
|
|
" UPDATE " + TABLE.NOTE +
|
|
|
" SET " + NoteColumns.SNIPPET + "=''" +
|
|
|
" WHERE " + NoteColumns.ID + "=old." + DataColumns.NOTE_ID + ";" +
|
|
|
" 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 " +
|
|
|
" AFTER DELETE ON " + TABLE.NOTE +
|
|
|
" BEGIN" +
|
|
|
" DELETE FROM " + TABLE.DATA +
|
|
|
" WHERE " + DataColumns.NOTE_ID + "=old." + NoteColumns.ID + ";" +
|
|
|
" 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 " +
|
|
|
" AFTER DELETE ON " + TABLE.NOTE +
|
|
|
" BEGIN" +
|
|
|
" DELETE FROM " + TABLE.NOTE +
|
|
|
" WHERE " + NoteColumns.PARENT_ID + "=old." + NoteColumns.ID + ";" +
|
|
|
" 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 " +
|
|
|
" AFTER UPDATE ON " + TABLE.NOTE +
|
|
|
" WHEN new." + NoteColumns.PARENT_ID + "=" + Notes.ID_TRASH_FOLER +
|
|
|
" BEGIN" +
|
|
|
" UPDATE " + TABLE.NOTE +
|
|
|
" SET " + NoteColumns.PARENT_ID + "=" + Notes.ID_TRASH_FOLER +
|
|
|
" WHERE " + NoteColumns.PARENT_ID + "=old." + NoteColumns.ID + ";" +
|
|
|
" END";
|
|
|
//构造函数
|
|
|
public NotesDatabaseHelper(Context context) {
|
|
|
super(context, DB_NAME, null, DB_VERSION);
|
|
|
}
|
|
|
//创建笔记表
|
|
|
public void createNoteTable(SQLiteDatabase db) {
|
|
|
db.execSQL(CREATE_NOTE_TABLE_SQL);
|
|
|
reCreateNoteTableTriggers(db);
|
|
|
createSystemFolder(db);
|
|
|
Log.d(TAG, "note table has been created");//重新创建笔记表相关的触发器
|
|
|
}
|
|
|
|
|
|
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");
|
|
|
db.execSQL("DROP TRIGGER IF EXISTS delete_data_on_delete");
|
|
|
db.execSQL("DROP TRIGGER IF EXISTS increase_folder_count_on_insert");
|
|
|
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);
|
|
|
db.execSQL(NOTE_DELETE_DATA_ON_DELETE_TRIGGER);
|
|
|
db.execSQL(NOTE_INCREASE_FOLDER_COUNT_ON_INSERT_TRIGGER);
|
|
|
db.execSQL(FOLDER_DELETE_NOTES_ON_DELETE_TRIGGER);
|
|
|
db.execSQL(FOLDER_MOVE_NOTES_ON_TRASH_TRIGGER);
|
|
|
}
|
|
|
// 创建系统文件夹
|
|
|
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);
|
|
|
}
|
|
|
//创建数据表
|
|
|
public void createDataTable(SQLiteDatabase db) {
|
|
|
db.execSQL(CREATE_DATA_TABLE_SQL);
|
|
|
reCreateDataTableTriggers(db);
|
|
|
db.execSQL(CREATE_DATA_NOTE_ID_INDEX_SQL);
|
|
|
Log.d(TAG, "data 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);
|
|
|
}//获取单例实例
|
|
|
|
|
|
static synchronized NotesDatabaseHelper getInstance(Context context) {
|
|
|
if (mInstance == null) {
|
|
|
mInstance = new NotesDatabaseHelper(context);
|
|
|
}
|
|
|
return mInstance;
|
|
|
}
|
|
|
//创建数据库时调用
|
|
|
@Override
|
|
|
public void onCreate(SQLiteDatabase db) {
|
|
|
createNoteTable(db);
|
|
|
createDataTable(db);
|
|
|
}
|
|
|
//升级数据库时调用
|
|
|
@Override
|
|
|
public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
|
|
|
boolean reCreateTriggers = false;
|
|
|
boolean skipV2 = false;//从版本1升级到版本2
|
|
|
|
|
|
if (oldVersion == 1) {
|
|
|
upgradeToV2(db);
|
|
|
skipV2 = true; // this upgrade including the upgrade from v2 to v3
|
|
|
oldVersion++;
|
|
|
}
|
|
|
|
|
|
if (oldVersion == 2 && !skipV2) {// 从版本2升级到版本3
|
|
|
upgradeToV3(db);
|
|
|
reCreateTriggers = true;
|
|
|
oldVersion++;
|
|
|
}
|
|
|
// 从版本3升级到版本4
|
|
|
if (oldVersion == 3) {
|
|
|
upgradeToV4(db);
|
|
|
oldVersion++;
|
|
|
}
|
|
|
// 如果需要，重新创建触发器
|
|
|
if (reCreateTriggers) {
|
|
|
reCreateNoteTableTriggers(db);
|
|
|
reCreateDataTableTriggers(db);
|
|
|
}
|
|
|
// 检查升级是否成功
|
|
|
if (oldVersion != newVersion) {
|
|
|
throw new IllegalStateException("Upgrade notes database to version " + newVersion
|
|
|
+ "fails");
|
|
|
}
|
|
|
}
|
|
|
//升级到版本2 - 删除并重新创建所有表
|
|
|
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 - 添加Google任务ID支持并添加回收站文件夹
|
|
|
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");
|
|
|
|
|
|
// 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);
|
|
|
}
|
|
|
// 添加Google任务ID列
|
|
|
private void upgradeToV4(SQLiteDatabase db) {
|
|
|
db.execSQL("ALTER TABLE " + TABLE.NOTE + " ADD COLUMN " + NoteColumns.VERSION
|
|
|
+ " INTEGER NOT NULL DEFAULT 0");
|
|
|
}// 添加回收站系统文件夹
|
|
|
}
|
