diff --git a/data/Contact.java b/data/Contact.java new file mode 100644 index 0000000..3afc830 --- /dev/null +++ b/data/Contact.java @@ -0,0 +1,109 @@ +/* + * 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. + */ + +// 包声明,表明该类属于 net.micode.notes.data 包 +package net.micode.notes.data; + +// 导入 Android 上下文相关类,用于获取应用程序的上下文信息 +import android.content.Context; +// 导入 Android 数据库游标类,用于处理数据库查询结果 +import android.database.Cursor; +// 导入联系人合约中电话相关的类,用于操作联系人的电话号码信息 +import android.provider.ContactsContract.CommonDataKinds.Phone; +// 导入联系人合约中数据相关的类,用于操作联系人的数据信息 +import android.provider.ContactsContract.Data; +// 导入电话号码处理工具类,用于处理电话号码的格式等操作 +import android.telephony.PhoneNumberUtils; +// 导入日志工具类,用于记录应用程序的日志信息 +import android.util.Log; + +// 导入 Java 中的 HashMap 类,用于存储键值对数据 +import java.util.HashMap; + +/** + * Contact 类用于根据电话号码从联系人数据库中获取联系人姓名,并使用缓存机制提高查询效率。 + */ +public class Contact { + // 静态变量,用于缓存电话号码和对应的联系人姓名,避免重复查询数据库 + private static HashMap sContactCache; + // 静态常量,用于标识日志的标签,方便在日志中区分不同类的日志信息 + private static final String TAG = "Contact"; + + // 静态常量,用于构建查询联系人的 SQL 语句,通过电话号码匹配联系人 + private static final String CALLER_ID_SELECTION = "PHONE_NUMBERS_EQUAL(" + Phone.NUMBER + + ",?) AND " + Data.MIMETYPE + "='" + Phone.CONTENT_ITEM_TYPE + "'" + + " AND " + Data.RAW_CONTACT_ID + " IN " + + "(SELECT raw_contact_id " + + " FROM phone_lookup" + + " WHERE min_match = '+')"; + + /** + * 根据电话号码从联系人数据库中获取联系人姓名。 + * + * @param context 应用程序的上下文对象,用于获取内容解析器 + * @param phoneNumber 要查询的电话号码 + * @return 如果找到匹配的联系人,则返回联系人姓名;否则返回 null + */ + public static String getContact(Context context, String phoneNumber) { + // 检查缓存是否为空,如果为空则创建一个新的 HashMap 实例 + if (sContactCache == null) { + sContactCache = new HashMap(); + } + + // 检查缓存中是否已经存在该电话号码对应的联系人姓名 + if (sContactCache.containsKey(phoneNumber)) { + // 如果存在,则直接从缓存中获取并返回联系人姓名 + return sContactCache.get(phoneNumber); + } + + // 将查询语句中的占位符 '+' 替换为处理后的电话号码最小匹配字符串 + String selection = CALLER_ID_SELECTION.replace("+", + PhoneNumberUtils.toCallerIDMinMatch(phoneNumber)); + // 使用内容解析器查询联系人数据库,获取匹配的联系人姓名 + Cursor cursor = context.getContentResolver().query( + Data.CONTENT_URI, // 查询的内容 URI + new String[]{Phone.DISPLAY_NAME}, // 查询的列名,只查询联系人姓名 + selection, // 查询的条件语句 + new String[]{phoneNumber}, // 查询条件的参数 + null // 查询结果的排序方式 + ); + + // 检查游标是否不为空且至少有一行数据 + if (cursor != null && cursor.moveToFirst()) { + try { + // 从游标中获取联系人姓名 + String name = cursor.getString(0); + // 将电话号码和对应的联系人姓名存入缓存 + sContactCache.put(phoneNumber, name); + // 返回联系人姓名 + return name; + } catch (IndexOutOfBoundsException e) { + // 捕获索引越界异常,并记录错误日志 + Log.e(TAG, " Cursor get string error " + e.toString()); + // 发生异常时返回 null + return null; + } finally { + // 无论是否发生异常,最后都关闭游标,释放资源 + cursor.close(); + } + } else { + // 如果没有找到匹配的联系人,记录日志信息 + Log.d(TAG, "No contact matched with number:" + phoneNumber); + // 返回 null + return null; + } + } +} \ No newline at end of file diff --git a/data/Notes.java b/data/Notes.java new file mode 100644 index 0000000..a42b4b7 --- /dev/null +++ b/data/Notes.java @@ -0,0 +1,324 @@ + /* + * 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. + */ + +// 包声明,表明该类属于 net.micode.notes.data 包 + package net.micode.notes.data; + +// 导入 Android 系统中用于表示统一资源标识符的类 +import android.net.Uri; + +/** + * Notes 类用于定义笔记应用中的各种常量、接口和内部类, + * 这些常量和接口主要用于表示笔记、文件夹、数据列等相关信息。 + */ +public class Notes { + // 定义内容提供者的授权信息,用于标识笔记应用的内容提供者 + public static final String AUTHORITY = "micode_notes"; + // 定义日志标签,用于在日志中标识该类的相关信息 + public static final String TAG = "Notes"; + + // 定义笔记类型的常量 + // 表示普通笔记类型 + public static final int TYPE_NOTE = 0; + // 表示文件夹类型 + public static final int TYPE_FOLDER = 1; + // 表示系统文件夹类型 + public static final int TYPE_SYSTEM = 2; + + /** + * 以下常量是系统文件夹的标识符 + * {@link Notes#ID_ROOT_FOLDER } 是默认文件夹 + * {@link Notes#ID_TEMPARAY_FOLDER } 用于存放不属于任何文件夹的笔记 + * {@link Notes#ID_CALL_RECORD_FOLDER} 用于存储通话记录 + */ + // 根文件夹的 ID + public static final int ID_ROOT_FOLDER = 0; + // 临时文件夹的 ID + public static final int ID_TEMPARAY_FOLDER = -1; + // 通话记录文件夹的 ID + public static final int ID_CALL_RECORD_FOLDER = -2; + // 回收站文件夹的 ID + public static final int ID_TRASH_FOLER = -3; + + // 定义意图额外数据的键,用于在不同组件间传递特定数据 + // 传递提醒日期的键 + public static final String INTENT_EXTRA_ALERT_DATE = "net.micode.notes.alert_date"; + // 传递背景颜色 ID 的键 + public static final String INTENT_EXTRA_BACKGROUND_ID = "net.micode.notes.background_color_id"; + // 传递小部件 ID 的键 + public static final String INTENT_EXTRA_WIDGET_ID = "net.micode.notes.widget_id"; + // 传递小部件类型的键 + public static final String INTENT_EXTRA_WIDGET_TYPE = "net.micode.notes.widget_type"; + // 传递文件夹 ID 的键 + public static final String INTENT_EXTRA_FOLDER_ID = "net.micode.notes.folder_id"; + // 传递通话日期的键 + public static final String INTENT_EXTRA_CALL_DATE = "net.micode.notes.call_date"; + + // 定义小部件类型的常量 + // 表示无效的小部件类型 + public static final int TYPE_WIDGET_INVALIDE = -1; + // 表示 2x 大小的小部件类型 + public static final int TYPE_WIDGET_2X = 0; + // 表示 4x 大小的小部件类型 + public static final int TYPE_WIDGET_4X = 1; + + /** + * DataConstants 是一个静态内部类,用于定义数据相关的常量 + */ + public static class DataConstants { + // 表示文本笔记的内容项类型 + public static final String NOTE = TextNote.CONTENT_ITEM_TYPE; + // 表示通话笔记的内容项类型 + public static final String CALL_NOTE = CallNote.CONTENT_ITEM_TYPE; + } + + /** + * 用于查询所有笔记和文件夹的 Uri + */ + public static final Uri CONTENT_NOTE_URI = Uri.parse("content://" + AUTHORITY + "/note"); + + /** + * 用于查询数据的 Uri + */ + public static final Uri CONTENT_DATA_URI = Uri.parse("content://" + AUTHORITY + "/data"); + + /** + * NoteColumns 是一个接口,用于定义笔记表的列名常量 + */ + public interface NoteColumns { + /** + * 行的唯一 ID + *

