Type: INTEGER (long)
+ */ + public static final String ID = "_id"; + + /** + * The parent's id for note or folder + *Type: INTEGER (long)
+ */ + public static final String PARENT_ID = "parent_id"; + + /** + * Created data for note or folder + *Type: INTEGER (long)
+ */ + public static final String CREATED_DATE = "created_date"; + + /** + * Latest modified date + *Type: INTEGER (long)
+ */ + public static final String MODIFIED_DATE = "modified_date"; + + + /** + * Alert date + *Type: INTEGER (long)
+ */ + public static final String ALERTED_DATE = "alert_date"; + + /** + * Folder's name or text content of note + *Type: TEXT
+ */ + public static final String SNIPPET = "snippet"; + + /** + * Note's widget id + *Type: INTEGER (long)
+ */ + public static final String WIDGET_ID = "widget_id"; + + /** + * Note's widget type + *Type: INTEGER (long)
+ */ + public static final String WIDGET_TYPE = "widget_type"; + + /** + * Note's background color's id + *Type: INTEGER (long)
+ */ + public static final String BG_COLOR_ID = "bg_color_id"; + + /** + * For text note, it doesn't has attachment, for multi-media + * note, it has at least one attachment + *Type: INTEGER
+ */ + public static final String HAS_ATTACHMENT = "has_attachment"; + + /** + * Folder's count of notes + *Type: INTEGER (long)
+ */ + public static final String NOTES_COUNT = "notes_count"; + + /** + * The file type: folder or note + *Type: INTEGER
+ */ + public static final String TYPE = "type"; + + /** + * The last sync id + *Type: INTEGER (long)
+ */ + public static final String SYNC_ID = "sync_id"; + + /** + * Sign to indicate local modified or not + *Type: INTEGER
+ */ + public static final String LOCAL_MODIFIED = "local_modified"; + + /** + * Original parent id before moving into temporary folder + *Type : INTEGER
+ */ + public static final String ORIGIN_PARENT_ID = "origin_parent_id"; + + /** + * The gtask id + *Type : TEXT
+ */ + public static final String GTASK_ID = "gtask_id"; + + /** + * The version code + *Type : INTEGER (long)
+ */ + public static final String VERSION = "version"; + } + + /** + * 数据表列名接口 + * 定义了data表中所有列的名称和类型 + */ + public interface DataColumns { + /** + * The unique ID for a row + *Type: INTEGER (long)
+ */ + public static final String ID = "_id"; + + /** + * The MIME type of the item represented by this row. + *Type: Text
+ */ + public static final String MIME_TYPE = "mime_type"; + + /** + * The reference id to note that this data belongs to + *Type: INTEGER (long)
+ */ + public static final String NOTE_ID = "note_id"; + + /** + * Created data for note or folder + *Type: INTEGER (long)
+ */ + public static final String CREATED_DATE = "created_date"; + + /** + * Latest modified date + *Type: INTEGER (long)
+ */ + public static final String MODIFIED_DATE = "modified_date"; + + /** + * Data's content + *Type: TEXT
+ */ + public static final String CONTENT = "content"; + + + /** + * Generic data column, the meaning is {@link #MIMETYPE} specific, used for + * integer data type + *Type: INTEGER
+ */ + public static final String DATA1 = "data1"; + + /** + * Generic data column, the meaning is {@link #MIMETYPE} specific, used for + * integer data type + *Type: INTEGER
+ */ + public static final String DATA2 = "data2"; + + /** + * Generic data column, the meaning is {@link #MIMETYPE} specific, used for + * TEXT data type + *Type: TEXT
+ */ + public static final String DATA3 = "data3"; + + /** + * Generic data column, the meaning is {@link #MIMETYPE} specific, used for + * TEXT data type + *Type: TEXT
+ */ + public static final String DATA4 = "data4"; + + /** + * Generic data column, the meaning is {@link #MIMETYPE} specific, used for + * TEXT data type + *Type: TEXT
+ */ + public static final String DATA5 = "data5"; + } + + /** + * 文本便签类 + * 定义了文本便签特有的数据结构和常量 + */ + public static final class TextNote implements DataColumns { + /** + * Mode to indicate the text in check list mode or not + *Type: Integer 1:check list mode 0: normal mode
+ */ + public static final String MODE = DATA1; + + /** 便签模式:清单模式(可勾选的项目列表) */ + public static final int MODE_CHECK_LIST = 1; + + /** 文本便签内容类型:多条记录 */ + public static final String CONTENT_TYPE = "vnd.android.cursor.dir/text_note"; + + /** 文本便签内容类型:单条记录 */ + public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/text_note"; + + /** 文本便签内容URI */ + public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/text_note"); + } + + /** + * 通话记录便签类 + * 定义了通话记录便签特有的数据结构和常量 + */ + public static final class CallNote implements DataColumns { + /** + * Call date for this record + *Type: INTEGER (long)
+ */ + public static final String CALL_DATE = DATA1; + + /** + * Phone number for this record + *Type: TEXT
+ */ + public static final String PHONE_NUMBER = DATA3; + + /** 通话记录便签内容类型:多条记录 */ + public static final String CONTENT_TYPE = "vnd.android.cursor.dir/call_note"; + + /** 通话记录便签内容类型:单条记录 */ + public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/call_note"; + + /** 通话记录便签内容URI */ + public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/call_note"); + } +} diff --git a/app/src/main/java/net/micode/notes/data/NotesDatabaseHelper.java b/app/src/main/java/net/micode/notes/data/NotesDatabaseHelper.java new file mode 100644 index 0000000..57152d0 --- /dev/null +++ b/app/src/main/java/net/micode/notes/data/NotesDatabaseHelper.java @@ -0,0 +1,498 @@ +/* + * 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. + */ + +/** + * 文件: NotesDatabaseHelper.java + * 描述: 便签应用的数据库帮助类,负责创建和管理SQLite数据库 + * 作用: 提供数据库的创建、升级和表结构管理,是应用数据持久化的核心组件 + */ +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; + +/** + * 便签数据库帮助类 + * + * 继承自SQLiteOpenHelper,负责便签应用数据库的创建、升级和管理 + * 提供了便签表和数据表的创建与管理,以及各种数据库触发器的定义 + * 使用单例模式确保全局只有一个数据库连接实例 + */ +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," + + 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" + + ")"; + + /** + * 创建数据表的SQL语句 + * 定义了数据表的结构,用于存储便签的具体内容 + */ + private static final String CREATE_DATA_TABLE_SQL = + "CREATE TABLE " + TABLE.DATA + "(" + + DataColumns.ID + " INTEGER PRIMARY KEY," + + DataColumns.MIME_TYPE + " TEXT NOT NULL," + + DataColumns.NOTE_ID + " INTEGER NOT NULL DEFAULT 0," + + 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," + + DataColumns.DATA2 + " INTEGER," + + DataColumns.DATA3 + " TEXT NOT NULL DEFAULT ''," + + DataColumns.DATA4 + " TEXT NOT NULL DEFAULT ''," + + DataColumns.DATA5 + " TEXT NOT NULL DEFAULT ''" + + ")"; + + /** + * 创建数据表NOTE_ID索引的SQL语句 + * 用于优化按便签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 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_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"; + + /** + * 增加文件夹便签计数的触发器 + * 当在某个文件夹中插入新便签时,自动增加该文件夹的便签计数 + */ + 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"; + + /** + * 减少文件夹便签计数的触发器 + * 当从某个文件夹中删除便签时,自动减少该文件夹的便签计数 + */ + 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的数据时,自动更新对应便签的摘要内容 + */ + 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的数据时,自动更新对应便签的摘要内容 + */ + 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的数据时,自动清空对应便签的摘要内容 + */ + 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"; + + /** + * 删除便签相关数据的触发器 + * 当删除便签时,自动删除与该便签关联的所有数据 + */ + 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"; + + /** + * 删除文件夹内便签的触发器 + * 当删除文件夹时,自动删除该文件夹内的所有便签 + */ + 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"; + + /** + * 移动文件夹内便签到回收站的触发器 + * 当文件夹被移动到回收站时,自动将该文件夹内的所有便签也移动到回收站 + */ + 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"; + + /** + * 构造函数 + * + * @param context 上下文环境 + */ + public NotesDatabaseHelper(Context context) { + super(context, DB_NAME, null, DB_VERSION); + } + + /** + * 创建便签表 + * + * @param db 数据库对象 + */ + public void createNoteTable(SQLiteDatabase db) { + // 执行创建便签表的SQL语句 + 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"); + 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); + } + + /** + * 创建系统文件夹 + * 包括通话记录文件夹、根文件夹、临时文件夹和回收站文件夹 + * + * @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) { + // 执行创建数据表的SQL语句 + 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 数据库对象 + */ + 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) { + if (mInstance == null) { + mInstance = new NotesDatabaseHelper(context); + } + return mInstance; + } + + /** + * 数据库创建回调方法 + * 当数据库首次创建时调用 + * + * @param db 数据库对象 + */ + @Override + public void onCreate(SQLiteDatabase db) { + createNoteTable(db); + createDataTable(db); + } + + /** + * 数据库升级回调方法 + * 当数据库版本升级时调用 + * + * @param db 数据库对象 + * @param oldVersion 旧版本号 + * @param newVersion 新版本号 + */ + @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; // 这个升级包含了从v2到v3的升级 + oldVersion++; + } + + // 从版本2升级到版本3 + if (oldVersion == 2 && !skipV2) { + 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 + * 完全重建数据库表 + * + * @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 + * 添加Google Tasks ID列和回收站文件夹 + * + * @param db 数据库对象 + */ + private void upgradeToV3(SQLiteDatabase db) { + // 删除未使用的触发器 + 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"); + // 添加Google Tasks ID列 + db.execSQL("ALTER TABLE " + TABLE.NOTE + " ADD COLUMN " + NoteColumns.GTASK_ID + + " TEXT NOT NULL DEFAULT ''"); + // 添加回收站系统文件夹 + 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"); + } +} diff --git a/app/src/main/java/net/micode/notes/data/NotesProvider.java b/app/src/main/java/net/micode/notes/data/NotesProvider.java new file mode 100644 index 0000000..8f65e2f --- /dev/null +++ b/app/src/main/java/net/micode/notes/data/NotesProvider.java @@ -0,0 +1,431 @@ +/* + * 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. + */ + +/** + * 文件: NotesProvider.java + * 描述: 便签应用的内容提供者,负责管理便签数据的访问 + * 作用: 为应用程序和其他应用提供便签数据的统一访问接口,实现数据的增删改查操作 + */ +package net.micode.notes.data; + + +import android.app.SearchManager; +import android.content.ContentProvider; +import android.content.ContentUris; +import android.content.ContentValues; +import android.content.Intent; +import android.content.UriMatcher; +import android.database.Cursor; +import android.database.sqlite.SQLiteDatabase; +import android.net.Uri; +import android.text.TextUtils; +import android.util.Log; + +import net.micode.notes.R; +import net.micode.notes.data.Notes.DataColumns; +import net.micode.notes.data.Notes.NoteColumns; +import net.micode.notes.data.NotesDatabaseHelper.TABLE; + +/** + * 便签内容提供者类 + * + * 继承自ContentProvider,负责处理对便签数据的访问请求 + * 实现了标准的CRUD操作(创建、读取、更新、删除) + * 支持便签搜索功能 + */ +public class NotesProvider extends ContentProvider { + /** URI匹配器,用于匹配请求的URI类型 */ + private static final UriMatcher mMatcher; + + /** 数据库帮助类实例 */ + private NotesDatabaseHelper mHelper; + + /** 日志标签 */ + private static final String TAG = "NotesProvider"; + + /** 便签表URI类型 */ + private static final int URI_NOTE = 1; + /** 单个便签项URI类型 */ + private static final int URI_NOTE_ITEM = 2; + /** 数据表URI类型 */ + private static final int URI_DATA = 3; + /** 单个数据项URI类型 */ + private static final int URI_DATA_ITEM = 4; + + /** 搜索URI类型 */ + private static final int URI_SEARCH = 5; + /** 搜索建议URI类型 */ + private static final int URI_SEARCH_SUGGEST = 6; + + // 静态初始化块,配置URI匹配器 + static { + mMatcher = new UriMatcher(UriMatcher.NO_MATCH); + // 添加各种URI匹配规则 + mMatcher.addURI(Notes.AUTHORITY, "note", URI_NOTE); + mMatcher.addURI(Notes.AUTHORITY, "note/#", URI_NOTE_ITEM); + mMatcher.addURI(Notes.AUTHORITY, "data", URI_DATA); + mMatcher.addURI(Notes.AUTHORITY, "data/#", URI_DATA_ITEM); + mMatcher.addURI(Notes.AUTHORITY, "search", URI_SEARCH); + mMatcher.addURI(Notes.AUTHORITY, SearchManager.SUGGEST_URI_PATH_QUERY, URI_SEARCH_SUGGEST); + mMatcher.addURI(Notes.AUTHORITY, SearchManager.SUGGEST_URI_PATH_QUERY + "/*", URI_SEARCH_SUGGEST); + } + + /** + * 搜索结果的投影列 + * x'0A'表示SQLite中的'\n'字符。为了在搜索结果中显示更多信息, + * 我们会删除标题和内容中的'\n'和空格。 + */ + private static final String NOTES_SEARCH_PROJECTION = NoteColumns.ID + "," + + NoteColumns.ID + " AS " + SearchManager.SUGGEST_COLUMN_INTENT_EXTRA_DATA + "," + + "TRIM(REPLACE(" + NoteColumns.SNIPPET + ", x'0A','')) AS " + SearchManager.SUGGEST_COLUMN_TEXT_1 + "," + + "TRIM(REPLACE(" + NoteColumns.SNIPPET + ", x'0A','')) AS " + SearchManager.SUGGEST_COLUMN_TEXT_2 + "," + + R.drawable.search_result + " AS " + SearchManager.SUGGEST_COLUMN_ICON_1 + "," + + "'" + Intent.ACTION_VIEW + "' AS " + SearchManager.SUGGEST_COLUMN_INTENT_ACTION + "," + + "'" + Notes.TextNote.CONTENT_TYPE + "' AS " + SearchManager.SUGGEST_COLUMN_INTENT_DATA; + + /** + * 便签片段搜索查询SQL + * 用于搜索便签内容,排除回收站中的便签和非便签类型的项目 + */ + private static String NOTES_SNIPPET_SEARCH_QUERY = "SELECT " + NOTES_SEARCH_PROJECTION + + " FROM " + TABLE.NOTE + + " WHERE " + NoteColumns.SNIPPET + " LIKE ?" + + " AND " + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER + + " AND " + NoteColumns.TYPE + "=" + Notes.TYPE_NOTE; + + /** + * 内容提供者初始化 + * + * @return 初始化是否成功 + */ + @Override + public boolean onCreate() { + // 获取数据库帮助类实例 + mHelper = NotesDatabaseHelper.getInstance(getContext()); + return true; + } + + /** + * 查询数据 + * + * @param uri 请求的URI + * @param projection 要返回的列 + * @param selection 查询条件 + * @param selectionArgs 查询条件参数 + * @param sortOrder 排序方式 + * @return 查询结果游标 + */ + @Override + public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs, + String sortOrder) { + Cursor c = null; + // 获取可读数据库 + SQLiteDatabase db = mHelper.getReadableDatabase(); + String id = null; + + // 根据URI类型执行不同的查询操作 + switch (mMatcher.match(uri)) { + case URI_NOTE: + // 查询便签表 + c = db.query(TABLE.NOTE, projection, selection, selectionArgs, null, null, + sortOrder); + break; + case URI_NOTE_ITEM: + // 查询单个便签项 + id = uri.getPathSegments().get(1); + c = db.query(TABLE.NOTE, projection, NoteColumns.ID + "=" + id + + parseSelection(selection), selectionArgs, null, null, sortOrder); + break; + case URI_DATA: + // 查询数据表 + c = db.query(TABLE.DATA, projection, selection, selectionArgs, null, null, + sortOrder); + break; + case URI_DATA_ITEM: + // 查询单个数据项 + id = uri.getPathSegments().get(1); + c = db.query(TABLE.DATA, projection, DataColumns.ID + "=" + id + + parseSelection(selection), selectionArgs, null, null, sortOrder); + break; + case URI_SEARCH: + case URI_SEARCH_SUGGEST: + // 处理搜索和搜索建议请求 + if (sortOrder != null || projection != null) { + throw new IllegalArgumentException( + "do not specify sortOrder, selection, selectionArgs, or projection" + "with this query"); + } + + // 获取搜索字符串 + String searchString = null; + if (mMatcher.match(uri) == URI_SEARCH_SUGGEST) { + if (uri.getPathSegments().size() > 1) { + searchString = uri.getPathSegments().get(1); + } + } else { + searchString = uri.getQueryParameter("pattern"); + } + + // 如果搜索字符串为空,则返回null + if (TextUtils.isEmpty(searchString)) { + return null; + } + + // 执行搜索查询 + try { + searchString = String.format("%%%s%%", searchString); // 添加通配符以进行模糊匹配 + c = db.rawQuery(NOTES_SNIPPET_SEARCH_QUERY, + new String[] { searchString }); + } catch (IllegalStateException ex) { + Log.e(TAG, "got exception: " + ex.toString()); + } + break; + default: + throw new IllegalArgumentException("Unknown URI " + uri); + } + + // 设置通知URI,当数据变化时通知观察者 + if (c != null) { + c.setNotificationUri(getContext().getContentResolver(), uri); + } + return c; + } + + /** + * 插入数据 + * + * @param uri 请求的URI + * @param values 要插入的值 + * @return 插入后的URI + */ + @Override + public Uri insert(Uri uri, ContentValues values) { + // 获取可写数据库 + SQLiteDatabase db = mHelper.getWritableDatabase(); + long dataId = 0, noteId = 0, insertedId = 0; + + // 根据URI类型执行不同的插入操作 + switch (mMatcher.match(uri)) { + case URI_NOTE: + // 插入便签 + insertedId = noteId = db.insert(TABLE.NOTE, null, values); + break; + case URI_DATA: + // 插入数据 + if (values.containsKey(DataColumns.NOTE_ID)) { + noteId = values.getAsLong(DataColumns.NOTE_ID); + } else { + Log.d(TAG, "Wrong data format without note id:" + values.toString()); + } + insertedId = dataId = db.insert(TABLE.DATA, null, values); + break; + default: + throw new IllegalArgumentException("Unknown URI " + uri); + } + + // 通知便签URI的观察者 + if (noteId > 0) { + getContext().getContentResolver().notifyChange( + ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId), null); + } + + // 通知数据URI的观察者 + if (dataId > 0) { + getContext().getContentResolver().notifyChange( + ContentUris.withAppendedId(Notes.CONTENT_DATA_URI, dataId), null); + } + + return ContentUris.withAppendedId(uri, insertedId); + } + + /** + * 删除数据 + * + * @param uri 请求的URI + * @param selection 删除条件 + * @param selectionArgs 删除条件参数 + * @return 删除的行数 + */ + @Override + public int delete(Uri uri, String selection, String[] selectionArgs) { + int count = 0; + String id = null; + // 获取可写数据库 + SQLiteDatabase db = mHelper.getWritableDatabase(); + boolean deleteData = false; + + // 根据URI类型执行不同的删除操作 + switch (mMatcher.match(uri)) { + case URI_NOTE: + // 删除便签,ID必须大于0(系统文件夹ID小于等于0) + selection = "(" + selection + ") AND " + NoteColumns.ID + ">0 "; + count = db.delete(TABLE.NOTE, selection, selectionArgs); + break; + case URI_NOTE_ITEM: + // 删除单个便签项 + id = uri.getPathSegments().get(1); + /** + * ID小于0的是系统文件夹,不允许删除 + */ + long noteId = Long.valueOf(id); + if (noteId <= 0) { + break; + } + count = db.delete(TABLE.NOTE, + NoteColumns.ID + "=" + id + parseSelection(selection), selectionArgs); + break; + case URI_DATA: + // 删除数据 + count = db.delete(TABLE.DATA, selection, selectionArgs); + deleteData = true; + break; + case URI_DATA_ITEM: + // 删除单个数据项 + id = uri.getPathSegments().get(1); + count = db.delete(TABLE.DATA, + DataColumns.ID + "=" + id + parseSelection(selection), selectionArgs); + deleteData = true; + break; + default: + throw new IllegalArgumentException("Unknown URI " + uri); + } + + // 如果有删除操作,通知观察者 + if (count > 0) { + if (deleteData) { + getContext().getContentResolver().notifyChange(Notes.CONTENT_NOTE_URI, null); + } + getContext().getContentResolver().notifyChange(uri, null); + } + return count; + } + + /** + * 更新数据 + * + * @param uri 请求的URI + * @param values 要更新的值 + * @param selection 更新条件 + * @param selectionArgs 更新条件参数 + * @return 更新的行数 + */ + @Override + public int update(Uri uri, ContentValues values, String selection, String[] selectionArgs) { + int count = 0; + String id = null; + // 获取可写数据库 + SQLiteDatabase db = mHelper.getWritableDatabase(); + boolean updateData = false; + + // 根据URI类型执行不同的更新操作 + switch (mMatcher.match(uri)) { + case URI_NOTE: + // 更新便签表 + increaseNoteVersion(-1, selection, selectionArgs); // 增加便签版本号 + count = db.update(TABLE.NOTE, values, selection, selectionArgs); + break; + case URI_NOTE_ITEM: + // 更新单个便签项 + id = uri.getPathSegments().get(1); + increaseNoteVersion(Long.valueOf(id), selection, selectionArgs); // 增加便签版本号 + count = db.update(TABLE.NOTE, values, NoteColumns.ID + "=" + id + + parseSelection(selection), selectionArgs); + break; + case URI_DATA: + // 更新数据表 + count = db.update(TABLE.DATA, values, selection, selectionArgs); + updateData = true; + break; + case URI_DATA_ITEM: + // 更新单个数据项 + id = uri.getPathSegments().get(1); + count = db.update(TABLE.DATA, values, DataColumns.ID + "=" + id + + parseSelection(selection), selectionArgs); + updateData = true; + break; + default: + throw new IllegalArgumentException("Unknown URI " + uri); + } + + // 如果有更新操作,通知观察者 + if (count > 0) { + if (updateData) { + getContext().getContentResolver().notifyChange(Notes.CONTENT_NOTE_URI, null); + } + getContext().getContentResolver().notifyChange(uri, null); + } + return count; + } + + /** + * 解析选择条件 + * 将额外的选择条件添加到现有条件中 + * + * @param selection 选择条件 + * @return 解析后的选择条件 + */ + private String parseSelection(String selection) { + return (!TextUtils.isEmpty(selection) ? " AND (" + selection + ')' : ""); + } + + /** + * 增加便签版本号 + * 当便签内容更新时,增加版本号以便于同步 + * + * @param id 便签ID,如果为-1则使用selection和selectionArgs + * @param selection 选择条件 + * @param selectionArgs 选择条件参数 + */ + private void increaseNoteVersion(long id, String selection, String[] selectionArgs) { + // 构建更新版本号的SQL语句 + StringBuilder sql = new StringBuilder(120); + sql.append("UPDATE "); + sql.append(TABLE.NOTE); + sql.append(" SET "); + sql.append(NoteColumns.VERSION); + sql.append("=" + NoteColumns.VERSION + "+1 "); + + // 添加WHERE条件 + if (id > 0 || !TextUtils.isEmpty(selection)) { + sql.append(" WHERE "); + } + if (id > 0) { + sql.append(NoteColumns.ID + "=" + String.valueOf(id)); + } + if (!TextUtils.isEmpty(selection)) { + String selectString = id > 0 ? parseSelection(selection) : selection; + // 替换参数占位符 + for (String args : selectionArgs) { + selectString = selectString.replaceFirst("\\?", args); + } + sql.append(selectString); + } + + // 执行SQL语句 + mHelper.getWritableDatabase().execSQL(sql.toString()); + } + + /** + * 获取内容类型 + * + * @param uri 请求的URI + * @return 内容类型 + */ + @Override + public String getType(Uri uri) { + // TODO Auto-generated method stub + return null; + } +} diff --git a/app/src/main/java/net/micode/notes/gtask/data/MetaData.java b/app/src/main/java/net/micode/notes/gtask/data/MetaData.java new file mode 100644 index 0000000..b6f5d2e --- /dev/null +++ b/app/src/main/java/net/micode/notes/gtask/data/MetaData.java @@ -0,0 +1,143 @@ +/* + * 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. + */ + +/** + * 文件: MetaData.java + * 描述: Google Tasks元数据处理类,用于存储和管理便签与Google Tasks之间的映射关系 + * 作用: 存储便签的元数据信息,建立本地便签与Google Tasks任务的关联 + */ +package net.micode.notes.gtask.data; + +import android.database.Cursor; +import android.util.Log; + +import net.micode.notes.tool.GTaskStringUtils; + +import org.json.JSONException; +import org.json.JSONObject; + +/** + * MetaData类,继承自Task类 + * 用于存储和管理Google Tasks与本地便签之间的映射关系 + * 作为元数据存储容器,保存两端数据的关联信息 + */ +public class MetaData extends Task { + /** 日志标签 */ + private final static String TAG = MetaData.class.getSimpleName(); + + /** 关联的Google Task ID */ + private String mRelatedGid = null; + + /** + * 设置元数据信息 + * + * @param gid Google Task ID + * @param metaInfo 元数据信息的JSON对象 + */ + public void setMeta(String gid, JSONObject metaInfo) { + try { + // 将Google Task ID添加到元数据信息中 + metaInfo.put(GTaskStringUtils.META_HEAD_GTASK_ID, gid); + } catch (JSONException e) { + Log.e(TAG, "failed to put related gid"); + } + // 将元数据JSON字符串设置为任务的备注 + setNotes(metaInfo.toString()); + // 设置元数据任务的名称为固定值 + setName(GTaskStringUtils.META_NOTE_NAME); + } + + /** + * 获取关联的Google Task ID + * + * @return 关联的Google Task ID + */ + public String getRelatedGid() { + return mRelatedGid; + } + + /** + * 判断元数据是否值得保存 + * + * @return 如果备注不为空则返回true,否则返回false + */ + @Override + public boolean isWorthSaving() { + return getNotes() != null; + } + + /** + * 从远程JSON数据中设置内容 + * 解析远程数据并提取关联的Google Task ID + * + * @param js 远程JSON数据 + */ + @Override + public void setContentByRemoteJSON(JSONObject js) { + // 调用父类方法设置基本内容 + super.setContentByRemoteJSON(js); + if (getNotes() != null) { + try { + // 解析备注中的JSON数据 + JSONObject metaInfo = new JSONObject(getNotes().trim()); + // 获取关联的Google Task ID + mRelatedGid = metaInfo.getString(GTaskStringUtils.META_HEAD_GTASK_ID); + } catch (JSONException e) { + Log.w(TAG, "failed to get related gid"); + mRelatedGid = null; + } + } + } + + /** + * 从本地JSON数据中设置内容 + * 此方法不应被调用,因为元数据只从远程获取 + * + * @param js 本地JSON数据 + * @throws IllegalAccessError 如果调用此方法则抛出异常 + */ + @Override + public void setContentByLocalJSON(JSONObject js) { + // 此方法不应被调用 + throw new IllegalAccessError("MetaData:setContentByLocalJSON should not be called"); + } + + /** + * 从内容中获取本地JSON数据 + * 此方法不应被调用,因为元数据只从远程获取 + * + * @return JSONObject 本地JSON数据 + * @throws IllegalAccessError 如果调用此方法则抛出异常 + */ + @Override + public JSONObject getLocalJSONFromContent() { + throw new IllegalAccessError("MetaData:getLocalJSONFromContent should not be called"); + } + + /** + * 获取同步操作类型 + * 此方法不应被调用,因为元数据的同步操作由GTaskManager管理 + * + * @param c 数据库游标 + * @return 同步操作类型 + * @throws IllegalAccessError 如果调用此方法则抛出异常 + */ + @Override + public int getSyncAction(Cursor c) { + throw new IllegalAccessError("MetaData:getSyncAction should not be called"); + } + +} diff --git a/app/src/main/java/net/micode/notes/gtask/data/Node.java b/app/src/main/java/net/micode/notes/gtask/data/Node.java new file mode 100644 index 0000000..983235e --- /dev/null +++ b/app/src/main/java/net/micode/notes/gtask/data/Node.java @@ -0,0 +1,201 @@ +/* + * 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. + */ + +/** + * 文件: Node.java + * 描述: 数据节点抽象基类,定义了同步操作的基本接口和属性 + * 作用: 为TaskList、Task和MetaData等具体类提供统一的接口和基本功能 + */ +package net.micode.notes.gtask.data; + +import android.database.Cursor; + +import org.json.JSONObject; + +/** + * Node抽象类 + * 定义了同步操作的基本接口和属性,是TaskList、Task和MetaData等类的基类 + * 提供了数据同步过程中需要的基本操作和状态定义 + */ +public abstract class Node { + /** 同步操作:无操作 */ + public static final int SYNC_ACTION_NONE = 0; + + /** 同步操作:添加到远程 */ + public static final int SYNC_ACTION_ADD_REMOTE = 1; + + /** 同步操作:添加到本地 */ + public static final int SYNC_ACTION_ADD_LOCAL = 2; + + /** 同步操作:从远程删除 */ + public static final int SYNC_ACTION_DEL_REMOTE = 3; + + /** 同步操作:从本地删除 */ + public static final int SYNC_ACTION_DEL_LOCAL = 4; + + /** 同步操作:更新远程 */ + public static final int SYNC_ACTION_UPDATE_REMOTE = 5; + + /** 同步操作:更新本地 */ + public static final int SYNC_ACTION_UPDATE_LOCAL = 6; + + /** 同步操作:更新冲突 */ + public static final int SYNC_ACTION_UPDATE_CONFLICT = 7; + + /** 同步操作:错误 */ + public static final int SYNC_ACTION_ERROR = 8; + + /** Google Task ID */ + private String mGid; + + /** 节点名称 */ + private String mName; + + /** 最后修改时间 */ + private long mLastModified; + + /** 是否已删除 */ + private boolean mDeleted; + + /** + * 构造函数 + * 初始化节点的基本属性 + */ + public Node() { + mGid = null; + mName = ""; + mLastModified = 0; + mDeleted = false; + } + + /** + * 获取创建操作的JSON对象 + * + * @param actionId 操作ID + * @return 创建操作的JSON对象 + */ + public abstract JSONObject getCreateAction(int actionId); + + /** + * 获取更新操作的JSON对象 + * + * @param actionId 操作ID + * @return 更新操作的JSON对象 + */ + public abstract JSONObject getUpdateAction(int actionId); + + /** + * 从远程JSON数据中设置内容 + * + * @param js 远程JSON数据 + */ + public abstract void setContentByRemoteJSON(JSONObject js); + + /** + * 从本地JSON数据中设置内容 + * + * @param js 本地JSON数据 + */ + public abstract void setContentByLocalJSON(JSONObject js); + + /** + * 从内容中获取本地JSON数据 + * + * @return 本地JSON数据 + */ + public abstract JSONObject getLocalJSONFromContent(); + + /** + * 获取同步操作类型 + * + * @param c 数据库游标 + * @return 同步操作类型 + */ + public abstract int getSyncAction(Cursor c); + + /** + * 设置Google Task ID + * + * @param gid Google Task ID + */ + public void setGid(String gid) { + this.mGid = gid; + } + + /** + * 设置节点名称 + * + * @param name 节点名称 + */ + public void setName(String name) { + this.mName = name; + } + + /** + * 设置最后修改时间 + * + * @param lastModified 最后修改时间 + */ + public void setLastModified(long lastModified) { + this.mLastModified = lastModified; + } + + /** + * 设置删除状态 + * + * @param deleted 是否已删除 + */ + public void setDeleted(boolean deleted) { + this.mDeleted = deleted; + } + + /** + * 获取Google Task ID + * + * @return Google Task ID + */ + public String getGid() { + return this.mGid; + } + + /** + * 获取节点名称 + * + * @return 节点名称 + */ + public String getName() { + return this.mName; + } + + /** + * 获取最后修改时间 + * + * @return 最后修改时间 + */ + public long getLastModified() { + return this.mLastModified; + } + + /** + * 获取删除状态 + * + * @return 是否已删除 + */ + public boolean getDeleted() { + return this.mDeleted; + } + +} diff --git a/app/src/main/java/net/micode/notes/gtask/data/SqlData.java b/app/src/main/java/net/micode/notes/gtask/data/SqlData.java new file mode 100644 index 0000000..e4cc676 --- /dev/null +++ b/app/src/main/java/net/micode/notes/gtask/data/SqlData.java @@ -0,0 +1,266 @@ +/* + * 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. + */ + +/** + * 文件: SqlData.java + * 描述: 便签数据内容的SQL操作封装类 + * 作用: 管理便签内容数据的数据库操作,提供数据的CRUD功能 + */ +package net.micode.notes.gtask.data; + +import android.content.ContentResolver; +import android.content.ContentUris; +import android.content.ContentValues; +import android.content.Context; +import android.database.Cursor; +import android.net.Uri; +import android.util.Log; + +import net.micode.notes.data.Notes; +import net.micode.notes.data.Notes.DataColumns; +import net.micode.notes.data.Notes.DataConstants; +import net.micode.notes.data.Notes.NoteColumns; +import net.micode.notes.data.NotesDatabaseHelper.TABLE; +import net.micode.notes.gtask.exception.ActionFailureException; + +import org.json.JSONException; +import org.json.JSONObject; + +/** + * SqlData类 + * 负责管理便签内容数据的数据库操作 + * 封装了对便签内容的增删改查功能 + */ +public class SqlData { + /** 日志标签 */ + private static final String TAG = SqlData.class.getSimpleName(); + + /** 无效ID标识 */ + private static final int INVALID_ID = -99999; + + /** 数据表查询投影列 */ + public static final String[] PROJECTION_DATA = new String[] { + DataColumns.ID, DataColumns.MIME_TYPE, DataColumns.CONTENT, DataColumns.DATA1, + DataColumns.DATA3 + }; + + /** 数据ID列索引 */ + public static final int DATA_ID_COLUMN = 0; + + /** 数据MIME类型列索引 */ + public static final int DATA_MIME_TYPE_COLUMN = 1; + + /** 数据内容列索引 */ + public static final int DATA_CONTENT_COLUMN = 2; + + /** 数据DATA1列索引 */ + public static final int DATA_CONTENT_DATA_1_COLUMN = 3; + + /** 数据DATA3列索引 */ + public static final int DATA_CONTENT_DATA_3_COLUMN = 4; + + /** 内容解析器 */ + private ContentResolver mContentResolver; + + /** 是否为新建数据标志 */ + private boolean mIsCreate; + + /** 数据ID */ + private long mDataId; + + /** 数据MIME类型 */ + private String mDataMimeType; + + /** 数据内容 */ + private String mDataContent; + + /** 数据DATA1值 */ + private long mDataContentData1; + + /** 数据DATA3值 */ + private String mDataContentData3; + + /** 数据变更值集合 */ + private ContentValues mDiffDataValues; + + /** + * 构造函数 - 创建新的数据对象 + * + * @param context 应用上下文 + */ + public SqlData(Context context) { + mContentResolver = context.getContentResolver(); + mIsCreate = true; + mDataId = INVALID_ID; + mDataMimeType = DataConstants.NOTE; + mDataContent = ""; + mDataContentData1 = 0; + mDataContentData3 = ""; + mDiffDataValues = new ContentValues(); + } + + /** + * 构造函数 - 从数据库游标加载现有数据 + * + * @param context 应用上下文 + * @param c 数据库游标 + */ + public SqlData(Context context, Cursor c) { + mContentResolver = context.getContentResolver(); + mIsCreate = false; + loadFromCursor(c); + mDiffDataValues = new ContentValues(); + } + + /** + * 从数据库游标加载数据 + * + * @param c 数据库游标 + */ + private void loadFromCursor(Cursor c) { + mDataId = c.getLong(DATA_ID_COLUMN); + mDataMimeType = c.getString(DATA_MIME_TYPE_COLUMN); + mDataContent = c.getString(DATA_CONTENT_COLUMN); + mDataContentData1 = c.getLong(DATA_CONTENT_DATA_1_COLUMN); + mDataContentData3 = c.getString(DATA_CONTENT_DATA_3_COLUMN); + } + + /** + * 从JSON对象设置数据内容 + * 比较新旧值,只记录变更的字段 + * + * @param js JSON对象 + * @throws JSONException JSON解析异常 + */ + public void setContent(JSONObject js) throws JSONException { + // 处理数据ID + long dataId = js.has(DataColumns.ID) ? js.getLong(DataColumns.ID) : INVALID_ID; + if (mIsCreate || mDataId != dataId) { + mDiffDataValues.put(DataColumns.ID, dataId); + } + mDataId = dataId; + + // 处理MIME类型 + String dataMimeType = js.has(DataColumns.MIME_TYPE) ? js.getString(DataColumns.MIME_TYPE) + : DataConstants.NOTE; + if (mIsCreate || !mDataMimeType.equals(dataMimeType)) { + mDiffDataValues.put(DataColumns.MIME_TYPE, dataMimeType); + } + mDataMimeType = dataMimeType; + + // 处理内容 + String dataContent = js.has(DataColumns.CONTENT) ? js.getString(DataColumns.CONTENT) : ""; + if (mIsCreate || !mDataContent.equals(dataContent)) { + mDiffDataValues.put(DataColumns.CONTENT, dataContent); + } + mDataContent = dataContent; + + // 处理DATA1 + long dataContentData1 = js.has(DataColumns.DATA1) ? js.getLong(DataColumns.DATA1) : 0; + if (mIsCreate || mDataContentData1 != dataContentData1) { + mDiffDataValues.put(DataColumns.DATA1, dataContentData1); + } + mDataContentData1 = dataContentData1; + + // 处理DATA3 + String dataContentData3 = js.has(DataColumns.DATA3) ? js.getString(DataColumns.DATA3) : ""; + if (mIsCreate || !mDataContentData3.equals(dataContentData3)) { + mDiffDataValues.put(DataColumns.DATA3, dataContentData3); + } + mDataContentData3 = dataContentData3; + } + + /** + * 获取数据内容的JSON对象表示 + * + * @return 包含数据内容的JSON对象 + * @throws JSONException JSON解析异常 + */ + public JSONObject getContent() throws JSONException { + if (mIsCreate) { + Log.e(TAG, "it seems that we haven't created this in database yet"); + return null; + } + JSONObject js = new JSONObject(); + js.put(DataColumns.ID, mDataId); + js.put(DataColumns.MIME_TYPE, mDataMimeType); + js.put(DataColumns.CONTENT, mDataContent); + js.put(DataColumns.DATA1, mDataContentData1); + js.put(DataColumns.DATA3, mDataContentData3); + return js; + } + + /** + * 提交数据变更到数据库 + * + * @param noteId 关联的便签ID + * @param validateVersion 是否验证版本 + * @param version 版本号 + */ + public void commit(long noteId, boolean validateVersion, long version) { + // 新建数据 + if (mIsCreate) { + // 处理无效ID + if (mDataId == INVALID_ID && mDiffDataValues.containsKey(DataColumns.ID)) { + mDiffDataValues.remove(DataColumns.ID); + } + + // 设置关联的便签ID + mDiffDataValues.put(DataColumns.NOTE_ID, noteId); + Uri uri = mContentResolver.insert(Notes.CONTENT_DATA_URI, mDiffDataValues); + try { + mDataId = Long.valueOf(uri.getPathSegments().get(1)); + } catch (NumberFormatException e) { + Log.e(TAG, "Get note id error :" + e.toString()); + throw new ActionFailureException("create note failed"); + } + } else { + // 更新现有数据 + if (mDiffDataValues.size() > 0) { + int result = 0; + if (!validateVersion) { + // 不验证版本的更新 + result = mContentResolver.update(ContentUris.withAppendedId( + Notes.CONTENT_DATA_URI, mDataId), mDiffDataValues, null, null); + } else { + // 验证版本的更新 + result = mContentResolver.update(ContentUris.withAppendedId( + Notes.CONTENT_DATA_URI, mDataId), mDiffDataValues, + " ? in (SELECT " + NoteColumns.ID + " FROM " + TABLE.NOTE + + " WHERE " + NoteColumns.VERSION + "=?)", new String[] { + String.valueOf(noteId), String.valueOf(version) + }); + } + if (result == 0) { + Log.w(TAG, "there is no update. maybe user updates note when syncing"); + } + } + } + + // 清空变更记录并更新状态 + mDiffDataValues.clear(); + mIsCreate = false; + } + + /** + * 获取数据ID + * + * @return 数据ID + */ + public long getId() { + return mDataId; + } +} diff --git a/app/src/main/java/net/micode/notes/gtask/data/SqlNote.java b/app/src/main/java/net/micode/notes/gtask/data/SqlNote.java new file mode 100644 index 0000000..8abe9da --- /dev/null +++ b/app/src/main/java/net/micode/notes/gtask/data/SqlNote.java @@ -0,0 +1,661 @@ +/* + * 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. + */ + +/** + * 文件: SqlNote.java + * 描述: 便签数据的SQL操作封装类 + * 作用: 管理便签数据的数据库操作,提供便签的CRUD功能,是应用与数据库交互的核心类 + */ +package net.micode.notes.gtask.data; + +import android.appwidget.AppWidgetManager; +import android.content.ContentResolver; +import android.content.ContentValues; +import android.content.Context; +import android.database.Cursor; +import android.net.Uri; +import android.util.Log; + +import net.micode.notes.data.Notes; +import net.micode.notes.data.Notes.DataColumns; +import net.micode.notes.data.Notes.NoteColumns; +import net.micode.notes.gtask.exception.ActionFailureException; +import net.micode.notes.tool.GTaskStringUtils; +import net.micode.notes.tool.ResourceParser; + +import org.json.JSONArray; +import org.json.JSONException; +import org.json.JSONObject; + +import java.util.ArrayList; + +/** + * SqlNote类 + * 负责管理便签数据的数据库操作 + * 封装了对便签的增删改查功能,并处理与Google Tasks的数据同步 + */ +public class SqlNote { + /** 日志标签 */ + private static final String TAG = SqlNote.class.getSimpleName(); + + /** 无效ID标识 */ + private static final int INVALID_ID = -99999; + + /** 便签表查询投影列 */ + public static final String[] PROJECTION_NOTE = new String[] { + NoteColumns.ID, NoteColumns.ALERTED_DATE, NoteColumns.BG_COLOR_ID, + NoteColumns.CREATED_DATE, NoteColumns.HAS_ATTACHMENT, NoteColumns.MODIFIED_DATE, + NoteColumns.NOTES_COUNT, NoteColumns.PARENT_ID, NoteColumns.SNIPPET, NoteColumns.TYPE, + NoteColumns.WIDGET_ID, NoteColumns.WIDGET_TYPE, NoteColumns.SYNC_ID, + NoteColumns.LOCAL_MODIFIED, NoteColumns.ORIGIN_PARENT_ID, NoteColumns.GTASK_ID, + NoteColumns.VERSION + }; + + /** ID列索引 */ + public static final int ID_COLUMN = 0; + + /** 提醒日期列索引 */ + public static final int ALERTED_DATE_COLUMN = 1; + + /** 背景颜色ID列索引 */ + public static final int BG_COLOR_ID_COLUMN = 2; + + /** 创建日期列索引 */ + public static final int CREATED_DATE_COLUMN = 3; + + /** 是否有附件列索引 */ + public static final int HAS_ATTACHMENT_COLUMN = 4; + + /** 修改日期列索引 */ + public static final int MODIFIED_DATE_COLUMN = 5; + + /** 便签数量列索引 */ + public static final int NOTES_COUNT_COLUMN = 6; + + /** 父ID列索引 */ + public static final int PARENT_ID_COLUMN = 7; + + /** 摘要列索引 */ + public static final int SNIPPET_COLUMN = 8; + + /** 类型列索引 */ + public static final int TYPE_COLUMN = 9; + + /** 小部件ID列索引 */ + public static final int WIDGET_ID_COLUMN = 10; + + /** 小部件类型列索引 */ + public static final int WIDGET_TYPE_COLUMN = 11; + + /** 同步ID列索引 */ + public static final int SYNC_ID_COLUMN = 12; + + /** 本地修改标志列索引 */ + public static final int LOCAL_MODIFIED_COLUMN = 13; + + /** 原始父ID列索引 */ + public static final int ORIGIN_PARENT_ID_COLUMN = 14; + + /** Google Task ID列索引 */ + public static final int GTASK_ID_COLUMN = 15; + + /** 版本列索引 */ + public static final int VERSION_COLUMN = 16; + + /** 应用上下文 */ + private Context mContext; + + /** 内容解析器 */ + private ContentResolver mContentResolver; + + /** 是否为新建便签标志 */ + private boolean mIsCreate; + + /** 便签ID */ + private long mId; + + /** 提醒日期 */ + private long mAlertDate; + + /** 背景颜色ID */ + private int mBgColorId; + + /** 创建日期 */ + private long mCreatedDate; + + /** 是否有附件 */ + private int mHasAttachment; + + /** 修改日期 */ + private long mModifiedDate; + + /** 父ID */ + private long mParentId; + + /** 摘要 */ + private String mSnippet; + + /** 类型 */ + private int mType; + + /** 小部件ID */ + private int mWidgetId; + + /** 小部件类型 */ + private int mWidgetType; + + /** 原始父ID */ + private long mOriginParent; + + /** 版本号 */ + private long mVersion; + + /** 便签变更值集合 */ + private ContentValues mDiffNoteValues; + + /** 便签数据列表 */ + private ArrayList`))jlv3Kr#7T8rx>Okb$?!JU{~mfU(lm15P=nCu-=n