类型: INTEGER (long)

+ */ + public static final String ID = "_id"; + + /** + * 笔记或文件夹的父 ID + *

类型: INTEGER (long)

+ */ + public static final String PARENT_ID = "parent_id"; + + /** + * 笔记或文件夹的创建日期 + *

类型: INTEGER (long)

+ */ + public static final String CREATED_DATE = "created_date"; + + /** + * 最新修改日期 + *

类型: INTEGER (long)

+ */ + public static final String MODIFIED_DATE = "modified_date"; + + /** + * 提醒日期 + *

类型: INTEGER (long)

+ */ + public static final String ALERTED_DATE = "alert_date"; + + /** + * 文件夹名称或笔记的文本内容 + *

类型: TEXT

+ */ + public static final String SNIPPET = "snippet"; + + /** + * 笔记的小部件 ID + *

类型: INTEGER (long)

+ */ + public static final String WIDGET_ID = "widget_id"; + + /** + * 笔记的小部件类型 + *

类型: INTEGER (long)

+ */ + public static final String WIDGET_TYPE = "widget_type"; + + /** + * 笔记的背景颜色 ID + *

类型: INTEGER (long)

+ */ + public static final String BG_COLOR_ID = "bg_color_id"; + + /** + * 对于文本笔记,没有附件;对于多媒体笔记,至少有一个附件 + *

类型: INTEGER

+ */ + public static final String HAS_ATTACHMENT = "has_attachment"; + + /** + * 文件夹中笔记的数量 + *

类型: INTEGER (long)

+ */ + public static final String NOTES_COUNT = "notes_count"; + + /** + * 文件类型:文件夹或笔记 + *

类型: INTEGER

+ */ + public static final String TYPE = "type"; + + /** + * 最后同步的 ID + *

类型: INTEGER (long)

+ */ + public static final String SYNC_ID = "sync_id"; + + /** + * 标识本地是否被修改的标志 + *

类型: INTEGER

+ */ + public static final String LOCAL_MODIFIED = "local_modified"; + + /** + * 移动到临时文件夹之前的原始父 ID + *

类型 : INTEGER

+ */ + public static final String ORIGIN_PARENT_ID = "origin_parent_id"; + + /** + * Gtask ID + *

类型 : TEXT

+ */ + public static final String GTASK_ID = "gtask_id"; + + /** + * 版本代码 + *

类型 : INTEGER (long)

+ */ + public static final String VERSION = "version"; + } + + /** + * DataColumns 是一个接口,用于定义数据表的列名常量 + */ + public interface DataColumns { + /** + * 行的唯一 ID + *

类型: INTEGER (long)

+ */ + public static final String ID = "_id"; + + /** + * 该行所代表项的 MIME 类型 + *

类型: Text

+ */ + public static final String MIME_TYPE = "mime_type"; + + /** + * 该数据所属笔记的引用 ID + *

类型: INTEGER (long)

+ */ + public static final String NOTE_ID = "note_id"; + + /** + * 笔记或文件夹的创建日期 + *

类型: INTEGER (long)

+ */ + public static final String CREATED_DATE = "created_date"; + + /** + * 最新修改日期 + *

类型: INTEGER (long)

+ */ + public static final String MODIFIED_DATE = "modified_date"; + + /** + * 数据的内容 + *

类型: TEXT

+ */ + public static final String CONTENT = "content"; + + /** + * 通用数据列,含义取决于 {@link #MIMETYPE},用于整数类型数据 + *

类型: INTEGER

+ */ + public static final String DATA1 = "data1"; + + /** + * 通用数据列,含义取决于 {@link #MIMETYPE},用于整数类型数据 + *

类型: INTEGER

+ */ + public static final String DATA2 = "data2"; + + /** + * 通用数据列,含义取决于 {@link #MIMETYPE},用于文本类型数据 + *

类型: TEXT

+ */ + public static final String DATA3 = "data3"; + + /** + * 通用数据列,含义取决于 {@link #MIMETYPE},用于文本类型数据 + *

类型: TEXT

+ */ + public static final String DATA4 = "data4"; + + /** + * 通用数据列,含义取决于 {@link #MIMETYPE},用于文本类型数据 + *

类型: TEXT

+ */ + public static final String DATA5 = "data5"; + } + + /** + * TextNote 是一个静态内部类,用于表示文本笔记,实现了 DataColumns 接口 + */ + public static final class TextNote implements DataColumns { + /** + * 表示文本是否处于检查列表模式 + *

类型: Integer 1: 检查列表模式 0: 正常模式

+ */ + 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"); + } + + /** + * CallNote 是一个静态内部类,用于表示通话笔记,实现了 DataColumns 接口 + */ + public static final class CallNote implements DataColumns { + /** + * 该通话记录的通话日期 + *

类型: INTEGER (long)

+ */ + public static final String CALL_DATE = DATA1; + + /** + * 该通话记录的电话号码 + *

类型: 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"); + } +} \ No newline at end of file diff --git a/data/NotesDatabaseHelper.java b/data/NotesDatabaseHelper.java new file mode 100644 index 0000000..6837967 --- /dev/null +++ b/data/NotesDatabaseHelper.java @@ -0,0 +1,477 @@ +/* + * 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. + */ + +// 包声明,表明该类属于 net.micode.notes.data 包 +package net.micode.notes.data; + +// 导入用于存储键值对,通常用于数据库操作中插入数据 +import android.content.ContentValues; +// 导入 Android 上下文类,用于获取应用程序的环境信息 +import android.content.Context; +// 导入 SQLite 数据库操作类,用于对数据库进行读写操作 +import android.database.sqlite.SQLiteDatabase; +// 导入 SQLite 数据库辅助类,用于管理数据库的创建和版本更新 +import android.database.sqlite.SQLiteOpenHelper; +// 导入日志工具类,用于在开发和调试过程中记录信息 +import android.util.Log; + +// 导入 Notes 类中的 DataColumns 接口,用于引用数据列的常量 +import net.micode.notes.data.Notes.DataColumns; +// 导入 Notes 类中的 DataConstants 类,用于引用数据相关的常量 +import net.micode.notes.data.Notes.DataConstants; +// 导入 Notes 类中的 NoteColumns 接口,用于引用笔记列的常量 +import net.micode.notes.data.Notes.NoteColumns; + +/** + * NotesDatabaseHelper 类继承自 SQLiteOpenHelper,用于管理笔记应用的 SQLite 数据库。 + * 它负责创建数据库、表,以及处理数据库版本升级等操作。 + */ +public class NotesDatabaseHelper extends SQLiteOpenHelper { + // 数据库文件名 + private static final String DB_NAME = "note.db"; + // 数据库版本号 + private static final int DB_VERSION = 4; + + /** + * TABLE 接口定义了数据库中表的名称常量 + */ + 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 语句 + private static final String CREATE_DATA_NOTE_ID_INDEX_SQL = + "CREATE INDEX IF NOT EXISTS note_id_index ON " + + TABLE.DATA + "(" + DataColumns.NOTE_ID + ");"; + + /** + * 当笔记移动到文件夹时,增加文件夹的笔记数量的触发器 SQL 语句 + */ + 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"; + + /** + * 当笔记从文件夹移出时,减少文件夹的笔记数量的触发器 SQL 语句 + */ + 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"; + + /** + * 当新笔记插入到文件夹时,增加文件夹的笔记数量的触发器 SQL 语句 + */ + 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"; + + /** + * 当笔记从文件夹删除时,减少文件夹的笔记数量的触发器 SQL 语句 + */ + 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"; + + /** + * 当插入类型为 {@link DataConstants#NOTE} 的数据时,更新笔记内容的触发器 SQL 语句 + */ + 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"; + + /** + * 当类型为 {@link DataConstants#NOTE} 的数据更新时,更新笔记内容的触发器 SQL 语句 + */ + 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"; + + /** + * 当类型为 {@link DataConstants#NOTE} 的数据删除时,更新笔记内容的触发器 SQL 语句 + */ + 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"; + + /** + * 当笔记删除时,删除该笔记关联的数据的触发器 SQL 语句 + */ + 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"; + + /** + * 当文件夹删除时,删除该文件夹下的所有笔记的触发器 SQL 语句 + */ + 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"; + + /** + * 当文件夹移动到回收站时,将该文件夹下的所有笔记也移动到回收站的触发器 SQL 语句 + */ + 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"; + + /** + * 构造函数,用于初始化 NotesDatabaseHelper 实例 + * @param context 应用程序上下文 + */ + public NotesDatabaseHelper(Context context) { + // 调用父类 SQLiteOpenHelper 的构造函数,传入上下文、数据库名、游标工厂和数据库版本号 + super(context, DB_NAME, null, DB_VERSION); + } + + /** + * 创建笔记表,并设置相关触发器和创建系统文件夹 + * @param db SQLite 数据库对象 + */ + 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 SQLite 数据库对象 + */ + 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 SQLite 数据库对象 + */ + private void createSystemFolder(SQLiteDatabase db) { + // 用于存储要插入的数据 + ContentValues values = new ContentValues(); + + /** + * 创建通话记录文件夹 + */ + // 设置文件夹的 ID + values.put(NoteColumns.ID, Notes.ID_CALL_RECORD_FOLDER); + // 设置文件夹的类型为系统文件夹 + values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); + // 插入数据到笔记表 + db.insert(TABLE.NOTE, null, values); + + /** + * 创建根文件夹 + */ + // 清空之前存储的数据 + values.clear(); + values.put(NoteColumns.ID, Notes.ID_ROOT_FOLDER); + values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); + db.insert(TABLE.NOTE, null, values); + + /** + * 创建临时文件夹 + */ + values.clear(); + values.put(NoteColumns.ID, Notes.ID_TEMPARAY_FOLDER); + values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); + db.insert(TABLE.NOTE, null, values); + + /** + * 创建回收站文件夹 + */ + 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 SQLite 数据库对象 + */ + public void createDataTable(SQLiteDatabase db) { + // 执行创建数据表的 SQL 语句 + db.execSQL(CREATE_DATA_TABLE_SQL); + // 重新创建数据表的触发器 + reCreateDataTableTriggers(db); + // 执行创建数据表中 note_id 索引的 SQL 语句 + db.execSQL(CREATE_DATA_NOTE_ID_INDEX_SQL); + // 记录日志,表明数据表已创建 + Log.d(TAG, "data table has been created"); + } + + /** + * 重新创建数据表的触发器 + * @param db SQLite 数据库对象 + */ + 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 SQLite 数据库对象 + */ + @Override + public void onCreate(SQLiteDatabase db) { + // 创建笔记表 + createNoteTable(db); + // 创建数据表 + createDataTable(db); + } + + /** + * 当数据库版本升级时调用,根据旧版本和新版本进行相应的升级操作 + * @param db SQLite 数据库对象 + * @param oldVersion 旧的数据库版本号 + * @param newVersion 新的数据库版本号 + */ + @Override + public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) { + // 标记是否需要重新创建触发器 + boolean reCreateTriggers = false; + // 标记是否跳过从版本 2 到版本 3 的升级 + boolean skipV2 = false; + + // 如果旧版本是 1 + if (oldVersion == 1) { + // 升级到版本 2 + upgradeToV2(db); + // 标记跳过从版本 2 到版本 3 的升级 + skipV2 = true; + // 旧版本号加 1 + oldVersion++; + } + + // 如果旧版本是 2 且不跳过升级 + if (oldVersion == 2 && !skipV2) { + // 升级到版本 3 + upgradeToV3(db); + // 标记需要重新创建触发器 + reCreateTriggers = true; + oldVersion++; + } + + // 如果旧版本是 3 + if (oldVersion == 3) { + // 升级到版本 4 + upgradeToV4(db); + oldVersion++; + } + + // 如果需要重新创建触发器 + if (reCreateTriggers) { + // 重新创建笔记表的触发器 + reCreateNoteTableTriggers(db); + // 重新创建数据表的触发器 + reCreateDataTableTriggers(db); + } + + // 如果旧版本号不等于新版本号,说明升级失败,抛出异常 + if (oldVersion != newVersion) { + throw new IllegalStateException("Upgrade notes database to version " + newVersion + + "fails"); + } + } + + /** + * 将数据库从版本 1 升级到版本 2 + * @param db SQLite 数据库对象 + */ + 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); + } + + /** + * 将数据库从版本 2 升级到版本 3 + * @param db SQLite 数据库对象 + */ + 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"); + // 为笔记表添加 gtask_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); + } + + /** + * 将数据库从版本 3 升级到版本 4 + * @param db SQLite 数据库对象 + */ + private void upgradeToV4(SQLiteDatabase db) { + // 为笔记表添加 version 列 + db.execSQL("ALTER TABLE " + TABLE.NOTE + " ADD COLUMN " + NoteColumns.VERSION + + " INTEGER NOT NULL DEFAULT 0"); + } +} \ No newline at end of file diff --git a/data/NotesProvider.java b/data/NotesProvider.java new file mode 100644 index 0000000..1e13f32 --- /dev/null +++ b/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. + */ + +// 包声明,表明该类属于 net.micode.notes.data 包 +package net.micode.notes.data; + +// 导入 Android 搜索管理相关类,用于处理搜索功能 +import android.app.SearchManager; +// 导入 Android 内容提供者基类,用于与外部应用共享数据 +import android.content.ContentProvider; +// 导入 Android 用于处理 Content URI 并添加 ID 的工具类 +import android.content.ContentUris; +// 导入 Android 用于存储键值对,通常用于数据库操作中插入或更新数据 +import android.content.ContentValues; +// 导入 Android 用于在不同组件间传递消息的类 +import android.content.Intent; +// 导入 Android 用于匹配 URI 的工具类 +import android.content.UriMatcher; +// 导入 Android 数据库游标类,用于处理数据库查询结果 +import android.database.Cursor; +// 导入 Android SQLite 数据库操作类,用于对数据库进行读写操作 +import android.database.sqlite.SQLiteDatabase; +// 导入 Android 用于表示统一资源标识符的类 +import android.net.Uri; +// 导入 Android 用于处理文本相关操作的工具类 +import android.text.TextUtils; +// 导入 Android 日志工具类,用于在开发和调试过程中记录信息 +import android.util.Log; + +// 导入应用资源类,用于引用应用内的资源 +import net.micode.notes.R; +// 导入 Notes 类中的 DataColumns 接口,用于引用数据列的常量 +import net.micode.notes.data.Notes.DataColumns; +// 导入 Notes 类中的 NoteColumns 接口,用于引用笔记列的常量 +import net.micode.notes.data.Notes.NoteColumns; +// 导入 NotesDatabaseHelper 类中的 TABLE 接口,用于引用数据库表名常量 +import net.micode.notes.data.NotesDatabaseHelper.TABLE; + +/** + * NotesProvider 类继承自 ContentProvider,用于提供对笔记数据的增删改查操作。 + * 它作为数据的提供者,允许其他应用通过 ContentResolver 访问笔记数据。 + */ +public class NotesProvider extends ContentProvider { + // 用于匹配 URI 的对象 + private static final UriMatcher mMatcher; + // 数据库帮助类的实例 + private NotesDatabaseHelper mHelper; + // 日志标签,用于在日志中标识该类的信息 + private static final String TAG = "NotesProvider"; + // 定义不同 URI 匹配结果的常量 + private static final int URI_NOTE = 1; + private static final int URI_NOTE_ITEM = 2; + private static final int URI_DATA = 3; + private static final int URI_DATA_ITEM = 4; + private static final int URI_SEARCH = 5; + private static final int URI_SEARCH_SUGGEST = 6; + + // 静态代码块,在类加载时初始化 UriMatcher + static { + // 创建一个 UriMatcher 实例,初始匹配值为 NO_MATCH + 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; + + /** + * 当 ContentProvider 创建时调用,初始化数据库帮助类 + * @return 若创建成功返回 true,否则返回 false + */ + @Override + public boolean onCreate() { + // 获取 NotesDatabaseHelper 的单例实例 + mHelper = NotesDatabaseHelper.getInstance(getContext()); + return true; + } + + /** + * 根据给定的 URI 进行查询操作 + * @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(); + // 用于存储从 URI 中提取的 ID + 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: + // 从 URI 中提取笔记 ID + id = uri.getPathSegments().get(1); + // 根据笔记 ID 查询笔记表 + 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: + // 从 URI 中提取数据 ID + id = uri.getPathSegments().get(1); + // 根据数据 ID 查询数据表 + 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) { + // 从 URI 中提取搜索字符串 + 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: + // 未知 URI 抛出异常 + throw new IllegalArgumentException("Unknown URI " + uri); + } + // 如果游标不为空,设置通知 URI + if (c != null) { + c.setNotificationUri(getContext().getContentResolver(), uri); + } + return c; + } + + /** + * 向指定 URI 插入数据 + * @param uri 插入数据的 URI + * @param values 要插入的数据 + * @return 插入数据后的 URI + */ + @Override + public Uri insert(Uri uri, ContentValues values) { + // 获取可写的数据库实例 + SQLiteDatabase db = mHelper.getWritableDatabase(); + // 初始化数据 ID、笔记 ID 和插入的 ID + 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)) { + // 获取数据所属的笔记 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: + // 未知 URI 抛出异常 + 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); + } + // 返回插入数据后的 URI + return ContentUris.withAppendedId(uri, insertedId); + } + + /** + * 根据给定的 URI 删除数据 + * @param uri 要删除数据的 URI + * @param selection 删除条件 + * @param selectionArgs 删除条件的参数 + * @return 删除的行数 + */ + @Override + public int delete(Uri uri, String selection, String[] selectionArgs) { + // 初始化删除的行数 + int count = 0; + // 用于存储从 URI 中提取的 ID + String id = null; + // 获取可写的数据库实例 + SQLiteDatabase db = mHelper.getWritableDatabase(); + // 标记是否删除数据 + boolean deleteData = false; + // 根据 URI 匹配结果执行不同的删除操作 + switch (mMatcher.match(uri)) { + case URI_NOTE: + // 确保删除的笔记 ID 大于 0 + selection = "(" + selection + ") AND " + NoteColumns.ID + ">0 "; + // 删除笔记数据 + count = db.delete(TABLE.NOTE, selection, selectionArgs); + break; + case URI_NOTE_ITEM: + // 从 URI 中提取笔记 ID + id = uri.getPathSegments().get(1); + /** + * ID 小于 0 的是系统文件夹,不允许删除 + */ + long noteId = Long.valueOf(id); + if (noteId <= 0) { + break; + } + // 根据笔记 ID 删除笔记数据 + 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: + // 从 URI 中提取数据 ID + id = uri.getPathSegments().get(1); + // 根据数据 ID 删除数据 + count = db.delete(TABLE.DATA, + DataColumns.ID + "=" + id + parseSelection(selection), selectionArgs); + deleteData = true; + break; + default: + // 未知 URI 抛出异常 + throw new IllegalArgumentException("Unknown URI " + uri); + } + // 如果删除行数大于 0,通知数据已更改 + if (count > 0) { + if (deleteData) { + getContext().getContentResolver().notifyChange(Notes.CONTENT_NOTE_URI, null); + } + getContext().getContentResolver().notifyChange(uri, null); + } + return count; + } + + /** + * 根据给定的 URI 更新数据 + * @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; + // 用于存储从 URI 中提取的 ID + 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: + // 从 URI 中提取笔记 ID + id = uri.getPathSegments().get(1); + // 增加笔记版本号 + increaseNoteVersion(Long.valueOf(id), selection, selectionArgs); + // 根据笔记 ID 更新笔记数据 + 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: + // 从 URI 中提取数据 ID + id = uri.getPathSegments().get(1); + // 根据数据 ID 更新数据 + count = db.update(TABLE.DATA, values, DataColumns.ID + "=" + id + + parseSelection(selection), selectionArgs); + updateData = true; + break; + default: + // 未知 URI 抛出异常 + throw new IllegalArgumentException("Unknown URI " + uri); + } + // 如果更新行数大于 0,通知数据已更改 + if (count > 0) { + if (updateData) { + getContext().getContentResolver().notifyChange(Notes.CONTENT_NOTE_URI, null); + } + getContext().getContentResolver().notifyChange(uri, null); + } + return count; + } + + /** + * 解析查询条件,添加 AND 连接符 + * @param selection 查询条件 + * @return 解析后的查询条件 + */ + private String parseSelection(String selection) { + return (!TextUtils.isEmpty(selection) ? " AND (" + selection + ')' : ""); + } + + /** + * 增加笔记的版本号 + * @param id 笔记 ID + * @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 "); + 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()); + } + + /** + * 获取给定 URI 的 MIME 类型,当前方法未实现,返回 null + * @param uri 要查询 MIME 类型的 URI + * @return MIME 类型字符串 + */ + @Override + public String getType(Uri uri) { + // TODO Auto-generated method stub + return null; + } + +} \ No newline at end of file diff --git a/doc/~$_小米便签开源代码阅读-精读报告_刘相沅.docx b/doc/~$_小米便签开源代码阅读-精读报告_刘相沅.docx new file mode 100644 index 0000000..829055d Binary files /dev/null and b/doc/~$_小米便签开源代码阅读-精读报告_刘相沅.docx differ diff --git a/widget/NoteWidgetProvider.java b/widget/NoteWidgetProvider.java new file mode 100644 index 0000000..86b81a9 --- /dev/null +++ b/widget/NoteWidgetProvider.java @@ -0,0 +1,225 @@ +/* + * 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. + */ + +// 包声明,表明该类属于 net.micode.notes.widget 包 +package net.micode.notes.widget; + +// 导入用于创建待定意图的类,用于在未来某个时刻执行操作 +import android.app.PendingIntent; +// 导入应用小部件管理器类,用于管理和更新应用小部件 +import android.appwidget.AppWidgetManager; +// 导入应用小部件提供者基类,用于处理小部件的各种事件 +import android.appwidget.AppWidgetProvider; +// 导入用于存储键值对,通常用于数据库操作中插入或更新数据 +import android.content.ContentValues; +// 导入 Android 上下文类,用于获取应用程序的环境信息 +import android.content.Context; +// 导入 Android 用于在不同组件间传递消息的类 +import android.content.Intent; +// 导入 Android 数据库游标类,用于处理数据库查询结果 +import android.database.Cursor; +// 导入 Android 日志工具类,用于在开发和调试过程中记录信息 +import android.util.Log; +// 导入用于更新远程视图的类,可用于更新应用小部件的视图 +import android.widget.RemoteViews; + +// 导入应用资源类,用于引用应用内的资源 +import net.micode.notes.R; +// 导入 Notes 类,用于引用笔记相关的常量和信息 +import net.micode.notes.data.Notes; +// 导入 Notes 类中的 NoteColumns 接口,用于引用笔记列的常量 +import net.micode.notes.data.Notes.NoteColumns; +// 导入资源解析工具类,用于解析资源 +import net.micode.notes.tool.ResourceParser; +// 导入笔记编辑活动类,用于编辑笔记 +import net.micode.notes.ui.NoteEditActivity; +// 导入笔记列表活动类,用于显示笔记列表 +import net.micode.notes.ui.NotesListActivity; + +/** + * NoteWidgetProvider 类继承自 AppWidgetProvider,是一个抽象类,用于处理笔记应用小部件的相关操作。 + * 它提供了小部件删除、更新等操作的实现,并定义了一些抽象方法,由具体的子类实现。 + */ +public abstract class NoteWidgetProvider extends AppWidgetProvider { + // 定义查询笔记信息时需要的列 + public static final String [] PROJECTION = new String [] { + NoteColumns.ID, + NoteColumns.BG_COLOR_ID, + NoteColumns.SNIPPET + }; + // 定义投影数组中各列的索引 + public static final int COLUMN_ID = 0; + public static final int COLUMN_BG_COLOR_ID = 1; + public static final int COLUMN_SNIPPET = 2; + // 日志标签,用于在日志中标识该类的信息 + private static final String TAG = "NoteWidgetProvider"; + + /** + * 当小部件被删除时调用,将对应笔记的小部件 ID 置为无效 + * @param context 应用程序上下文 + * @param appWidgetIds 被删除的小部件 ID 数组 + */ + @Override + public void onDeleted(Context context, int[] appWidgetIds) { + // 用于存储要更新的数据 + ContentValues values = new ContentValues(); + // 将笔记的小部件 ID 置为无效 + values.put(NoteColumns.WIDGET_ID, AppWidgetManager.INVALID_APPWIDGET_ID); + // 遍历被删除的小部件 ID 数组 + for (int i = 0; i < appWidgetIds.length; i++) { + // 更新笔记数据,将对应小部件 ID 的笔记的小部件 ID 置为无效 + context.getContentResolver().update(Notes.CONTENT_NOTE_URI, + values, + NoteColumns.WIDGET_ID + "=?", + new String[] { String.valueOf(appWidgetIds[i])}); + } + } + + /** + * 获取指定小部件 ID 对应的笔记信息 + * @param context 应用程序上下文 + * @param widgetId 小部件 ID + * @return 包含笔记信息的游标 + */ + private Cursor getNoteWidgetInfo(Context context, int widgetId) { + // 查询笔记信息,排除回收站中的笔记 + return context.getContentResolver().query(Notes.CONTENT_NOTE_URI, + PROJECTION, + NoteColumns.WIDGET_ID + "=? AND " + NoteColumns.PARENT_ID + "<>?", + new String[] { String.valueOf(widgetId), String.valueOf(Notes.ID_TRASH_FOLER) }, + null); + } + + /** + * 更新小部件,默认不开启隐私模式 + * @param context 应用程序上下文 + * @param appWidgetManager 应用小部件管理器 + * @param appWidgetIds 要更新的小部件 ID 数组 + */ + protected void update(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) { + update(context, appWidgetManager, appWidgetIds, false); + } + + /** + * 更新小部件,可选择是否开启隐私模式 + * @param context 应用程序上下文 + * @param appWidgetManager 应用小部件管理器 + * @param appWidgetIds 要更新的小部件 ID 数组 + * @param privacyMode 是否开启隐私模式 + */ + private void update(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds, + boolean privacyMode) { + // 遍历要更新的小部件 ID 数组 + for (int i = 0; i < appWidgetIds.length; i++) { + // 检查小部件 ID 是否有效 + if (appWidgetIds[i] != AppWidgetManager.INVALID_APPWIDGET_ID) { + // 获取默认背景 ID + int bgId = ResourceParser.getDefaultBgId(context); + // 初始化笔记摘要 + String snippet = ""; + // 创建启动笔记编辑活动的意图 + Intent intent = new Intent(context, NoteEditActivity.class); + // 设置意图标志,确保活动以单顶模式启动 + intent.setFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP); + // 传递小部件 ID 到意图中 + intent.putExtra(Notes.INTENT_EXTRA_WIDGET_ID, appWidgetIds[i]); + // 传递小部件类型到意图中 + intent.putExtra(Notes.INTENT_EXTRA_WIDGET_TYPE, getWidgetType()); + + // 获取指定小部件 ID 对应的笔记信息 + Cursor c = getNoteWidgetInfo(context, appWidgetIds[i]); + if (c != null && c.moveToFirst()) { + // 检查是否存在多个具有相同小部件 ID 的笔记 + if (c.getCount() > 1) { + // 记录错误信息 + Log.e(TAG, "Multiple message with same widget id:" + appWidgetIds[i]); + // 关闭游标 + c.close(); + return; + } + // 获取笔记摘要 + snippet = c.getString(COLUMN_SNIPPET); + // 获取背景 ID + bgId = c.getInt(COLUMN_BG_COLOR_ID); + // 传递笔记 ID 到意图中 + intent.putExtra(Intent.EXTRA_UID, c.getLong(COLUMN_ID)); + // 设置意图动作为查看 + intent.setAction(Intent.ACTION_VIEW); + } else { + // 如果没有找到笔记信息,显示提示信息 + snippet = context.getResources().getString(R.string.widget_havenot_content); + // 设置意图动作为插入或编辑 + intent.setAction(Intent.ACTION_INSERT_OR_EDIT); + } + + // 关闭游标 + if (c != null) { + c.close(); + } + + // 创建远程视图,用于更新小部件的视图 + RemoteViews rv = new RemoteViews(context.getPackageName(), getLayoutId()); + // 设置小部件的背景图片资源 + rv.setImageViewResource(R.id.widget_bg_image, getBgResourceId(bgId)); + // 传递背景 ID 到意图中 + intent.putExtra(Notes.INTENT_EXTRA_BACKGROUND_ID, bgId); + + /** + * 生成用于启动小部件宿主的待定意图 + */ + PendingIntent pendingIntent = null; + if (privacyMode) { + // 在隐私模式下,显示提示信息 + rv.setTextViewText(R.id.widget_text, + context.getString(R.string.widget_under_visit_mode)); + // 创建启动笔记列表活动的待定意图 + pendingIntent = PendingIntent.getActivity(context, appWidgetIds[i], new Intent( + context, NotesListActivity.class), PendingIntent.FLAG_UPDATE_CURRENT); + } else { + // 在非隐私模式下,显示笔记摘要 + rv.setTextViewText(R.id.widget_text, snippet); + // 创建启动笔记编辑活动的待定意图 + pendingIntent = PendingIntent.getActivity(context, appWidgetIds[i], intent, + PendingIntent.FLAG_UPDATE_CURRENT); + } + + // 设置小部件文本视图的点击事件 + rv.setOnClickPendingIntent(R.id.widget_text, pendingIntent); + // 更新指定小部件的视图 + appWidgetManager.updateAppWidget(appWidgetIds[i], rv); + } + } + } + + /** + * 根据背景 ID 获取对应的背景资源 ID,由子类实现 + * @param bgId 背景 ID + * @return 背景资源 ID + */ + protected abstract int getBgResourceId(int bgId); + + /** + * 获取小部件的布局 ID,由子类实现 + * @return 布局 ID + */ + protected abstract int getLayoutId(); + + /** + * 获取小部件的类型,由子类实现 + * @return 小部件类型 + */ + protected abstract int getWidgetType(); +} \ No newline at end of file diff --git a/widget/NoteWidgetProvider_2x.java b/widget/NoteWidgetProvider_2x.java new file mode 100644 index 0000000..e58429a --- /dev/null +++ b/widget/NoteWidgetProvider_2x.java @@ -0,0 +1,76 @@ +/* + * 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. + */ + +// 包声明,表明该类属于 net.micode.notes.widget 包 +package net.micode.notes.widget; + +// 导入应用小部件管理器类,用于管理和更新应用小部件 +import android.appwidget.AppWidgetManager; +// 导入 Android 上下文类,用于获取应用程序的环境信息 +import android.content.Context; + +// 导入应用资源类,用于引用应用内的资源 +import net.micode.notes.R; +// 导入 Notes 类,用于引用笔记相关的常量和信息 +import net.micode.notes.data.Notes; +// 导入资源解析工具类,用于解析资源 +import net.micode.notes.tool.ResourceParser; + +/** + * NoteWidgetProvider_2x 类继承自 NoteWidgetProvider,是一个具体的应用小部件提供者类, + * 用于处理 2x 尺寸的笔记应用小部件的相关操作。 + */ +public class NoteWidgetProvider_2x extends NoteWidgetProvider { + /** + * 当小部件更新时调用,调用父类的 update 方法进行更新操作 + * @param context 应用程序上下文 + * @param appWidgetManager 应用小部件管理器 + * @param appWidgetIds 要更新的小部件 ID 数组 + */ + @Override + public void onUpdate(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) { + // 调用父类的 update 方法更新小部件 + super.update(context, appWidgetManager, appWidgetIds); + } + + /** + * 获取 2x 小部件的布局 ID + * @return 布局 ID,这里返回 R.layout.widget_2x + */ + @Override + protected int getLayoutId() { + return R.layout.widget_2x; + } + + /** + * 根据背景 ID 获取 2x 小部件对应的背景资源 ID + * @param bgId 背景 ID + * @return 背景资源 ID,通过 ResourceParser.WidgetBgResources 类的 getWidget2xBgResource 方法获取 + */ + @Override + protected int getBgResourceId(int bgId) { + return ResourceParser.WidgetBgResources.getWidget2xBgResource(bgId); + } + + /** + * 获取 2x 小部件的类型 + * @return 小部件类型,这里返回 Notes.TYPE_WIDGET_2X + */ + @Override + protected int getWidgetType() { + return Notes.TYPE_WIDGET_2X; + } +} \ No newline at end of file diff --git a/widget/NoteWidgetProvider_4x.java b/widget/NoteWidgetProvider_4x.java new file mode 100644 index 0000000..2ac112d --- /dev/null +++ b/widget/NoteWidgetProvider_4x.java @@ -0,0 +1,78 @@ +/* + * 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.widget; + +// 导入 AppWidgetManager 类,用于管理和更新应用小部件 +import android.appwidget.AppWidgetManager; +// 导入 Context 类,提供应用程序的全局信息和资源访问 +import android.content.Context; + +// 导入应用的资源类,用于访问应用的资源,如布局、字符串等 +import net.micode.notes.R; +// 导入 Notes 类,包含笔记相关的常量和定义 +import net.micode.notes.data.Notes; +// 导入 ResourceParser 类,用于解析资源 +import net.micode.notes.tool.ResourceParser; + +/** + * NoteWidgetProvider_4x 类继承自 NoteWidgetProvider,用于处理 4x 尺寸的笔记应用小部件的更新和相关操作。 + */ +public class NoteWidgetProvider_4x extends NoteWidgetProvider { + /** + * 当小部件需要更新时,系统会调用此方法。 + * + * @param context 应用程序的上下文对象,可用于访问系统服务和资源。 + * @param appWidgetManager 应用小部件管理器,用于管理和更新应用小部件。 + * @param appWidgetIds 要更新的小部件的 ID 数组。 + */ + @Override + public void onUpdate(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) { + // 调用父类的 update 方法来执行实际的小部件更新操作 + super.update(context, appWidgetManager, appWidgetIds); + } + + /** + * 获取 4x 尺寸小部件的布局资源 ID。 + * + * @return 返回 4x 小部件的布局资源 ID,即 R.layout.widget_4x。 + */ + protected int getLayoutId() { + return R.layout.widget_4x; + } + + /** + * 根据给定的背景 ID 获取对应的 4x 小部件背景资源 ID。 + * + * @param bgId 背景的 ID,用于确定具体的背景样式。 + * @return 返回对应背景 ID 的 4x 小部件背景资源 ID。 + */ + @Override + protected int getBgResourceId(int bgId) { + return ResourceParser.WidgetBgResources.getWidget4xBgResource(bgId); + } + + /** + * 获取 4x 尺寸小部件的类型。 + * + * @return 返回 4x 小部件的类型常量,即 Notes.TYPE_WIDGET_4X。 + */ + @Override + protected int getWidgetType() { + return Notes.TYPE_WIDGET_4X; + } +} \ No newline at end of file