From 4d2dc62750dad5ce92b921b584ca4931a75e5899 Mon Sep 17 00:00:00 2001
From: 19972076849 <3504229115@qq.com>
Date: Tue, 6 May 2025 00:02:29 +0800
Subject: [PATCH] =?UTF-8?q?=E4=BB=A3=E7=A0=81=E6=B3=A8=E9=87=8A=E4=BB=A5?=
=?UTF-8?q?=E5=8F=8A=E6=96=87=E6=A1=A3=E6=9B=B4=E6=96=B0?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
doc/代码质量分析报告.txt | 11 +-
.../java/net/micode/notes/data/Notes.java | 25 +-
.../notes/data/NotesDatabaseHelper.java | 445 ++++++++++++------
.../net/micode/notes/data/NotesProvider.java | 158 ++++++-
.../net/micode/notes/gtask/data/MetaData.java | 68 ++-
.../net/micode/notes/gtask/data/Node.java | 118 ++++-
.../net/micode/notes/gtask/data/SqlData.java | 134 +++++-
.../net/micode/notes/gtask/data/SqlNote.java | 260 ++++++++--
.../net/micode/notes/gtask/data/Task.java | 230 +++++++--
.../net/micode/notes/gtask/data/TaskList.java | 225 +++++++--
.../notes/gtask/remote/GTaskASyncTask.java | 98 ++--
.../notes/gtask/remote/GTaskClient.java | 216 +++++++--
.../notes/gtask/remote/GTaskSyncService.java | 123 ++++-
13 files changed, 1682 insertions(+), 429 deletions(-)
diff --git a/doc/代码质量分析报告.txt b/doc/代码质量分析报告.txt
index c7d6d82..267c1b9 100644
--- a/doc/代码质量分析报告.txt
+++ b/doc/代码质量分析报告.txt
@@ -4,5 +4,14 @@
2025.4.2
对原始小米便签代码进行环境搭载，使用了gradle-8.10.2版本的构建工具。在 Android Studio 中，Gradle 是一个强大的构建工具。它是一种基于 Groovy（一种运行在 Java 虚拟机上的语言）或 Kotlin DSL（领域特定语言）的构建自动化系统。它的主要作用是将代码、资源文件等项目组件进行编译、打包等操作，最终生成可安装的 APK（Android 应用程序包）文件。并且能够在Medium Phone API 35的虚拟机上面成功运行小米便签。
+2025.4.3
+ 对于原始的小米便签项目，进行了网络库的导入以及switch的修改，一系列的bug修复使得小米便签能够正常运行功能。
+
2025.4.12
- 对于小米便签Data文件夹前两个文件Contact.java和Notes.java进行了详细的注释
+ 对于小米便签Data文件夹前两个文件Contact.java和Notes.java进行了详细的注释。
+
+2025.5.1
+ 将小米便签的data和gtask文件夹所有的代码进行了详细的注释。
+
+2025.5.5
+ 准备更新功能后写质量分析等文档。
diff --git a/src/Notesmaster/app/src/main/java/net/micode/notes/data/Notes.java b/src/Notesmaster/app/src/main/java/net/micode/notes/data/Notes.java
index 87ee7a7..fceeb19 100644
--- a/src/Notesmaster/app/src/main/java/net/micode/notes/data/Notes.java
+++ b/src/Notesmaster/app/src/main/java/net/micode/notes/data/Notes.java
@@ -236,34 +236,19 @@ public class Notes {
*/
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";
}
diff --git a/src/Notesmaster/app/src/main/java/net/micode/notes/data/NotesDatabaseHelper.java b/src/Notesmaster/app/src/main/java/net/micode/notes/data/NotesDatabaseHelper.java
index ffe5d57..04f0f7c 100644
--- a/src/Notesmaster/app/src/main/java/net/micode/notes/data/NotesDatabaseHelper.java
+++ b/src/Notesmaster/app/src/main/java/net/micode/notes/data/NotesDatabaseHelper.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net)
+ * 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.
@@ -14,210 +14,290 @@
* limitations under the License.
*/
+// 导入包声明，指定该类所在的包为 net.micode.notes.data
package net.micode.notes.data;
+// 导入 Android 系统中用于存储键值对的 ContentValues 类
import android.content.ContentValues;
+// 导入 Android 系统中代表应用程序上下文的 Context 类
import android.content.Context;
+// 导入 Android 系统中用于操作 SQLite 数据库的 SQLiteDatabase 类
import android.database.sqlite.SQLiteDatabase;
+// 导入 Android 系统中用于创建和管理 SQLite 数据库的辅助类 SQLiteOpenHelper
import android.database.sqlite.SQLiteOpenHelper;
+// 导入 Android 系统中用于日志记录的 Log 类
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 {
+ // 定义数据库的名称为 note.db
private static final String DB_NAME = "note.db";
-
+ // 定义数据库的版本号为 4
private static final int DB_VERSION = 4;
+ /**
+ * TABLE 接口定义了数据库中表的名称常量。
+ */
public interface TABLE {
+ // 定义笔记表的名称为 note
public static final String NOTE = "note";
-
+ // 定义数据表的名称为 data
public static final String DATA = "data";
}
+ // 定义日志标签，用于在 Log 中标识该类的日志信息
private static final String TAG = "NotesDatabaseHelper";
-
+ // 定义一个静态的 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" +
- ")";
-
+ "CREATE TABLE " + TABLE.NOTE + "(" +
+ // 定义笔记的 ID 列，作为主键，类型为整数
+ NoteColumns.ID + " INTEGER PRIMARY KEY," +
+ // 定义笔记的父 ID 列，类型为整数，不可为空，默认值为 0
+ NoteColumns.PARENT_ID + " INTEGER NOT NULL DEFAULT 0," +
+ // 定义笔记的提醒日期列，类型为整数，不可为空，默认值为 0
+ NoteColumns.ALERTED_DATE + " INTEGER NOT NULL DEFAULT 0," +
+ // 定义笔记的背景颜色 ID 列，类型为整数，不可为空，默认值为 0
+ NoteColumns.BG_COLOR_ID + " INTEGER NOT NULL DEFAULT 0," +
+ // 定义笔记的创建日期列，类型为整数，不可为空，默认值为当前时间戳
+ NoteColumns.CREATED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," +
+ // 定义笔记是否有附件列，类型为整数，不可为空，默认值为 0
+ NoteColumns.HAS_ATTACHMENT + " INTEGER NOT NULL DEFAULT 0," +
+ // 定义笔记的修改日期列，类型为整数，不可为空，默认值为当前时间戳
+ NoteColumns.MODIFIED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," +
+ // 定义笔记的数量列，类型为整数，不可为空，默认值为 0
+ NoteColumns.NOTES_COUNT + " INTEGER NOT NULL DEFAULT 0," +
+ // 定义笔记的摘要列，类型为文本，不可为空，默认值为空字符串
+ NoteColumns.SNIPPET + " TEXT NOT NULL DEFAULT ''," +
+ // 定义笔记的类型列，类型为整数，不可为空，默认值为 0
+ NoteColumns.TYPE + " INTEGER NOT NULL DEFAULT 0," +
+ // 定义笔记的小部件 ID 列，类型为整数，不可为空，默认值为 0
+ NoteColumns.WIDGET_ID + " INTEGER NOT NULL DEFAULT 0," +
+ // 定义笔记的小部件类型列，类型为整数，不可为空，默认值为 -1
+ NoteColumns.WIDGET_TYPE + " INTEGER NOT NULL DEFAULT -1," +
+ // 定义笔记的同步 ID 列，类型为整数，不可为空，默认值为 0
+ NoteColumns.SYNC_ID + " INTEGER NOT NULL DEFAULT 0," +
+ // 定义笔记的本地修改标记列，类型为整数，不可为空，默认值为 0
+ NoteColumns.LOCAL_MODIFIED + " INTEGER NOT NULL DEFAULT 0," +
+ // 定义笔记的原始父 ID 列，类型为整数，不可为空，默认值为 0
+ NoteColumns.ORIGIN_PARENT_ID + " INTEGER NOT NULL DEFAULT 0," +
+ // 定义笔记的 Google 任务 ID 列，类型为文本，不可为空，默认值为空字符串
+ NoteColumns.GTASK_ID + " TEXT NOT NULL DEFAULT ''," +
+ // 定义笔记的版本列，类型为整数，不可为空，默认值为 0
+ 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 ''" +
- ")";
-
+ "CREATE TABLE " + TABLE.DATA + "(" +
+ // 定义数据的 ID 列，作为主键，类型为整数
+ DataColumns.ID + " INTEGER PRIMARY KEY," +
+ // 定义数据的 MIME 类型列，类型为文本，不可为空
+ DataColumns.MIME_TYPE + " TEXT NOT NULL," +
+ // 定义数据所属笔记的 ID 列，类型为整数，不可为空，默认值为 0
+ 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 ''" +
+ ")";
+
+ // 定义在数据表上创建笔记 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 + ");";
+ "CREATE INDEX IF NOT EXISTS note_id_index ON " +
+ TABLE.DATA + "(" + DataColumns.NOTE_ID + ");";
/**
- * Increase folder's note count when move note to the folder
+ * 定义一个触发器，当更新笔记的父 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";
+ "CREATE TRIGGER increase_folder_count_on_update " +
+ " AFTER UPDATE OF " + NoteColumns.PARENT_ID + " ON " + TABLE.NOTE +
+ " BEGIN " +
+ // 更新目标文件夹的笔记数量，使其加 1
+ " UPDATE " + TABLE.NOTE +
+ " SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + " + 1" +
+ " WHERE " + NoteColumns.ID + "=new." + NoteColumns.PARENT_ID + ";" +
+ " END";
/**
- * Decrease folder's note count when move note from folder
+ * 定义一个触发器，当更新笔记的父 ID 时，减少原文件夹的笔记数量。
*/
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";
+ "CREATE TRIGGER decrease_folder_count_on_update " +
+ " AFTER UPDATE OF " + NoteColumns.PARENT_ID + " ON " + TABLE.NOTE +
+ " BEGIN " +
+ // 更新原文件夹的笔记数量，使其减 1，但前提是数量大于 0
+ " UPDATE " + TABLE.NOTE +
+ " SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + "-1" +
+ " WHERE " + NoteColumns.ID + "=old." + NoteColumns.PARENT_ID +
+ " AND " + NoteColumns.NOTES_COUNT + ">0" + ";" +
+ " END";
/**
- * Increase folder's note count when insert new note to the folder
+ * 定义一个触发器，当插入新笔记时，增加目标文件夹的笔记数量。
*/
private static final String NOTE_INCREASE_FOLDER_COUNT_ON_INSERT_TRIGGER =
- "CREATE TRIGGER increase_folder_count_on_insert " +
- " AFTER INSERT ON " + TABLE.NOTE +
- " BEGIN " +
- " UPDATE " + TABLE.NOTE +
- " SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + " + 1" +
- " WHERE " + NoteColumns.ID + "=new." + NoteColumns.PARENT_ID + ";" +
- " END";
+ "CREATE TRIGGER increase_folder_count_on_insert " +
+ " AFTER INSERT ON " + TABLE.NOTE +
+ " BEGIN " +
+ // 更新目标文件夹的笔记数量，使其加 1
+ " UPDATE " + TABLE.NOTE +
+ " SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + " + 1" +
+ " WHERE " + NoteColumns.ID + "=new." + NoteColumns.PARENT_ID + ";" +
+ " END";
/**
- * Decrease folder's note count when delete note from the folder
+ * 定义一个触发器，当删除笔记时，减少原文件夹的笔记数量。
*/
private static final String NOTE_DECREASE_FOLDER_COUNT_ON_DELETE_TRIGGER =
- "CREATE TRIGGER decrease_folder_count_on_delete " +
- " AFTER DELETE ON " + TABLE.NOTE +
- " BEGIN " +
- " UPDATE " + TABLE.NOTE +
- " SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + "-1" +
- " WHERE " + NoteColumns.ID + "=old." + NoteColumns.PARENT_ID +
- " AND " + NoteColumns.NOTES_COUNT + ">0;" +
- " END";
+ "CREATE TRIGGER decrease_folder_count_on_delete " +
+ " AFTER DELETE ON " + TABLE.NOTE +
+ " BEGIN " +
+ // 更新原文件夹的笔记数量，使其减 1，但前提是数量大于 0
+ " UPDATE " + TABLE.NOTE +
+ " SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + "-1" +
+ " WHERE " + NoteColumns.ID + "=old." + NoteColumns.PARENT_ID +
+ " AND " + NoteColumns.NOTES_COUNT + ">0;" +
+ " END";
/**
- * Update note's content when insert data with type {@link DataConstants#NOTE}
+ * 定义一个触发器，当插入类型为 {@link DataConstants#NOTE} 的数据时，更新笔记的摘要。
*/
private static final String DATA_UPDATE_NOTE_CONTENT_ON_INSERT_TRIGGER =
- "CREATE TRIGGER update_note_content_on_insert " +
- " AFTER INSERT ON " + TABLE.DATA +
- " WHEN new." + DataColumns.MIME_TYPE + "='" + DataConstants.NOTE + "'" +
- " BEGIN" +
- " UPDATE " + TABLE.NOTE +
- " SET " + NoteColumns.SNIPPET + "=new." + DataColumns.CONTENT +
- " WHERE " + NoteColumns.ID + "=new." + DataColumns.NOTE_ID + ";" +
- " END";
+ "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";
/**
- * Update note's content when data with {@link DataConstants#NOTE} type has changed
+ * 定义一个触发器，当更新类型为 {@link DataConstants#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";
+ "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";
/**
- * Update note's content when data with {@link DataConstants#NOTE} type has deleted
+ * 定义一个触发器，当删除类型为 {@link DataConstants#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";
+ "CREATE TRIGGER update_note_content_on_delete " +
+ " AFTER delete ON " + TABLE.DATA +
+ " WHEN old." + DataColumns.MIME_TYPE + "='" + DataConstants.NOTE + "'" +
+ " BEGIN" +
+ // 清空笔记的摘要
+ " UPDATE " + TABLE.NOTE +
+ " SET " + NoteColumns.SNIPPET + "=''" +
+ " WHERE " + NoteColumns.ID + "=old." + DataColumns.NOTE_ID + ";" +
+ " END";
/**
- * Delete datas belong to note which has been deleted
+ * 定义一个触发器，当删除笔记时，删除该笔记相关的数据。
*/
private static final String NOTE_DELETE_DATA_ON_DELETE_TRIGGER =
- "CREATE TRIGGER delete_data_on_delete " +
- " AFTER DELETE ON " + TABLE.NOTE +
- " BEGIN" +
- " DELETE FROM " + TABLE.DATA +
- " WHERE " + DataColumns.NOTE_ID + "=old." + NoteColumns.ID + ";" +
- " END";
+ "CREATE TRIGGER delete_data_on_delete " +
+ " AFTER DELETE ON " + TABLE.NOTE +
+ " BEGIN" +
+ // 删除与被删除笔记 ID 相同的数据
+ " DELETE FROM " + TABLE.DATA +
+ " WHERE " + DataColumns.NOTE_ID + "=old." + NoteColumns.ID + ";" +
+ " END";
/**
- * Delete notes belong to folder which has been deleted
+ * 定义一个触发器，当删除文件夹时，删除该文件夹下的所有笔记。
*/
private static final String FOLDER_DELETE_NOTES_ON_DELETE_TRIGGER =
- "CREATE TRIGGER folder_delete_notes_on_delete " +
- " AFTER DELETE ON " + TABLE.NOTE +
- " BEGIN" +
- " DELETE FROM " + TABLE.NOTE +
- " WHERE " + NoteColumns.PARENT_ID + "=old." + NoteColumns.ID + ";" +
- " END";
+ "CREATE TRIGGER folder_delete_notes_on_delete " +
+ " AFTER DELETE ON " + TABLE.NOTE +
+ " BEGIN" +
+ // 删除父 ID 等于被删除文件夹 ID 的所有笔记
+ " DELETE FROM " + TABLE.NOTE +
+ " WHERE " + NoteColumns.PARENT_ID + "=old." + NoteColumns.ID + ";" +
+ " END";
/**
- * Move notes belong to folder which has been moved to trash folder
+ * 定义一个触发器，当文件夹被移动到回收站时，将该文件夹下的所有笔记也移动到回收站。
*/
private static final String FOLDER_MOVE_NOTES_ON_TRASH_TRIGGER =
- "CREATE TRIGGER folder_move_notes_on_trash " +
- " AFTER UPDATE ON " + TABLE.NOTE +
- " WHEN new." + NoteColumns.PARENT_ID + "=" + Notes.ID_TRASH_FOLER +
- " BEGIN" +
- " UPDATE " + TABLE.NOTE +
- " SET " + NoteColumns.PARENT_ID + "=" + Notes.ID_TRASH_FOLER +
- " WHERE " + NoteColumns.PARENT_ID + "=old." + NoteColumns.ID + ";" +
- " END";
+ "CREATE TRIGGER folder_move_notes_on_trash " +
+ " AFTER UPDATE ON " + TABLE.NOTE +
+ " WHEN new." + NoteColumns.PARENT_ID + "=" + Notes.ID_TRASH_FOLER +
+ " BEGIN" +
+ // 将父 ID 等于被移动文件夹 ID 的所有笔记的父 ID 也设置为回收站 ID
+ " 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");
@@ -226,6 +306,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
db.execSQL("DROP TRIGGER IF EXISTS folder_delete_notes_on_delete");
db.execSQL("DROP TRIGGER IF EXISTS folder_move_notes_on_trash");
+ // 创建新的触发器
db.execSQL(NOTE_INCREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER);
db.execSQL(NOTE_DECREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER);
db.execSQL(NOTE_DECREASE_FOLDER_COUNT_ON_DELETE_TRIGGER);
@@ -235,128 +316,222 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
db.execSQL(FOLDER_MOVE_NOTES_ON_TRASH_TRIGGER);
}
+ /**
+ * 创建系统文件夹，包括通话记录文件夹、根文件夹、临时文件夹和回收站文件夹。
+ *
+ * @param db SQLite 数据库实例
+ */
private void createSystemFolder(SQLiteDatabase db) {
+ // 创建 ContentValues 对象，用于存储要插入的数据
ContentValues values = new ContentValues();
/**
- * call record foler for call notes
+ * 创建通话记录文件夹，用于存储通话笔记
*/
+ // 设置通话记录文件夹的 ID
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
+ * 创建根文件夹，作为默认文件夹
*/
+ // 清空 ContentValues 对象
values.clear();
+ // 设置根文件夹的 ID
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
+ * 创建临时文件夹，用于移动笔记
*/
+ // 清空 ContentValues 对象
values.clear();
+ // 设置临时文件夹的 ID
values.put(NoteColumns.ID, Notes.ID_TEMPARAY_FOLDER);
+ // 设置临时文件夹的类型为系统文件夹
values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM);
+ // 插入临时文件夹到笔记表
db.insert(TABLE.NOTE, null, values);
/**
- * create trash folder
+ * 创建回收站文件夹
*/
+ // 清空 ContentValues 对象
values.clear();
+ // 设置回收站文件夹的 ID
values.put(NoteColumns.ID, Notes.ID_TRASH_FOLER);
+ // 设置回收站文件夹的类型为系统文件夹
values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM);
+ // 插入回收站文件夹到笔记表
db.insert(TABLE.NOTE, null, values);
}
+ /**
+ * 创建数据表，并重新创建相关触发器，同时创建笔记 ID 索引。
+ *
+ * @param db SQLite 数据库实例
+ */
public void createDataTable(SQLiteDatabase db) {
+ // 执行创建数据表的 SQL 语句
db.execSQL(CREATE_DATA_TABLE_SQL);
+ // 重新创建数据表的触发器
reCreateDataTableTriggers(db);
+ // 执行创建笔记 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，则升级到版本 2
if (oldVersion == 1) {
upgradeToV2(db);
- skipV2 = true; // this upgrade including the upgrade from v2 to v3
+ // 标记跳过从版本 2 到版本 3 的升级
+ skipV2 = true;
+ // 旧版本号加 1
oldVersion++;
}
+ // 如果旧版本为 2 且未跳过升级，则升级到版本 3
if (oldVersion == 2 && !skipV2) {
upgradeToV3(db);
+ // 标记需要重新创建触发器
reCreateTriggers = true;
+ // 旧版本号加 1
oldVersion++;
}
+ // 如果旧版本为 3，则升级到版本 4
if (oldVersion == 3) {
upgradeToV4(db);
+ // 旧版本号加 1
oldVersion++;
}
+ // 如果需要重新创建触发器，则重新创建笔记表和数据表的触发器
if (reCreateTriggers) {
reCreateNoteTableTriggers(db);
reCreateDataTableTriggers(db);
}
+ // 如果升级后版本号不等于新版本号，则抛出异常
if (oldVersion != newVersion) {
throw new IllegalStateException("Upgrade notes database to version " + newVersion
- + "fails");
+ + " 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) {
- // drop unused triggers
+ // 删除无用的触发器
db.execSQL("DROP TRIGGER IF EXISTS update_note_modified_date_on_insert");
db.execSQL("DROP TRIGGER IF EXISTS update_note_modified_date_on_delete");
db.execSQL("DROP TRIGGER IF EXISTS update_note_modified_date_on_update");
- // add a column for gtask id
+ // 在笔记表中添加 Google 任务 ID 列
db.execSQL("ALTER TABLE " + TABLE.NOTE + " ADD COLUMN " + NoteColumns.GTASK_ID
+ " TEXT NOT NULL DEFAULT ''");
- // add a trash system folder
+ // 创建 ContentValues 对象，用于存储要插入的数据
ContentValues values = new ContentValues();
+ // 设置回收站文件夹的 ID
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) {
+ // 在笔记表中添加版本列
db.execSQL("ALTER TABLE " + TABLE.NOTE + " ADD COLUMN " + NoteColumns.VERSION
+ " INTEGER NOT NULL DEFAULT 0");
}
-}
+}
\ No newline at end of file
diff --git a/src/Notesmaster/app/src/main/java/net/micode/notes/data/NotesProvider.java b/src/Notesmaster/app/src/main/java/net/micode/notes/data/NotesProvider.java
index edb0a60..48aee2f 100644
--- a/src/Notesmaster/app/src/main/java/net/micode/notes/data/NotesProvider.java
+++ b/src/Notesmaster/app/src/main/java/net/micode/notes/data/NotesProvider.java
@@ -14,9 +14,10 @@
* limitations under the License.
*/
+// 声明包名
package net.micode.notes.data;
-
+// 导入必要的类
import android.app.SearchManager;
import android.content.ContentProvider;
import android.content.ContentUris;
@@ -34,24 +35,29 @@ import net.micode.notes.data.Notes.DataColumns;
import net.micode.notes.data.Notes.NoteColumns;
import net.micode.notes.data.NotesDatabaseHelper.TABLE;
-
+/**
+ * NotesProvider 类，继承自 ContentProvider，用于管理笔记数据的访问和操作。
+ * 它提供了对笔记和笔记数据的增删改查功能，同时支持搜索功能。
+ */
public class NotesProvider extends ContentProvider {
+ // 用于匹配不同的 URI，以便根据不同的 URI 执行不同的操作
private static final UriMatcher mMatcher;
-
+ // 用于操作 SQLite 数据库的帮助类实例
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 {
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);
@@ -62,56 +68,82 @@ public class NotesProvider extends ContentProvider {
}
/**
- * x'0A' represents the '\n' character in sqlite. For title and content in the search result,
- * we will trim '\n' and white space in order to show more information.
+ * 用于搜索笔记的投影，定义了搜索结果的列。
+ * 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;
+ + 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 查询语句。
+ * 从笔记表中查询符合条件的笔记，条件为摘要包含搜索字符串，且父 ID 不等于回收站文件夹 ID，类型为笔记。
+ */
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;
+ + " FROM " + TABLE.NOTE
+ + " WHERE " + NoteColumns.SNIPPET + " LIKE ?"
+ + " AND " + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER
+ + " AND " + NoteColumns.TYPE + "=" + Notes.TYPE_NOTE;
+ /**
+ * 当 ContentProvider 创建时调用，初始化 NotesDatabaseHelper 实例。
+ * @return 总是返回 true，表示 ContentProvider 创建成功。
+ */
@Override
public boolean onCreate() {
mHelper = NotesDatabaseHelper.getInstance(getContext());
return true;
}
+ /**
+ * 根据给定的 URI 查询数据。
+ * @param uri 查询的 URI，用于指定查询的资源。
+ * @param projection 查询的列，指定要返回的列。
+ * @param selection 查询的条件，用于筛选数据。
+ * @param selectionArgs 查询条件的参数。
+ * @param sortOrder 查询结果的排序方式。
+ * @return 返回包含查询结果的 Cursor 对象。
+ */
@Override
public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs,
- String sortOrder) {
+ String sortOrder) {
Cursor c = null;
+ // 获取可读的 SQLite 数据库实例
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
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:
+ // 获取数据记录的 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");
@@ -119,60 +151,81 @@ public class NotesProvider extends ContentProvider {
String searchString = null;
if (mMatcher.match(uri) == URI_SEARCH_SUGGEST) {
+ // 从 URI 路径中获取搜索字符串
if (uri.getPathSegments().size() > 1) {
searchString = uri.getPathSegments().get(1);
}
} else {
+ // 从 URI 查询参数中获取搜索字符串
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);
}
if (c != null) {
+ // 设置通知 URI，当数据变化时通知 ContentResolver
c.setNotificationUri(getContext().getContentResolver(), uri);
}
return c;
}
+ /**
+ * 向指定的 URI 插入数据。
+ * @param uri 插入数据的目标 URI。
+ * @param values 要插入的数据。
+ * @return 返回插入数据后的 URI。
+ */
@Override
public Uri insert(Uri uri, ContentValues values) {
+ // 获取可写的 SQLite 数据库实例
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)) {
+ // 获取笔记 ID
noteId = values.getAsLong(DataColumns.NOTE_ID);
} else {
+ // 记录缺少笔记 ID 的错误信息
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);
}
- // Notify the note uri
+ // 通知笔记 URI 数据变化
if (noteId > 0) {
getContext().getContentResolver().notifyChange(
ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId), null);
}
- // Notify the data uri
+ // 通知数据记录 URI 数据变化
if (dataId > 0) {
getContext().getContentResolver().notifyChange(
ContentUris.withAppendedId(Notes.CONTENT_DATA_URI, dataId), null);
@@ -181,96 +234,146 @@ public class NotesProvider extends ContentProvider {
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;
String id = null;
+ // 获取可写的 SQLite 数据库实例
SQLiteDatabase db = mHelper.getWritableDatabase();
boolean deleteData = false;
+ // 根据 URI 匹配结果执行不同的删除操作
switch (mMatcher.match(uri)) {
case URI_NOTE:
+ // 构建删除条件
selection = "(" + selection + ") AND " + NoteColumns.ID + ">0 ";
+ // 删除笔记数据
count = db.delete(TABLE.NOTE, selection, selectionArgs);
break;
case URI_NOTE_ITEM:
+ // 获取笔记的 ID
id = uri.getPathSegments().get(1);
/**
- * ID that smaller than 0 is system folder which is not allowed to
- * trash
+ * 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:
+ // 获取数据记录的 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);
}
if (count > 0) {
if (deleteData) {
+ // 通知笔记 URI 数据变化
getContext().getContentResolver().notifyChange(Notes.CONTENT_NOTE_URI, null);
}
+ // 通知当前 URI 数据变化
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;
String id = null;
+ // 获取可写的 SQLite 数据库实例
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
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:
+ // 获取数据记录的 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);
}
if (count > 0) {
if (updateData) {
+ // 通知笔记 URI 数据变化
getContext().getContentResolver().notifyChange(Notes.CONTENT_NOTE_URI, null);
}
+ // 通知当前 URI 数据变化
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，如果为 -1 则更新所有符合条件的笔记。
+ * @param selection 更新的条件。
+ * @param selectionArgs 更新条件的参数。
+ */
private void increaseNoteVersion(long id, String selection, String[] selectionArgs) {
StringBuilder sql = new StringBuilder(120);
sql.append("UPDATE ");
@@ -293,13 +396,20 @@ public class NotesProvider extends ContentProvider {
sql.append(selectString);
}
+ // 执行 SQL 语句更新笔记版本号
mHelper.getWritableDatabase().execSQL(sql.toString());
}
+ /**
+ * 获取给定 URI 的 MIME 类型。
+ * 目前该方法未实现，返回 null。
+ * @param uri 要获取 MIME 类型的 URI。
+ * @return 目前返回 null。
+ */
@Override
public String getType(Uri uri) {
// TODO Auto-generated method stub
return null;
}
-}
+}
\ No newline at end of file
diff --git a/src/Notesmaster/app/src/main/java/net/micode/notes/gtask/data/MetaData.java b/src/Notesmaster/app/src/main/java/net/micode/notes/gtask/data/MetaData.java
index 3a2050b..f5e1375 100644
--- a/src/Notesmaster/app/src/main/java/net/micode/notes/gtask/data/MetaData.java
+++ b/src/Notesmaster/app/src/main/java/net/micode/notes/gtask/data/MetaData.java
@@ -24,59 +24,119 @@ import net.micode.notes.tool.GTaskStringUtils;
import org.json.JSONException;
import org.json.JSONObject;
-
+/**
+ * MetaData 类继承自 Task 类，用于处理与 Google 任务相关的元数据。
+ * 该类包含设置元数据、获取相关 Google 任务 ID 等功能。
+ */
public class MetaData extends Task {
+ // 日志标签，用于标识该类的日志信息
private final static String TAG = MetaData.class.getSimpleName();
+ // 存储相关的 Google 任务 ID
private String mRelatedGid = null;
+ /**
+ * 设置元数据信息。
+ * 将给定的 Google 任务 ID 和元数据信息组合并存储到笔记中。
+ *
+ * @param gid 相关的 Google 任务 ID
+ * @param metaInfo 包含元数据信息的 JSONObject
+ */
public void setMeta(String gid, JSONObject metaInfo) {
try {
+ // 将相关的 Google 任务 ID 放入元数据信息中
metaInfo.put(GTaskStringUtils.META_HEAD_GTASK_ID, gid);
} catch (JSONException e) {
+ // 记录错误日志，表明无法将相关的 Google 任务 ID 放入元数据信息中
Log.e(TAG, "failed to put related gid");
}
+ // 将元数据信息转换为字符串并设置为笔记内容
setNotes(metaInfo.toString());
+ // 设置笔记的名称为元数据笔记的名称
setName(GTaskStringUtils.META_NOTE_NAME);
}
+ /**
+ * 获取相关的 Google 任务 ID。
+ *
+ * @return 相关的 Google 任务 ID，如果未设置则返回 null
+ */
public String getRelatedGid() {
return mRelatedGid;
}
+ /**
+ * 判断该元数据是否值得保存。
+ * 如果笔记内容不为空，则认为值得保存。
+ *
+ * @return 如果笔记内容不为空则返回 true，否则返回 false
+ */
@Override
public boolean isWorthSaving() {
return getNotes() != null;
}
+ /**
+ * 根据远程 JSON 对象设置元数据内容。
+ * 调用父类的方法设置内容，并从笔记中提取相关的 Google 任务 ID。
+ *
+ * @param js 包含远程元数据信息的 JSONObject
+ */
@Override
public void setContentByRemoteJSON(JSONObject js) {
+ // 调用父类的方法设置内容
super.setContentByRemoteJSON(js);
if (getNotes() != null) {
try {
+ // 将笔记内容转换为 JSONObject
JSONObject metaInfo = new JSONObject(getNotes().trim());
+ // 从元数据信息中提取相关的 Google 任务 ID
mRelatedGid = metaInfo.getString(GTaskStringUtils.META_HEAD_GTASK_ID);
} catch (JSONException e) {
+ // 记录警告日志，表明无法从笔记中提取相关的 Google 任务 ID
Log.w(TAG, "failed to get related gid");
mRelatedGid = null;
}
}
}
+ /**
+ * 根据本地 JSON 对象设置元数据内容。
+ * 该方法不应该被调用，因为元数据不应该通过本地 JSON 设置。
+ *
+ * @param js 包含本地元数据信息的 JSONObject
+ * @throws IllegalAccessError 始终抛出该异常，表明该方法不应该被调用
+ */
@Override
public void setContentByLocalJSON(JSONObject js) {
- // this function should not be called
+ // 抛出异常，表明该方法不应该被调用
throw new IllegalAccessError("MetaData:setContentByLocalJSON should not be called");
}
+ /**
+ * 从内容中获取本地 JSON 对象。
+ * 该方法不应该被调用，因为元数据不应该生成本地 JSON。
+ *
+ * @return 无返回值，因为会抛出异常
+ * @throws IllegalAccessError 始终抛出该异常，表明该方法不应该被调用
+ */
@Override
public JSONObject getLocalJSONFromContent() {
+ // 抛出异常，表明该方法不应该被调用
throw new IllegalAccessError("MetaData:getLocalJSONFromContent should not be called");
}
+ /**
+ * 获取同步操作。
+ * 该方法不应该被调用，因为元数据不参与同步操作。
+ *
+ * @param c 用于查询同步操作的 Cursor
+ * @return 无返回值，因为会抛出异常
+ * @throws IllegalAccessError 始终抛出该异常，表明该方法不应该被调用
+ */
@Override
public int getSyncAction(Cursor c) {
+ // 抛出异常，表明该方法不应该被调用
throw new IllegalAccessError("MetaData:getSyncAction should not be called");
}
-
-}
+}
\ No newline at end of file
diff --git a/src/Notesmaster/app/src/main/java/net/micode/notes/gtask/data/Node.java b/src/Notesmaster/app/src/main/java/net/micode/notes/gtask/data/Node.java
index 63950e0..9cc8beb 100644
--- a/src/Notesmaster/app/src/main/java/net/micode/notes/gtask/data/Node.java
+++ b/src/Notesmaster/app/src/main/java/net/micode/notes/gtask/data/Node.java
@@ -20,82 +20,174 @@ import android.database.Cursor;
import org.json.JSONObject;
+/**
+ * Node 类是一个抽象类，代表同步操作中的节点。
+ * 它定义了同步操作的常量和节点的基本属性，如全局ID、名称、最后修改时间和删除状态。
+ * 同时，它提供了一些抽象方法，需要子类去实现具体的同步操作逻辑。
+ */
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;
+ // 节点的全局唯一标识符
private String mGid;
-
+ // 节点的名称
private String mName;
-
+ // 节点的最后修改时间
private long mLastModified;
-
+ // 节点是否已被删除的标志
private boolean mDeleted;
+ /**
+ * 构造函数，初始化节点的属性。
+ */
public Node() {
+ // 初始全局ID为 null
mGid = null;
+ // 初始名称为空字符串
mName = "";
+ // 初始最后修改时间为 0
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);
+ /**
+ * 设置节点的全局唯一标识符。
+ *
+ * @param gid 要设置的全局唯一标识符
+ */
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 要设置的删除状态，true 表示已删除，false 表示未删除
+ */
public void setDeleted(boolean deleted) {
this.mDeleted = deleted;
}
+ /**
+ * 获取节点的全局唯一标识符。
+ *
+ * @return 节点的全局唯一标识符
+ */
public String getGid() {
return this.mGid;
}
+ /**
+ * 获取节点的名称。
+ *
+ * @return 节点的名称
+ */
public String getName() {
return this.mName;
}
+ /**
+ * 获取节点的最后修改时间。
+ *
+ * @return 节点的最后修改时间
+ */
public long getLastModified() {
return this.mLastModified;
}
+ /**
+ * 获取节点的删除状态。
+ *
+ * @return 节点的删除状态，true 表示已删除，false 表示未删除
+ */
public boolean getDeleted() {
return this.mDeleted;
}
-
-}
+}
\ No newline at end of file
diff --git a/src/Notesmaster/app/src/main/java/net/micode/notes/gtask/data/SqlData.java b/src/Notesmaster/app/src/main/java/net/micode/notes/gtask/data/SqlData.java
index d3ec3be..5f04483 100644
--- a/src/Notesmaster/app/src/main/java/net/micode/notes/gtask/data/SqlData.java
+++ b/src/Notesmaster/app/src/main/java/net/micode/notes/gtask/data/SqlData.java
@@ -34,156 +34,248 @@ import net.micode.notes.gtask.exception.ActionFailureException;
import org.json.JSONException;
import org.json.JSONObject;
-
+/**
+ * SqlData 类用于处理与笔记数据相关的数据库操作，
+ * 支持从数据库加载数据、根据 JSON 设置数据、将数据保存到数据库等功能。
+ */
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;
-
+ // 存储数据差异的 ContentValues 对象
private ContentValues mDiffDataValues;
+ /**
+ * 构造函数，用于创建一个新的 SqlData 对象。
+ *
+ * @param context 上下文对象，用于获取 ContentResolver
+ */
public SqlData(Context context) {
+ // 获取 ContentResolver 用于与内容提供者交互
mContentResolver = context.getContentResolver();
+ // 标记为新创建的数据
mIsCreate = true;
+ // 初始化数据 ID 为无效值
mDataId = INVALID_ID;
+ // 初始化数据 MIME 类型为默认的笔记类型
mDataMimeType = DataConstants.NOTE;
+ // 初始化数据内容为空字符串
mDataContent = "";
+ // 初始化数据内容的 DATA1 字段为 0
mDataContentData1 = 0;
+ // 初始化数据内容的 DATA3 字段为空字符串
mDataContentData3 = "";
+ // 初始化存储数据差异的 ContentValues 对象
mDiffDataValues = new ContentValues();
}
+ /**
+ * 构造函数，用于从 Cursor 加载数据创建 SqlData 对象。
+ *
+ * @param context 上下文对象，用于获取 ContentResolver
+ * @param c 包含数据的 Cursor 对象
+ */
public SqlData(Context context, Cursor c) {
+ // 获取 ContentResolver 用于与内容提供者交互
mContentResolver = context.getContentResolver();
+ // 标记为非新创建的数据
mIsCreate = false;
+ // 从 Cursor 中加载数据
loadFromCursor(c);
+ // 初始化存储数据差异的 ContentValues 对象
mDiffDataValues = new ContentValues();
}
+ /**
+ * 从 Cursor 中加载数据到当前对象。
+ *
+ * @param c 包含数据的 Cursor 对象
+ */
private void loadFromCursor(Cursor c) {
+ // 从 Cursor 中获取数据 ID
mDataId = c.getLong(DATA_ID_COLUMN);
+ // 从 Cursor 中获取数据 MIME 类型
mDataMimeType = c.getString(DATA_MIME_TYPE_COLUMN);
+ // 从 Cursor 中获取数据内容
mDataContent = c.getString(DATA_CONTENT_COLUMN);
+ // 从 Cursor 中获取数据内容的 DATA1 字段
mDataContentData1 = c.getLong(DATA_CONTENT_DATA_1_COLUMN);
+ // 从 Cursor 中获取数据内容的 DATA3 字段
mDataContentData3 = c.getString(DATA_CONTENT_DATA_3_COLUMN);
}
+ /**
+ * 根据 JSON 对象设置数据内容，并记录差异。
+ *
+ * @param js 包含数据的 JSON 对象
+ * @throws JSONException 如果 JSON 解析出错
+ */
public void setContent(JSONObject js) throws JSONException {
+ // 从 JSON 对象中获取数据 ID，如果不存在则使用无效值
long dataId = js.has(DataColumns.ID) ? js.getLong(DataColumns.ID) : INVALID_ID;
+ // 如果是新创建的数据或者数据 ID 发生变化，记录差异
if (mIsCreate || mDataId != dataId) {
mDiffDataValues.put(DataColumns.ID, dataId);
}
+ // 更新数据 ID
mDataId = dataId;
+ // 从 JSON 对象中获取数据 MIME 类型，如果不存在则使用默认值
String dataMimeType = js.has(DataColumns.MIME_TYPE) ? js.getString(DataColumns.MIME_TYPE)
: DataConstants.NOTE;
+ // 如果是新创建的数据或者 MIME 类型发生变化，记录差异
if (mIsCreate || !mDataMimeType.equals(dataMimeType)) {
mDiffDataValues.put(DataColumns.MIME_TYPE, dataMimeType);
}
+ // 更新数据 MIME 类型
mDataMimeType = dataMimeType;
+ // 从 JSON 对象中获取数据内容，如果不存在则使用空字符串
String dataContent = js.has(DataColumns.CONTENT) ? js.getString(DataColumns.CONTENT) : "";
+ // 如果是新创建的数据或者数据内容发生变化，记录差异
if (mIsCreate || !mDataContent.equals(dataContent)) {
mDiffDataValues.put(DataColumns.CONTENT, dataContent);
}
+ // 更新数据内容
mDataContent = dataContent;
+ // 从 JSON 对象中获取数据内容的 DATA1 字段，如果不存在则使用 0
long dataContentData1 = js.has(DataColumns.DATA1) ? js.getLong(DataColumns.DATA1) : 0;
+ // 如果是新创建的数据或者 DATA1 字段发生变化，记录差异
if (mIsCreate || mDataContentData1 != dataContentData1) {
mDiffDataValues.put(DataColumns.DATA1, dataContentData1);
}
+ // 更新数据内容的 DATA1 字段
mDataContentData1 = dataContentData1;
+ // 从 JSON 对象中获取数据内容的 DATA3 字段，如果不存在则使用空字符串
String dataContentData3 = js.has(DataColumns.DATA3) ? js.getString(DataColumns.DATA3) : "";
+ // 如果是新创建的数据或者 DATA3 字段发生变化，记录差异
if (mIsCreate || !mDataContentData3.equals(dataContentData3)) {
mDiffDataValues.put(DataColumns.DATA3, dataContentData3);
}
+ // 更新数据内容的 DATA3 字段
mDataContentData3 = dataContentData3;
}
+ /**
+ * 获取当前数据的 JSON 表示。
+ *
+ * @return 包含当前数据的 JSON 对象
+ * @throws JSONException 如果 JSON 构建出错
+ */
public JSONObject getContent() throws JSONException {
+ // 如果是新创建的数据且未保存到数据库，记录错误日志并返回 null
if (mIsCreate) {
Log.e(TAG, "it seems that we haven't created this in database yet");
return null;
}
+ // 创建一个新的 JSON 对象
JSONObject js = new JSONObject();
+ // 将数据 ID 放入 JSON 对象
js.put(DataColumns.ID, mDataId);
+ // 将数据 MIME 类型放入 JSON 对象
js.put(DataColumns.MIME_TYPE, mDataMimeType);
+ // 将数据内容放入 JSON 对象
js.put(DataColumns.CONTENT, mDataContent);
+ // 将数据内容的 DATA1 字段放入 JSON 对象
js.put(DataColumns.DATA1, mDataContentData1);
+ // 将数据内容的 DATA3 字段放入 JSON 对象
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 无效且差异值中包含数据 ID，移除该差异
if (mDataId == INVALID_ID && mDiffDataValues.containsKey(DataColumns.ID)) {
mDiffDataValues.remove(DataColumns.ID);
}
-
+ // 将关联的笔记 ID 放入差异值
mDiffDataValues.put(DataColumns.NOTE_ID, noteId);
+ // 插入数据到数据库，并获取插入后的 Uri
Uri uri = mContentResolver.insert(Notes.CONTENT_DATA_URI, mDiffDataValues);
try {
+ // 从 Uri 中获取插入后的新数据 ID
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,
+ Notes.CONTENT_DATA_URI, mDataId), mDiffDataValues,
" ? in (SELECT " + NoteColumns.ID + " FROM " + TABLE.NOTE
+ " WHERE " + NoteColumns.VERSION + "=?)", new String[] {
String.valueOf(noteId), String.valueOf(version)
});
}
+ // 如果更新结果为 0，记录警告日志
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;
}
-}
+}
\ No newline at end of file
diff --git a/src/Notesmaster/app/src/main/java/net/micode/notes/gtask/data/SqlNote.java b/src/Notesmaster/app/src/main/java/net/micode/notes/gtask/data/SqlNote.java
index 79a4095..6f45169 100644
--- a/src/Notesmaster/app/src/main/java/net/micode/notes/gtask/data/SqlNote.java
+++ b/src/Notesmaster/app/src/main/java/net/micode/notes/gtask/data/SqlNote.java
@@ -37,12 +37,16 @@ import org.json.JSONObject;
import java.util.ArrayList;
-
+/**
+ * SqlNote 类用于处理笔记数据的管理，包括从数据库加载笔记、
+ * 根据 JSON 设置笔记内容、将笔记内容保存到数据库等操作。
+ */
public class SqlNote {
+ // 日志标签，用于在日志中标识该类的相关信息
private static final String TAG = SqlNote.class.getSimpleName();
-
+ // 无效的 ID，用于表示未分配或无效的笔记 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,
@@ -51,191 +55,268 @@ public class SqlNote {
NoteColumns.LOCAL_MODIFIED, NoteColumns.ORIGIN_PARENT_ID, NoteColumns.GTASK_ID,
NoteColumns.VERSION
};
-
+ // 各列在投影数组中的索引，方便从 Cursor 中获取对应列的值
public static final int ID_COLUMN = 0;
-
public static final int ALERTED_DATE_COLUMN = 1;
-
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;
-
public static final int PARENT_ID_COLUMN = 7;
-
public static final int SNIPPET_COLUMN = 8;
-
public static final int TYPE_COLUMN = 9;
-
public static final int WIDGET_ID_COLUMN = 10;
-
public static final int WIDGET_TYPE_COLUMN = 11;
-
public static final int SYNC_ID_COLUMN = 12;
-
public static final int LOCAL_MODIFIED_COLUMN = 13;
-
public static final int ORIGIN_PARENT_ID_COLUMN = 14;
-
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;
-
+ // 存储笔记差异值的 ContentValues 对象，用于记录需要更新的字段
private ContentValues mDiffNoteValues;
-
+ // 存储笔记相关数据的列表，每个元素是一个 SqlData 对象
private ArrayList mDataList;
+ /**
+ * 构造函数，用于创建一个新的笔记对象。
+ *
+ * @param context 上下文对象
+ */
public SqlNote(Context context) {
+ // 保存上下文对象
mContext = context;
+ // 获取内容解析器
mContentResolver = context.getContentResolver();
+ // 标记为新创建的笔记
mIsCreate = true;
+ // 初始化笔记 ID 为无效值
mId = INVALID_ID;
+ // 初始化提醒日期为 0
mAlertDate = 0;
+ // 初始化背景颜色 ID 为默认值
mBgColorId = ResourceParser.getDefaultBgId(context);
+ // 初始化创建日期为当前时间
mCreatedDate = System.currentTimeMillis();
+ // 初始化是否有附件标志为 0
mHasAttachment = 0;
+ // 初始化修改日期为当前时间
mModifiedDate = System.currentTimeMillis();
+ // 初始化父文件夹 ID 为 0
mParentId = 0;
+ // 初始化摘要为空字符串
mSnippet = "";
+ // 初始化笔记类型为普通笔记
mType = Notes.TYPE_NOTE;
+ // 初始化小部件 ID 为无效值
mWidgetId = AppWidgetManager.INVALID_APPWIDGET_ID;
+ // 初始化小部件类型为无效类型
mWidgetType = Notes.TYPE_WIDGET_INVALIDE;
+ // 初始化原始父文件夹 ID 为 0
mOriginParent = 0;
+ // 初始化版本号为 0
mVersion = 0;
+ // 初始化差异值 ContentValues 对象
mDiffNoteValues = new ContentValues();
+ // 初始化数据列表
mDataList = new ArrayList();
}
+ /**
+ * 构造函数，用于从 Cursor 加载笔记数据创建笔记对象。
+ *
+ * @param context 上下文对象
+ * @param c 包含笔记数据的 Cursor
+ */
public SqlNote(Context context, Cursor c) {
+ // 保存上下文对象
mContext = context;
+ // 获取内容解析器
mContentResolver = context.getContentResolver();
+ // 标记为非新创建的笔记
mIsCreate = false;
+ // 从 Cursor 中加载笔记数据
loadFromCursor(c);
+ // 初始化数据列表
mDataList = new ArrayList();
+ // 如果是普通笔记，加载笔记相关数据
if (mType == Notes.TYPE_NOTE)
loadDataContent();
+ // 初始化差异值 ContentValues 对象
mDiffNoteValues = new ContentValues();
}
+ /**
+ * 构造函数，用于根据笔记 ID 从数据库加载笔记数据创建笔记对象。
+ *
+ * @param context 上下文对象
+ * @param id 笔记的 ID
+ */
public SqlNote(Context context, long id) {
+ // 保存上下文对象
mContext = context;
+ // 获取内容解析器
mContentResolver = context.getContentResolver();
+ // 标记为非新创建的笔记
mIsCreate = false;
+ // 根据 ID 从数据库加载笔记数据
loadFromCursor(id);
+ // 初始化数据列表
mDataList = new ArrayList();
+ // 如果是普通笔记，加载笔记相关数据
if (mType == Notes.TYPE_NOTE)
loadDataContent();
+ // 初始化差异值 ContentValues 对象
mDiffNoteValues = new ContentValues();
-
}
+ /**
+ * 根据笔记 ID 从数据库查询并加载笔记数据。
+ *
+ * @param id 笔记的 ID
+ */
private void loadFromCursor(long id) {
Cursor c = null;
try {
+ // 根据 ID 查询笔记数据
c = mContentResolver.query(Notes.CONTENT_NOTE_URI, PROJECTION_NOTE, "(_id=?)",
new String[] {
- String.valueOf(id)
+ String.valueOf(id)
}, null);
if (c != null) {
+ // 移动到查询结果的第一行
c.moveToNext();
+ // 从 Cursor 中加载笔记数据
loadFromCursor(c);
} else {
+ // 记录警告日志，提示 Cursor 为空
Log.w(TAG, "loadFromCursor: cursor = null");
}
} finally {
if (c != null)
+ // 关闭 Cursor
c.close();
}
}
+ /**
+ * 从 Cursor 中加载笔记数据到当前对象。
+ *
+ * @param c 包含笔记数据的 Cursor
+ */
private void loadFromCursor(Cursor c) {
+ // 从 Cursor 中获取笔记 ID
mId = c.getLong(ID_COLUMN);
+ // 从 Cursor 中获取提醒日期
mAlertDate = c.getLong(ALERTED_DATE_COLUMN);
+ // 从 Cursor 中获取背景颜色 ID
mBgColorId = c.getInt(BG_COLOR_ID_COLUMN);
+ // 从 Cursor 中获取创建日期
mCreatedDate = c.getLong(CREATED_DATE_COLUMN);
+ // 从 Cursor 中获取是否有附件标志
mHasAttachment = c.getInt(HAS_ATTACHMENT_COLUMN);
+ // 从 Cursor 中获取修改日期
mModifiedDate = c.getLong(MODIFIED_DATE_COLUMN);
+ // 从 Cursor 中获取父文件夹 ID
mParentId = c.getLong(PARENT_ID_COLUMN);
+ // 从 Cursor 中获取摘要
mSnippet = c.getString(SNIPPET_COLUMN);
+ // 从 Cursor 中获取笔记类型
mType = c.getInt(TYPE_COLUMN);
+ // 从 Cursor 中获取小部件 ID
mWidgetId = c.getInt(WIDGET_ID_COLUMN);
+ // 从 Cursor 中获取小部件类型
mWidgetType = c.getInt(WIDGET_TYPE_COLUMN);
+ // 从 Cursor 中获取版本号
mVersion = c.getLong(VERSION_COLUMN);
}
+ /**
+ * 加载笔记的相关数据。
+ */
private void loadDataContent() {
Cursor c = null;
+ // 清空数据列表
mDataList.clear();
try {
+ // 根据笔记 ID 查询相关数据
c = mContentResolver.query(Notes.CONTENT_DATA_URI, SqlData.PROJECTION_DATA,
"(note_id=?)", new String[] {
- String.valueOf(mId)
+ String.valueOf(mId)
}, null);
if (c != null) {
if (c.getCount() == 0) {
+ // 记录警告日志，提示笔记没有相关数据
Log.w(TAG, "it seems that the note has not data");
return;
}
while (c.moveToNext()) {
+ // 创建 SqlData 对象并添加到数据列表中
SqlData data = new SqlData(mContext, c);
mDataList.add(data);
}
} else {
+ // 记录警告日志，提示 Cursor 为空
Log.w(TAG, "loadDataContent: cursor = null");
}
} finally {
if (c != null)
+ // 关闭 Cursor
c.close();
}
}
+ /**
+ * 根据 JSON 对象设置笔记内容。
+ *
+ * @param js 包含笔记内容的 JSON 对象
+ * @return 设置成功返回 true，失败返回 false
+ */
public boolean setContent(JSONObject js) {
try {
+ // 从 JSON 对象中获取笔记信息
JSONObject note = js.getJSONObject(GTaskStringUtils.META_HEAD_NOTE);
if (note.getInt(NoteColumns.TYPE) == Notes.TYPE_SYSTEM) {
+ // 记录警告日志，提示不能设置系统文件夹
Log.w(TAG, "cannot set system folder");
} else if (note.getInt(NoteColumns.TYPE) == Notes.TYPE_FOLDER) {
- // for folder we can only update the snnipet and type
+ // 对于文件夹，只能更新摘要和类型
String snippet = note.has(NoteColumns.SNIPPET) ? note
.getString(NoteColumns.SNIPPET) : "";
if (mIsCreate || !mSnippet.equals(snippet)) {
+ // 记录摘要差异
mDiffNoteValues.put(NoteColumns.SNIPPET, snippet);
}
mSnippet = snippet;
@@ -243,13 +324,16 @@ public class SqlNote {
int type = note.has(NoteColumns.TYPE) ? note.getInt(NoteColumns.TYPE)
: Notes.TYPE_NOTE;
if (mIsCreate || mType != type) {
+ // 记录类型差异
mDiffNoteValues.put(NoteColumns.TYPE, type);
}
mType = type;
} else if (note.getInt(NoteColumns.TYPE) == Notes.TYPE_NOTE) {
+ // 对于普通笔记，更新所有字段
JSONArray dataArray = js.getJSONArray(GTaskStringUtils.META_HEAD_DATA);
long id = note.has(NoteColumns.ID) ? note.getLong(NoteColumns.ID) : INVALID_ID;
if (mIsCreate || mId != id) {
+ // 记录 ID 差异
mDiffNoteValues.put(NoteColumns.ID, id);
}
mId = id;
@@ -257,6 +341,7 @@ public class SqlNote {
long alertDate = note.has(NoteColumns.ALERTED_DATE) ? note
.getLong(NoteColumns.ALERTED_DATE) : 0;
if (mIsCreate || mAlertDate != alertDate) {
+ // 记录提醒日期差异
mDiffNoteValues.put(NoteColumns.ALERTED_DATE, alertDate);
}
mAlertDate = alertDate;
@@ -264,6 +349,7 @@ public class SqlNote {
int bgColorId = note.has(NoteColumns.BG_COLOR_ID) ? note
.getInt(NoteColumns.BG_COLOR_ID) : ResourceParser.getDefaultBgId(mContext);
if (mIsCreate || mBgColorId != bgColorId) {
+ // 记录背景颜色 ID 差异
mDiffNoteValues.put(NoteColumns.BG_COLOR_ID, bgColorId);
}
mBgColorId = bgColorId;
@@ -271,6 +357,7 @@ public class SqlNote {
long createDate = note.has(NoteColumns.CREATED_DATE) ? note
.getLong(NoteColumns.CREATED_DATE) : System.currentTimeMillis();
if (mIsCreate || mCreatedDate != createDate) {
+ // 记录创建日期差异
mDiffNoteValues.put(NoteColumns.CREATED_DATE, createDate);
}
mCreatedDate = createDate;
@@ -278,6 +365,7 @@ public class SqlNote {
int hasAttachment = note.has(NoteColumns.HAS_ATTACHMENT) ? note
.getInt(NoteColumns.HAS_ATTACHMENT) : 0;
if (mIsCreate || mHasAttachment != hasAttachment) {
+ // 记录是否有附件标志差异
mDiffNoteValues.put(NoteColumns.HAS_ATTACHMENT, hasAttachment);
}
mHasAttachment = hasAttachment;
@@ -285,6 +373,7 @@ public class SqlNote {
long modifiedDate = note.has(NoteColumns.MODIFIED_DATE) ? note
.getLong(NoteColumns.MODIFIED_DATE) : System.currentTimeMillis();
if (mIsCreate || mModifiedDate != modifiedDate) {
+ // 记录修改日期差异
mDiffNoteValues.put(NoteColumns.MODIFIED_DATE, modifiedDate);
}
mModifiedDate = modifiedDate;
@@ -292,6 +381,7 @@ public class SqlNote {
long parentId = note.has(NoteColumns.PARENT_ID) ? note
.getLong(NoteColumns.PARENT_ID) : 0;
if (mIsCreate || mParentId != parentId) {
+ // 记录父文件夹 ID 差异
mDiffNoteValues.put(NoteColumns.PARENT_ID, parentId);
}
mParentId = parentId;
@@ -299,6 +389,7 @@ public class SqlNote {
String snippet = note.has(NoteColumns.SNIPPET) ? note
.getString(NoteColumns.SNIPPET) : "";
if (mIsCreate || !mSnippet.equals(snippet)) {
+ // 记录摘要差异
mDiffNoteValues.put(NoteColumns.SNIPPET, snippet);
}
mSnippet = snippet;
@@ -306,6 +397,7 @@ public class SqlNote {
int type = note.has(NoteColumns.TYPE) ? note.getInt(NoteColumns.TYPE)
: Notes.TYPE_NOTE;
if (mIsCreate || mType != type) {
+ // 记录类型差异
mDiffNoteValues.put(NoteColumns.TYPE, type);
}
mType = type;
@@ -313,6 +405,7 @@ public class SqlNote {
int widgetId = note.has(NoteColumns.WIDGET_ID) ? note.getInt(NoteColumns.WIDGET_ID)
: AppWidgetManager.INVALID_APPWIDGET_ID;
if (mIsCreate || mWidgetId != widgetId) {
+ // 记录小部件 ID 差异
mDiffNoteValues.put(NoteColumns.WIDGET_ID, widgetId);
}
mWidgetId = widgetId;
@@ -320,6 +413,7 @@ public class SqlNote {
int widgetType = note.has(NoteColumns.WIDGET_TYPE) ? note
.getInt(NoteColumns.WIDGET_TYPE) : Notes.TYPE_WIDGET_INVALIDE;
if (mIsCreate || mWidgetType != widgetType) {
+ // 记录小部件类型差异
mDiffNoteValues.put(NoteColumns.WIDGET_TYPE, widgetType);
}
mWidgetType = widgetType;
@@ -327,11 +421,13 @@ public class SqlNote {
long originParent = note.has(NoteColumns.ORIGIN_PARENT_ID) ? note
.getLong(NoteColumns.ORIGIN_PARENT_ID) : 0;
if (mIsCreate || mOriginParent != originParent) {
+ // 记录原始父文件夹 ID 差异
mDiffNoteValues.put(NoteColumns.ORIGIN_PARENT_ID, originParent);
}
mOriginParent = originParent;
for (int i = 0; i < dataArray.length(); i++) {
+ // 处理笔记的相关数据
JSONObject data = dataArray.getJSONObject(i);
SqlData sqlData = null;
if (data.has(DataColumns.ID)) {
@@ -352,6 +448,7 @@ public class SqlNote {
}
}
} catch (JSONException e) {
+ // 记录错误日志并打印异常堆栈信息
Log.e(TAG, e.toString());
e.printStackTrace();
return false;
@@ -359,17 +456,24 @@ public class SqlNote {
return true;
}
+ /**
+ * 获取笔记内容的 JSON 表示。
+ *
+ * @return 包含笔记内容的 JSON 对象，出错返回 null
+ */
public JSONObject getContent() {
try {
JSONObject js = new JSONObject();
if (mIsCreate) {
+ // 记录错误日志，提示笔记未在数据库中创建
Log.e(TAG, "it seems that we haven't created this in database yet");
return null;
}
JSONObject note = new JSONObject();
if (mType == Notes.TYPE_NOTE) {
+ // 对于普通笔记，添加所有字段到 JSON 对象
note.put(NoteColumns.ID, mId);
note.put(NoteColumns.ALERTED_DATE, mAlertDate);
note.put(NoteColumns.BG_COLOR_ID, mBgColorId);
@@ -386,6 +490,7 @@ public class SqlNote {
JSONArray dataArray = new JSONArray();
for (SqlData sqlData : mDataList) {
+ // 添加笔记的相关数据到 JSON 数组
JSONObject data = sqlData.getContent();
if (data != null) {
dataArray.put(data);
@@ -393,6 +498,7 @@ public class SqlNote {
}
js.put(GTaskStringUtils.META_HEAD_DATA, dataArray);
} else if (mType == Notes.TYPE_FOLDER || mType == Notes.TYPE_SYSTEM) {
+ // 对于文件夹或系统文件夹，添加部分字段到 JSON 对象
note.put(NoteColumns.ID, mId);
note.put(NoteColumns.TYPE, mType);
note.put(NoteColumns.SNIPPET, mSnippet);
@@ -401,105 +507,167 @@ public class SqlNote {
return js;
} catch (JSONException e) {
+ // 记录错误日志并打印异常堆栈信息
Log.e(TAG, e.toString());
e.printStackTrace();
}
return null;
}
+ /**
+ * 设置笔记的父文件夹 ID。
+ *
+ * @param id 父文件夹 ID
+ */
public void setParentId(long id) {
mParentId = id;
+ // 记录父文件夹 ID 差异
mDiffNoteValues.put(NoteColumns.PARENT_ID, id);
}
+ /**
+ * 设置笔记的 Google 任务 ID。
+ *
+ * @param gid Google 任务 ID
+ */
public void setGtaskId(String gid) {
+ // 记录 Google 任务 ID 差异
mDiffNoteValues.put(NoteColumns.GTASK_ID, gid);
}
+ /**
+ * 设置笔记的同步 ID。
+ *
+ * @param syncId 同步 ID
+ */
public void setSyncId(long syncId) {
+ // 记录同步 ID 差异
mDiffNoteValues.put(NoteColumns.SYNC_ID, syncId);
}
+ /**
+ * 重置笔记的本地修改标志。
+ */
public void resetLocalModified() {
+ // 记录本地修改标志差异为 0
mDiffNoteValues.put(NoteColumns.LOCAL_MODIFIED, 0);
}
+ /**
+ * 获取笔记的 ID。
+ *
+ * @return 笔记的 ID
+ */
public long getId() {
return mId;
}
+ /**
+ * 获取笔记的父文件夹 ID。
+ *
+ * @return 父文件夹 ID
+ */
public long getParentId() {
return mParentId;
}
+ /**
+ * 获取笔记的摘要。
+ *
+ * @return 笔记的摘要
+ */
public String getSnippet() {
return mSnippet;
}
+ /**
+ * 判断笔记是否为普通笔记类型。
+ *
+ * @return 是普通笔记类型返回 true，否则返回 false
+ */
public boolean isNoteType() {
return mType == Notes.TYPE_NOTE;
}
+ /**
+ * 将笔记内容提交到数据库。
+ *
+ * @param validateVersion 是否验证版本
+ */
public void commit(boolean validateVersion) {
if (mIsCreate) {
if (mId == INVALID_ID && mDiffNoteValues.containsKey(NoteColumns.ID)) {
+ // 如果 ID 无效且差异值中包含 ID，移除 ID 差异
mDiffNoteValues.remove(NoteColumns.ID);
}
+ // 插入笔记数据到数据库
Uri uri = mContentResolver.insert(Notes.CONTENT_NOTE_URI, mDiffNoteValues);
try {
+ // 获取插入后的笔记 ID
mId = Long.valueOf(uri.getPathSegments().get(1));
} catch (NumberFormatException e) {
+ // 记录错误日志并抛出异常
Log.e(TAG, "Get note id error :" + e.toString());
throw new ActionFailureException("create note failed");
}
if (mId == 0) {
+ // 抛出异常，提示创建笔记 ID 失败
throw new IllegalStateException("Create thread id failed");
}
if (mType == Notes.TYPE_NOTE) {
for (SqlData sqlData : mDataList) {
+ // 提交笔记的相关数据到数据库
sqlData.commit(mId, false, -1);
}
}
} else {
if (mId <= 0 && mId != Notes.ID_ROOT_FOLDER && mId != Notes.ID_CALL_RECORD_FOLDER) {
+ // 记录错误日志并抛出异常，提示笔记 ID 无效
Log.e(TAG, "No such note");
throw new IllegalStateException("Try to update note with invalid id");
}
if (mDiffNoteValues.size() > 0) {
+ // 版本号加 1
mVersion ++;
int result = 0;
if (!validateVersion) {
+ // 不验证版本时，直接更新笔记数据
result = mContentResolver.update(Notes.CONTENT_NOTE_URI, mDiffNoteValues, "("
+ NoteColumns.ID + "=?)", new String[] {
- String.valueOf(mId)
+ String.valueOf(mId)
});
} else {
+ // 验证版本时，根据版本条件更新笔记数据
result = mContentResolver.update(Notes.CONTENT_NOTE_URI, mDiffNoteValues, "("
- + NoteColumns.ID + "=?) AND (" + NoteColumns.VERSION + "<=?)",
+ + NoteColumns.ID + "=?) AND (" + NoteColumns.VERSION + "<=?)",
new String[] {
String.valueOf(mId), String.valueOf(mVersion)
});
}
if (result == 0) {
+ // 记录警告日志，提示可能用户在同步时更新了笔记
Log.w(TAG, "there is no update. maybe user updates note when syncing");
}
}
if (mType == Notes.TYPE_NOTE) {
for (SqlData sqlData : mDataList) {
+ // 提交笔记的相关数据到数据库
sqlData.commit(mId, validateVersion, mVersion);
}
}
}
- // refresh local info
+ // 刷新本地笔记信息
loadFromCursor(mId);
if (mType == Notes.TYPE_NOTE)
loadDataContent();
+ // 清空差异值
mDiffNoteValues.clear();
+ // 标记为非新创建的笔记
mIsCreate = false;
}
-}
+}
\ No newline at end of file
diff --git a/src/Notesmaster/app/src/main/java/net/micode/notes/gtask/data/Task.java b/src/Notesmaster/app/src/main/java/net/micode/notes/gtask/data/Task.java
index 6a19454..e07afb5 100644
--- a/src/Notesmaster/app/src/main/java/net/micode/notes/gtask/data/Task.java
+++ b/src/Notesmaster/app/src/main/java/net/micode/notes/gtask/data/Task.java
@@ -31,70 +31,94 @@ import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;
-
+/**
+ * Task类继承自Node类，代表Google任务中的一个任务。
+ * 它负责处理任务的创建、更新操作，从JSON数据中设置任务内容，
+ * 生成本地JSON数据，以及判断同步操作类型等功能。
+ */
public class Task extends Node {
+ // 日志标签，用于标识该类的日志信息
private static final String TAG = Task.class.getSimpleName();
-
+ // 任务是否完成的标志
private boolean mCompleted;
-
+ // 任务的备注信息
private String mNotes;
-
+ // 任务的元信息，以JSON对象形式存储
private JSONObject mMetaInfo;
-
+ // 该任务的前一个兄弟任务
private Task mPriorSibling;
-
+ // 该任务所属的任务列表
private TaskList mParent;
+ /**
+ * 构造函数，初始化任务的各项属性。
+ */
public Task() {
+ // 调用父类的构造函数
super();
+ // 初始化任务为未完成状态
mCompleted = false;
+ // 初始化备注信息为空
mNotes = null;
+ // 初始化前一个兄弟任务为空
mPriorSibling = null;
+ // 初始化所属任务列表为空
mParent = null;
+ // 初始化元信息为空
mMetaInfo = null;
}
+ /**
+ * 生成创建任务的JSON操作对象。
+ *
+ * @param actionId 操作的唯一标识符
+ * @return 包含创建任务操作信息的JSON对象
+ * @throws ActionFailureException 如果生成JSON对象时发生异常
+ */
public JSONObject getCreateAction(int actionId) {
+ // 创建一个新的JSON对象
JSONObject js = new JSONObject();
try {
- // action_type
+ // 设置操作类型为创建任务
js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE,
GTaskStringUtils.GTASK_JSON_ACTION_TYPE_CREATE);
-
- // action_id
+ // 设置操作的唯一标识符
js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId);
-
- // index
+ // 设置任务在父任务列表中的索引
js.put(GTaskStringUtils.GTASK_JSON_INDEX, mParent.getChildTaskIndex(this));
- // entity_delta
+ // 创建实体差异的JSON对象
JSONObject entity = new JSONObject();
+ // 设置任务的名称
entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName());
+ // 设置任务的创建者ID为null
entity.put(GTaskStringUtils.GTASK_JSON_CREATOR_ID, "null");
+ // 设置实体类型为任务
entity.put(GTaskStringUtils.GTASK_JSON_ENTITY_TYPE,
GTaskStringUtils.GTASK_JSON_TYPE_TASK);
+ // 如果任务有备注信息，将其添加到实体差异中
if (getNotes() != null) {
entity.put(GTaskStringUtils.GTASK_JSON_NOTES, getNotes());
}
+ // 将实体差异添加到操作JSON对象中
js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity);
- // parent_id
+ // 设置父任务列表的全局ID
js.put(GTaskStringUtils.GTASK_JSON_PARENT_ID, mParent.getGid());
-
- // dest_parent_type
+ // 设置目标父任务类型为任务组
js.put(GTaskStringUtils.GTASK_JSON_DEST_PARENT_TYPE,
GTaskStringUtils.GTASK_JSON_TYPE_GROUP);
-
- // list_id
+ // 设置任务列表的全局ID
js.put(GTaskStringUtils.GTASK_JSON_LIST_ID, mParent.getGid());
- // prior_sibling_id
+ // 如果存在前一个兄弟任务，设置其全局ID
if (mPriorSibling != null) {
js.put(GTaskStringUtils.GTASK_JSON_PRIOR_SIBLING_ID, mPriorSibling.getGid());
}
} catch (JSONException e) {
+ // 记录错误日志并抛出异常
Log.e(TAG, e.toString());
e.printStackTrace();
throw new ActionFailureException("fail to generate task-create jsonobject");
@@ -103,30 +127,41 @@ public class Task extends Node {
return js;
}
+ /**
+ * 生成更新任务的JSON操作对象。
+ *
+ * @param actionId 操作的唯一标识符
+ * @return 包含更新任务操作信息的JSON对象
+ * @throws ActionFailureException 如果生成JSON对象时发生异常
+ */
public JSONObject getUpdateAction(int actionId) {
+ // 创建一个新的JSON对象
JSONObject js = new JSONObject();
try {
- // action_type
+ // 设置操作类型为更新任务
js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE,
GTaskStringUtils.GTASK_JSON_ACTION_TYPE_UPDATE);
-
- // action_id
+ // 设置操作的唯一标识符
js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId);
-
- // id
+ // 设置任务的全局ID
js.put(GTaskStringUtils.GTASK_JSON_ID, getGid());
- // entity_delta
+ // 创建实体差异的JSON对象
JSONObject entity = new JSONObject();
+ // 设置任务的名称
entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName());
+ // 如果任务有备注信息，将其添加到实体差异中
if (getNotes() != null) {
entity.put(GTaskStringUtils.GTASK_JSON_NOTES, getNotes());
}
+ // 设置任务是否被删除的标志
entity.put(GTaskStringUtils.GTASK_JSON_DELETED, getDeleted());
+ // 将实体差异添加到操作JSON对象中
js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity);
} catch (JSONException e) {
+ // 记录错误日志并抛出异常
Log.e(TAG, e.toString());
e.printStackTrace();
throw new ActionFailureException("fail to generate task-update jsonobject");
@@ -135,39 +170,41 @@ public class Task extends Node {
return js;
}
+ /**
+ * 根据远程JSON数据设置任务的内容。
+ *
+ * @param js 包含远程任务信息的JSON对象
+ * @throws ActionFailureException 如果解析JSON数据时发生异常
+ */
public void setContentByRemoteJSON(JSONObject js) {
if (js != null) {
try {
- // id
+ // 如果JSON对象包含任务的全局ID，设置任务的全局ID
if (js.has(GTaskStringUtils.GTASK_JSON_ID)) {
setGid(js.getString(GTaskStringUtils.GTASK_JSON_ID));
}
-
- // last_modified
+ // 如果JSON对象包含任务的最后修改时间，设置任务的最后修改时间
if (js.has(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)) {
setLastModified(js.getLong(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED));
}
-
- // name
+ // 如果JSON对象包含任务的名称，设置任务的名称
if (js.has(GTaskStringUtils.GTASK_JSON_NAME)) {
setName(js.getString(GTaskStringUtils.GTASK_JSON_NAME));
}
-
- // notes
+ // 如果JSON对象包含任务的备注信息，设置任务的备注信息
if (js.has(GTaskStringUtils.GTASK_JSON_NOTES)) {
setNotes(js.getString(GTaskStringUtils.GTASK_JSON_NOTES));
}
-
- // deleted
+ // 如果JSON对象包含任务是否被删除的标志，设置任务的删除状态
if (js.has(GTaskStringUtils.GTASK_JSON_DELETED)) {
setDeleted(js.getBoolean(GTaskStringUtils.GTASK_JSON_DELETED));
}
-
- // completed
+ // 如果JSON对象包含任务是否完成的标志，设置任务的完成状态
if (js.has(GTaskStringUtils.GTASK_JSON_COMPLETED)) {
setCompleted(js.getBoolean(GTaskStringUtils.GTASK_JSON_COMPLETED));
}
} catch (JSONException e) {
+ // 记录错误日志并抛出异常
Log.e(TAG, e.toString());
e.printStackTrace();
throw new ActionFailureException("fail to get task content from jsonobject");
@@ -175,135 +212,194 @@ public class Task extends Node {
}
}
+ /**
+ * 根据本地JSON数据设置任务的内容。
+ *
+ * @param js 包含本地任务信息的JSON对象
+ */
public void setContentByLocalJSON(JSONObject js) {
if (js == null || !js.has(GTaskStringUtils.META_HEAD_NOTE)
|| !js.has(GTaskStringUtils.META_HEAD_DATA)) {
+ // 记录警告日志，提示没有可用的信息
Log.w(TAG, "setContentByLocalJSON: nothing is avaiable");
}
try {
+ // 从JSON对象中获取笔记信息
JSONObject note = js.getJSONObject(GTaskStringUtils.META_HEAD_NOTE);
+ // 从JSON对象中获取数据数组
JSONArray dataArray = js.getJSONArray(GTaskStringUtils.META_HEAD_DATA);
+ // 检查笔记类型是否为普通笔记
if (note.getInt(NoteColumns.TYPE) != Notes.TYPE_NOTE) {
+ // 记录错误日志，提示类型无效
Log.e(TAG, "invalid type");
return;
}
+ // 遍历数据数组
for (int i = 0; i < dataArray.length(); i++) {
+ // 获取当前数据对象
JSONObject data = dataArray.getJSONObject(i);
+ // 检查数据的MIME类型是否为笔记类型
if (TextUtils.equals(data.getString(DataColumns.MIME_TYPE), DataConstants.NOTE)) {
+ // 设置任务的名称为数据的内容
setName(data.getString(DataColumns.CONTENT));
break;
}
}
} catch (JSONException e) {
+ // 记录错误日志并打印异常堆栈信息
Log.e(TAG, e.toString());
e.printStackTrace();
}
}
+ /**
+ * 根据任务的内容生成本地JSON对象。
+ *
+ * @return 包含任务本地信息的JSON对象，若发生异常则返回null
+ */
public JSONObject getLocalJSONFromContent() {
+ // 获取任务的名称
String name = getName();
try {
if (mMetaInfo == null) {
- // new task created from web
+ // 新创建的任务，从网页创建
if (name == null) {
+ // 记录警告日志，提示笔记为空
Log.w(TAG, "the note seems to be an empty one");
return null;
}
+ // 创建一个新的JSON对象
JSONObject js = new JSONObject();
+ // 创建笔记信息的JSON对象
JSONObject note = new JSONObject();
+ // 创建数据数组的JSON对象
JSONArray dataArray = new JSONArray();
+ // 创建数据的JSON对象
JSONObject data = new JSONObject();
+ // 设置数据的内容为任务的名称
data.put(DataColumns.CONTENT, name);
+ // 将数据添加到数据数组中
dataArray.put(data);
+ // 将数据数组添加到JSON对象中
js.put(GTaskStringUtils.META_HEAD_DATA, dataArray);
+ // 设置笔记类型为普通笔记
note.put(NoteColumns.TYPE, Notes.TYPE_NOTE);
+ // 将笔记信息添加到JSON对象中
js.put(GTaskStringUtils.META_HEAD_NOTE, note);
return js;
} else {
- // synced task
+ // 已同步的任务
+ // 从元信息中获取笔记信息
JSONObject note = mMetaInfo.getJSONObject(GTaskStringUtils.META_HEAD_NOTE);
+ // 从元信息中获取数据数组
JSONArray dataArray = mMetaInfo.getJSONArray(GTaskStringUtils.META_HEAD_DATA);
+ // 遍历数据数组
for (int i = 0; i < dataArray.length(); i++) {
+ // 获取当前数据对象
JSONObject data = dataArray.getJSONObject(i);
+ // 检查数据的MIME类型是否为笔记类型
if (TextUtils.equals(data.getString(DataColumns.MIME_TYPE), DataConstants.NOTE)) {
+ // 设置数据的内容为任务的名称
data.put(DataColumns.CONTENT, getName());
break;
}
}
+ // 设置笔记类型为普通笔记
note.put(NoteColumns.TYPE, Notes.TYPE_NOTE);
return mMetaInfo;
}
} catch (JSONException e) {
+ // 记录错误日志并打印异常堆栈信息
Log.e(TAG, e.toString());
e.printStackTrace();
return null;
}
}
+ /**
+ * 设置任务的元信息。
+ *
+ * @param metaData 包含元信息的MetaData对象
+ */
public void setMetaInfo(MetaData metaData) {
if (metaData != null && metaData.getNotes() != null) {
try {
+ // 将元信息的备注信息转换为JSON对象并设置为任务的元信息
mMetaInfo = new JSONObject(metaData.getNotes());
} catch (JSONException e) {
+ // 记录警告日志并将元信息设置为空
Log.w(TAG, e.toString());
mMetaInfo = null;
}
}
}
+ /**
+ * 根据数据库游标判断任务的同步操作类型。
+ *
+ * @param c 数据库游标
+ * @return 同步操作类型的常量值
+ */
public int getSyncAction(Cursor c) {
try {
+ // 从元信息中获取笔记信息
JSONObject noteInfo = null;
if (mMetaInfo != null && mMetaInfo.has(GTaskStringUtils.META_HEAD_NOTE)) {
noteInfo = mMetaInfo.getJSONObject(GTaskStringUtils.META_HEAD_NOTE);
}
if (noteInfo == null) {
+ // 记录警告日志，提示笔记元信息已被删除
Log.w(TAG, "it seems that note meta has been deleted");
return SYNC_ACTION_UPDATE_REMOTE;
}
if (!noteInfo.has(NoteColumns.ID)) {
+ // 记录警告日志，提示远程笔记ID已被删除
Log.w(TAG, "remote note id seems to be deleted");
return SYNC_ACTION_UPDATE_LOCAL;
}
- // validate the note id now
+ // 验证笔记ID是否匹配
if (c.getLong(SqlNote.ID_COLUMN) != noteInfo.getLong(NoteColumns.ID)) {
+ // 记录警告日志，提示笔记ID不匹配
Log.w(TAG, "note id doesn't match");
return SYNC_ACTION_UPDATE_LOCAL;
}
if (c.getInt(SqlNote.LOCAL_MODIFIED_COLUMN) == 0) {
- // there is no local update
+ // 本地没有更新
if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) {
- // no update both side
+ // 双方都没有更新
return SYNC_ACTION_NONE;
} else {
- // apply remote to local
+ // 应用远程更新到本地
return SYNC_ACTION_UPDATE_LOCAL;
}
} else {
- // validate gtask id
+ // 验证Google任务ID是否匹配
if (!c.getString(SqlNote.GTASK_ID_COLUMN).equals(getGid())) {
+ // 记录错误日志，提示Google任务ID不匹配
Log.e(TAG, "gtask id doesn't match");
return SYNC_ACTION_ERROR;
}
if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) {
- // local modification only
+ // 只有本地有修改
return SYNC_ACTION_UPDATE_REMOTE;
} else {
+ // 发生冲突
return SYNC_ACTION_UPDATE_CONFLICT;
}
}
} catch (Exception e) {
+ // 记录错误日志并打印异常堆栈信息
Log.e(TAG, e.toString());
e.printStackTrace();
}
@@ -311,41 +407,85 @@ public class Task extends Node {
return SYNC_ACTION_ERROR;
}
+ /**
+ * 判断任务是否值得保存。
+ *
+ * @return 如果任务有元信息、名称或备注信息，则返回true，否则返回false
+ */
public boolean isWorthSaving() {
return mMetaInfo != null || (getName() != null && getName().trim().length() > 0)
|| (getNotes() != null && getNotes().trim().length() > 0);
}
+ /**
+ * 设置任务的完成状态。
+ *
+ * @param completed 任务是否完成的标志
+ */
public void setCompleted(boolean completed) {
this.mCompleted = completed;
}
+ /**
+ * 设置任务的备注信息。
+ *
+ * @param notes 任务的备注信息
+ */
public void setNotes(String notes) {
this.mNotes = notes;
}
+ /**
+ * 设置任务的前一个兄弟任务。
+ *
+ * @param priorSibling 前一个兄弟任务
+ */
public void setPriorSibling(Task priorSibling) {
this.mPriorSibling = priorSibling;
}
+ /**
+ * 设置任务所属的任务列表。
+ *
+ * @param parent 任务所属的任务列表
+ */
public void setParent(TaskList parent) {
this.mParent = parent;
}
+ /**
+ * 获取任务的完成状态。
+ *
+ * @return 任务是否完成的标志
+ */
public boolean getCompleted() {
return this.mCompleted;
}
+ /**
+ * 获取任务的备注信息。
+ *
+ * @return 任务的备注信息
+ */
public String getNotes() {
return this.mNotes;
}
+ /**
+ * 获取任务的前一个兄弟任务。
+ *
+ * @return 前一个兄弟任务
+ */
public Task getPriorSibling() {
return this.mPriorSibling;
}
+ /**
+ * 获取任务所属的任务列表。
+ *
+ * @return 任务所属的任务列表
+ */
public TaskList getParent() {
return this.mParent;
}
-
-}
+}
\ No newline at end of file
diff --git a/src/Notesmaster/app/src/main/java/net/micode/notes/gtask/data/TaskList.java b/src/Notesmaster/app/src/main/java/net/micode/notes/gtask/data/TaskList.java
index 4ea21c5..125a080 100644
--- a/src/Notesmaster/app/src/main/java/net/micode/notes/gtask/data/TaskList.java
+++ b/src/Notesmaster/app/src/main/java/net/micode/notes/gtask/data/TaskList.java
@@ -29,43 +29,65 @@ import org.json.JSONObject;
import java.util.ArrayList;
-
+/**
+ * TaskList类继承自Node类，代表一个任务列表。
+ * 该类负责处理任务列表的创建、更新操作，根据JSON数据设置任务列表内容，
+ * 生成本地JSON数据，判断同步操作类型，以及管理任务列表中的子任务等功能。
+ */
public class TaskList extends Node {
+ // 日志标签，用于在日志中标识该类的相关信息
private static final String TAG = TaskList.class.getSimpleName();
-
+ // 任务列表在父级中的索引
private int mIndex;
-
+ // 存储任务列表中的子任务
private ArrayList mChildren;
+ /**
+ * 构造函数，初始化任务列表的各项属性。
+ */
public TaskList() {
+ // 调用父类的构造函数
super();
+ // 初始化子任务列表
mChildren = new ArrayList();
+ // 初始化索引为1
mIndex = 1;
}
+ /**
+ * 生成创建任务列表的JSON操作对象。
+ *
+ * @param actionId 操作的唯一标识符
+ * @return 包含创建任务列表操作信息的JSON对象
+ * @throws ActionFailureException 如果生成JSON对象时发生异常
+ */
public JSONObject getCreateAction(int actionId) {
+ // 创建一个新的JSON对象
JSONObject js = new JSONObject();
try {
- // action_type
+ // 设置操作类型为创建任务列表
js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE,
GTaskStringUtils.GTASK_JSON_ACTION_TYPE_CREATE);
-
- // action_id
+ // 设置操作的唯一标识符
js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId);
-
- // index
+ // 设置任务列表在父级中的索引
js.put(GTaskStringUtils.GTASK_JSON_INDEX, mIndex);
- // entity_delta
+ // 创建实体差异的JSON对象
JSONObject entity = new JSONObject();
+ // 设置任务列表的名称
entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName());
+ // 设置任务列表的创建者ID为null
entity.put(GTaskStringUtils.GTASK_JSON_CREATOR_ID, "null");
+ // 设置实体类型为任务组
entity.put(GTaskStringUtils.GTASK_JSON_ENTITY_TYPE,
GTaskStringUtils.GTASK_JSON_TYPE_GROUP);
+ // 将实体差异添加到操作JSON对象中
js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity);
} catch (JSONException e) {
+ // 记录错误日志并抛出异常
Log.e(TAG, e.toString());
e.printStackTrace();
throw new ActionFailureException("fail to generate tasklist-create jsonobject");
@@ -74,27 +96,37 @@ public class TaskList extends Node {
return js;
}
+ /**
+ * 生成更新任务列表的JSON操作对象。
+ *
+ * @param actionId 操作的唯一标识符
+ * @return 包含更新任务列表操作信息的JSON对象
+ * @throws ActionFailureException 如果生成JSON对象时发生异常
+ */
public JSONObject getUpdateAction(int actionId) {
+ // 创建一个新的JSON对象
JSONObject js = new JSONObject();
try {
- // action_type
+ // 设置操作类型为更新任务列表
js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE,
GTaskStringUtils.GTASK_JSON_ACTION_TYPE_UPDATE);
-
- // action_id
+ // 设置操作的唯一标识符
js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId);
-
- // id
+ // 设置任务列表的全局ID
js.put(GTaskStringUtils.GTASK_JSON_ID, getGid());
- // entity_delta
+ // 创建实体差异的JSON对象
JSONObject entity = new JSONObject();
+ // 设置任务列表的名称
entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName());
+ // 设置任务列表是否被删除的标志
entity.put(GTaskStringUtils.GTASK_JSON_DELETED, getDeleted());
+ // 将实体差异添加到操作JSON对象中
js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity);
} catch (JSONException e) {
+ // 记录错误日志并抛出异常
Log.e(TAG, e.toString());
e.printStackTrace();
throw new ActionFailureException("fail to generate tasklist-update jsonobject");
@@ -103,25 +135,29 @@ public class TaskList extends Node {
return js;
}
+ /**
+ * 根据远程JSON数据设置任务列表的内容。
+ *
+ * @param js 包含远程任务列表信息的JSON对象
+ * @throws ActionFailureException 如果解析JSON数据时发生异常
+ */
public void setContentByRemoteJSON(JSONObject js) {
if (js != null) {
try {
- // id
+ // 如果JSON对象包含任务列表的全局ID，设置任务列表的全局ID
if (js.has(GTaskStringUtils.GTASK_JSON_ID)) {
setGid(js.getString(GTaskStringUtils.GTASK_JSON_ID));
}
-
- // last_modified
+ // 如果JSON对象包含任务列表的最后修改时间，设置任务列表的最后修改时间
if (js.has(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)) {
setLastModified(js.getLong(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED));
}
-
- // name
+ // 如果JSON对象包含任务列表的名称，设置任务列表的名称
if (js.has(GTaskStringUtils.GTASK_JSON_NAME)) {
setName(js.getString(GTaskStringUtils.GTASK_JSON_NAME));
}
-
} catch (JSONException e) {
+ // 记录错误日志并抛出异常
Log.e(TAG, e.toString());
e.printStackTrace();
throw new ActionFailureException("fail to get tasklist content from jsonobject");
@@ -129,86 +165,124 @@ public class TaskList extends Node {
}
}
+ /**
+ * 根据本地JSON数据设置任务列表的内容。
+ *
+ * @param js 包含本地任务列表信息的JSON对象
+ */
public void setContentByLocalJSON(JSONObject js) {
if (js == null || !js.has(GTaskStringUtils.META_HEAD_NOTE)) {
+ // 记录警告日志，提示没有可用的信息
Log.w(TAG, "setContentByLocalJSON: nothing is avaiable");
}
try {
+ // 从JSON对象中获取文件夹信息
JSONObject folder = js.getJSONObject(GTaskStringUtils.META_HEAD_NOTE);
+ // 检查文件夹类型是否为普通文件夹
if (folder.getInt(NoteColumns.TYPE) == Notes.TYPE_FOLDER) {
+ // 获取文件夹的摘要作为名称，并添加前缀
String name = folder.getString(NoteColumns.SNIPPET);
setName(GTaskStringUtils.MIUI_FOLDER_PREFFIX + name);
- } else if (folder.getInt(NoteColumns.TYPE) == Notes.TYPE_SYSTEM) {
+ }
+ // 检查文件夹类型是否为系统文件夹
+ else if (folder.getInt(NoteColumns.TYPE) == Notes.TYPE_SYSTEM) {
+ // 根据系统文件夹的ID设置不同的名称
if (folder.getLong(NoteColumns.ID) == Notes.ID_ROOT_FOLDER)
setName(GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_DEFAULT);
else if (folder.getLong(NoteColumns.ID) == Notes.ID_CALL_RECORD_FOLDER)
setName(GTaskStringUtils.MIUI_FOLDER_PREFFIX
+ GTaskStringUtils.FOLDER_CALL_NOTE);
else
+ // 记录错误日志，提示无效的系统文件夹
Log.e(TAG, "invalid system folder");
- } else {
+ }
+ else {
+ // 记录错误日志，提示类型错误
Log.e(TAG, "error type");
}
} catch (JSONException e) {
+ // 记录错误日志并打印异常堆栈信息
Log.e(TAG, e.toString());
e.printStackTrace();
}
}
+ /**
+ * 根据任务列表的内容生成本地JSON对象。
+ *
+ * @return 包含任务列表本地信息的JSON对象，若发生异常则返回null
+ */
public JSONObject getLocalJSONFromContent() {
try {
+ // 创建一个新的JSON对象
JSONObject js = new JSONObject();
+ // 创建文件夹信息的JSON对象
JSONObject folder = new JSONObject();
+ // 获取任务列表的名称
String folderName = getName();
+ // 如果名称以特定前缀开头，去除前缀
if (getName().startsWith(GTaskStringUtils.MIUI_FOLDER_PREFFIX))
folderName = folderName.substring(GTaskStringUtils.MIUI_FOLDER_PREFFIX.length(),
folderName.length());
+ // 将文件夹名称添加到文件夹信息的JSON对象中
folder.put(NoteColumns.SNIPPET, folderName);
+ // 根据文件夹名称判断类型，并添加到文件夹信息的JSON对象中
if (folderName.equals(GTaskStringUtils.FOLDER_DEFAULT)
|| folderName.equals(GTaskStringUtils.FOLDER_CALL_NOTE))
folder.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM);
else
folder.put(NoteColumns.TYPE, Notes.TYPE_FOLDER);
+ // 将文件夹信息添加到JSON对象中
js.put(GTaskStringUtils.META_HEAD_NOTE, folder);
return js;
} catch (JSONException e) {
+ // 记录错误日志并打印异常堆栈信息
Log.e(TAG, e.toString());
e.printStackTrace();
return null;
}
}
+ /**
+ * 根据数据库游标判断任务列表的同步操作类型。
+ *
+ * @param c 数据库游标
+ * @return 同步操作类型的常量值
+ */
public int getSyncAction(Cursor c) {
try {
+ // 检查本地是否有更新
if (c.getInt(SqlNote.LOCAL_MODIFIED_COLUMN) == 0) {
- // there is no local update
+ // 本地没有更新
if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) {
- // no update both side
+ // 双方都没有更新
return SYNC_ACTION_NONE;
} else {
- // apply remote to local
+ // 应用远程更新到本地
return SYNC_ACTION_UPDATE_LOCAL;
}
} else {
- // validate gtask id
+ // 验证Google任务ID是否匹配
if (!c.getString(SqlNote.GTASK_ID_COLUMN).equals(getGid())) {
+ // 记录错误日志，提示Google任务ID不匹配
Log.e(TAG, "gtask id doesn't match");
return SYNC_ACTION_ERROR;
}
if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) {
- // local modification only
+ // 只有本地有修改
return SYNC_ACTION_UPDATE_REMOTE;
} else {
- // for folder conflicts, just apply local modification
+ // 对于文件夹冲突，应用本地修改
return SYNC_ACTION_UPDATE_REMOTE;
}
}
} catch (Exception e) {
+ // 记录错误日志并打印异常堆栈信息
Log.e(TAG, e.toString());
e.printStackTrace();
}
@@ -216,16 +290,28 @@ public class TaskList extends Node {
return SYNC_ACTION_ERROR;
}
+ /**
+ * 获取任务列表中的子任务数量。
+ *
+ * @return 子任务的数量
+ */
public int getChildTaskCount() {
return mChildren.size();
}
+ /**
+ * 向任务列表中添加一个子任务。
+ *
+ * @param task 要添加的子任务
+ * @return 添加成功返回true，失败返回false
+ */
public boolean addChildTask(Task task) {
boolean ret = false;
if (task != null && !mChildren.contains(task)) {
+ // 将子任务添加到列表中
ret = mChildren.add(task);
if (ret) {
- // need to set prior sibling and parent
+ // 设置子任务的前一个兄弟任务和父任务列表
task.setPriorSibling(mChildren.isEmpty() ? null : mChildren
.get(mChildren.size() - 1));
task.setParent(this);
@@ -234,17 +320,27 @@ public class TaskList extends Node {
return ret;
}
+ /**
+ * 在指定位置向任务列表中添加一个子任务。
+ *
+ * @param task 要添加的子任务
+ * @param index 指定的位置
+ * @return 添加成功返回true，失败返回false
+ */
public boolean addChildTask(Task task, int index) {
if (index < 0 || index > mChildren.size()) {
+ // 记录错误日志，提示索引无效
Log.e(TAG, "add child task: invalid index");
return false;
}
+ // 检查任务是否已存在于列表中
int pos = mChildren.indexOf(task);
if (task != null && pos == -1) {
+ // 在指定位置插入子任务
mChildren.add(index, task);
- // update the task list
+ // 更新任务列表中相关任务的前一个兄弟任务
Task preTask = null;
Task afterTask = null;
if (index != 0)
@@ -260,18 +356,26 @@ public class TaskList extends Node {
return true;
}
+ /**
+ * 从任务列表中移除一个子任务。
+ *
+ * @param task 要移除的子任务
+ * @return 移除成功返回true，失败返回false
+ */
public boolean removeChildTask(Task task) {
boolean ret = false;
+ // 获取子任务在列表中的索引
int index = mChildren.indexOf(task);
if (index != -1) {
+ // 从列表中移除子任务
ret = mChildren.remove(task);
if (ret) {
- // reset prior sibling and parent
+ // 重置子任务的前一个兄弟任务和父任务列表
task.setPriorSibling(null);
task.setParent(null);
- // update the task list
+ // 更新任务列表中相关任务的前一个兄弟任务
if (index != mChildren.size()) {
mChildren.get(index).setPriorSibling(
index == 0 ? null : mChildren.get(index - 1));
@@ -281,26 +385,43 @@ public class TaskList extends Node {
return ret;
}
+ /**
+ * 将一个子任务移动到指定位置。
+ *
+ * @param task 要移动的子任务
+ * @param index 指定的位置
+ * @return 移动成功返回true，失败返回false
+ */
public boolean moveChildTask(Task task, int index) {
-
if (index < 0 || index >= mChildren.size()) {
+ // 记录错误日志，提示索引无效
Log.e(TAG, "move child task: invalid index");
return false;
}
+ // 检查任务是否存在于列表中
int pos = mChildren.indexOf(task);
if (pos == -1) {
+ // 记录错误日志，提示任务不在列表中
Log.e(TAG, "move child task: the task should in the list");
return false;
}
if (pos == index)
return true;
+ // 先移除任务，再在指定位置添加任务
return (removeChildTask(task) && addChildTask(task, index));
}
+ /**
+ * 根据全局ID查找任务列表中的子任务。
+ *
+ * @param gid 子任务的全局ID
+ * @return 找到的子任务，若未找到则返回null
+ */
public Task findChildTaskByGid(String gid) {
for (int i = 0; i < mChildren.size(); i++) {
+ // 获取当前子任务
Task t = mChildren.get(i);
if (t.getGid().equals(gid)) {
return t;
@@ -309,18 +430,37 @@ public class TaskList extends Node {
return null;
}
+ /**
+ * 获取指定子任务在任务列表中的索引。
+ *
+ * @param task 要查找索引的子任务
+ * @return 子任务的索引，若未找到则返回-1
+ */
public int getChildTaskIndex(Task task) {
return mChildren.indexOf(task);
}
+ /**
+ * 根据索引获取任务列表中的子任务。
+ *
+ * @param index 子任务的索引
+ * @return 找到的子任务，若索引无效则返回null
+ */
public Task getChildTaskByIndex(int index) {
if (index < 0 || index >= mChildren.size()) {
+ // 记录错误日志，提示索引无效
Log.e(TAG, "getTaskByIndex: invalid index");
return null;
}
return mChildren.get(index);
}
+ /**
+ * 根据全局ID获取任务列表中的子任务。
+ *
+ * @param gid 子任务的全局ID
+ * @return 找到的子任务，若未找到则返回null
+ */
public Task getChilTaskByGid(String gid) {
for (Task task : mChildren) {
if (task.getGid().equals(gid))
@@ -329,15 +469,30 @@ public class TaskList extends Node {
return null;
}
+ /**
+ * 获取任务列表中的所有子任务。
+ *
+ * @return 包含所有子任务的列表
+ */
public ArrayList getChildTaskList() {
return this.mChildren;
}
+ /**
+ * 设置任务列表在父级中的索引。
+ *
+ * @param index 要设置的索引
+ */
public void setIndex(int index) {
this.mIndex = index;
}
+ /**
+ * 获取任务列表在父级中的索引。
+ *
+ * @return 任务列表的索引
+ */
public int getIndex() {
return this.mIndex;
}
-}
+}
\ No newline at end of file
diff --git a/src/Notesmaster/app/src/main/java/net/micode/notes/gtask/remote/GTaskASyncTask.java b/src/Notesmaster/app/src/main/java/net/micode/notes/gtask/remote/GTaskASyncTask.java
index 8c550a8..fa70f49 100644
--- a/src/Notesmaster/app/src/main/java/net/micode/notes/gtask/remote/GTaskASyncTask.java
+++ b/src/Notesmaster/app/src/main/java/net/micode/notes/gtask/remote/GTaskASyncTask.java
@@ -1,4 +1,3 @@
-
/*
* Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net)
*
@@ -28,68 +27,84 @@ import net.micode.notes.R;
import net.micode.notes.ui.NotesListActivity;
import net.micode.notes.ui.NotesPreferenceActivity;
-
+/**
+ * GTaskASyncTask类继承自AsyncTask，用于在后台执行Google任务同步操作，
+ * 并在同步过程中更新通知，同时支持取消同步操作。
+ */
public class GTaskASyncTask extends AsyncTask {
+ // 通知的唯一标识符
private static int GTASK_SYNC_NOTIFICATION_ID = 5234235;
+ /**
+ * 定义同步完成的监听器接口
+ */
public interface OnCompleteListener {
+ /**
+ * 同步完成时调用的方法
+ */
void onComplete();
}
+ // 上下文对象
private Context mContext;
-
+ // 通知管理器
private NotificationManager mNotifiManager;
-
+ // Google任务管理器实例
private GTaskManager mTaskManager;
-
+ // 同步完成监听器
private OnCompleteListener mOnCompleteListener;
+ /**
+ * 构造函数，初始化任务所需的上下文、监听器、通知管理器和任务管理器。
+ *
+ * @param context 上下文对象
+ * @param listener 同步完成监听器
+ */
public GTaskASyncTask(Context context, OnCompleteListener listener) {
mContext = context;
mOnCompleteListener = listener;
+ // 获取通知服务
mNotifiManager = (NotificationManager) mContext
.getSystemService(Context.NOTIFICATION_SERVICE);
+ // 获取GTaskManager实例
mTaskManager = GTaskManager.getInstance();
}
+ /**
+ * 取消同步操作
+ */
public void cancelSync() {
mTaskManager.cancelSync();
}
+ /**
+ * 发布同步进度消息
+ *
+ * @param message 进度消息
+ */
public void publishProgess(String message) {
- publishProgress(new String[] {
- message
- });
+ publishProgress(new String[]{message});
}
+ /**
+ * 显示通知
+ *
+ * @param tickerId 通知的提示信息资源ID
+ * @param content 通知的内容
+ */
private void showNotification(int tickerId, String content) {
-
-// Notification.Builder builder = new Notification.Builder();
-// builder.setContentInfo("补充内容");
-// builder.setContentText("主内容区");
-// builder.setContentTitle("通知标题");
-// builder.setSmallIcon(R.mipmap.icon_demo);
-// builder.setTicker("新消息");
-// builder.setAutoCancel(true);
-// builder.setWhen(System.currentTimeMillis());
-// Intent intent = new Intent(getActivity(), MainActivity.class);
-// PendingIntent pendingIntent = PendingIntent.getActivity(getActivity(), 0, intent, PendingIntent.FLAG_CANCEL_CURRENT);
-// builder.setContentIntent(pendingIntent);
-// Notification notification = builder.build();
-// manager.notify(NOTIFICATION_ID, notification);
-
-
PendingIntent pendingIntent;
+ // 根据tickerId设置不同的PendingIntent
if (tickerId != R.string.ticker_success) {
pendingIntent = PendingIntent.getActivity(mContext, 0, new Intent(mContext,
NotesPreferenceActivity.class), 0);
-
} else {
pendingIntent = PendingIntent.getActivity(mContext, 0, new Intent(mContext,
NotesListActivity.class), 0);
}
+ // 构建通知
Notification.Builder builder = new Notification.Builder(mContext)
.setAutoCancel(true)
.setContentTitle("title")
@@ -98,48 +113,77 @@ public class GTaskASyncTask extends AsyncTask {
.setWhen(System.currentTimeMillis())
.setOngoing(true);
Notification notification = builder.getNotification();
+ // 设置通知的默认灯光效果
notification.defaults = Notification.DEFAULT_LIGHTS;
+ // 设置通知点击后自动取消
notification.flags = Notification.FLAG_AUTO_CANCEL;
+ // 发送通知
mNotifiManager.notify(GTASK_SYNC_NOTIFICATION_ID, notification);
}
+ /**
+ * 在后台线程中执行同步操作
+ *
+ * @param unused 未使用的参数
+ * @return 同步操作的结果状态码
+ */
@Override
protected Integer doInBackground(Void... unused) {
+ // 发布登录进度消息
publishProgess(mContext.getString(R.string.sync_progress_login, NotesPreferenceActivity
.getSyncAccountName(mContext)));
+ // 执行同步操作并返回结果
return mTaskManager.sync(mContext, this);
}
+ /**
+ * 在UI线程中更新同步进度
+ *
+ * @param progress 进度消息数组
+ */
@Override
protected void onProgressUpdate(String... progress) {
+ // 显示同步中的通知
showNotification(R.string.ticker_syncing, progress[0]);
if (mContext instanceof GTaskSyncService) {
+ // 如果上下文是GTaskSyncService，发送广播
((GTaskSyncService) mContext).sendBroadcast(progress[0]);
}
}
+ /**
+ * 在同步操作完成后执行的操作
+ *
+ * @param result 同步操作的结果状态码
+ */
@Override
protected void onPostExecute(Integer result) {
if (result == GTaskManager.STATE_SUCCESS) {
+ // 同步成功，显示成功通知
showNotification(R.string.ticker_success, mContext.getString(
R.string.success_sync_account, mTaskManager.getSyncAccount()));
+ // 记录最后同步时间
NotesPreferenceActivity.setLastSyncTime(mContext, System.currentTimeMillis());
} else if (result == GTaskManager.STATE_NETWORK_ERROR) {
+ // 网络错误，显示网络错误通知
showNotification(R.string.ticker_fail, mContext.getString(R.string.error_sync_network));
} else if (result == GTaskManager.STATE_INTERNAL_ERROR) {
+ // 内部错误，显示内部错误通知
showNotification(R.string.ticker_fail, mContext.getString(R.string.error_sync_internal));
} else if (result == GTaskManager.STATE_SYNC_CANCELLED) {
+ // 同步取消，显示取消通知
showNotification(R.string.ticker_cancel, mContext
.getString(R.string.error_sync_cancelled));
}
if (mOnCompleteListener != null) {
+ // 启动新线程调用完成监听器的方法
new Thread(new Runnable() {
-
+ @Override
public void run() {
mOnCompleteListener.onComplete();
}
}).start();
}
}
-}
+}
\ No newline at end of file
diff --git a/src/Notesmaster/app/src/main/java/net/micode/notes/gtask/remote/GTaskClient.java b/src/Notesmaster/app/src/main/java/net/micode/notes/gtask/remote/GTaskClient.java
index c67dfdf..da4f105 100644
--- a/src/Notesmaster/app/src/main/java/net/micode/notes/gtask/remote/GTaskClient.java
+++ b/src/Notesmaster/app/src/main/java/net/micode/notes/gtask/remote/GTaskClient.java
@@ -60,36 +60,43 @@ import java.util.zip.GZIPInputStream;
import java.util.zip.Inflater;
import java.util.zip.InflaterInputStream;
-
+/**
+ * GTaskClient类用于与Google Tasks服务进行交互，包括登录、创建任务、创建任务列表、
+ * 提交更新、移动任务、删除节点、获取任务列表等操作。
+ */
public class GTaskClient {
+ // 日志标签
private static final String TAG = GTaskClient.class.getSimpleName();
-
+ // Google Tasks的基础URL
private static final String GTASK_URL = "https://mail.google.com/tasks/";
-
+ // 获取任务列表的URL
private static final String GTASK_GET_URL = "https://mail.google.com/tasks/ig";
-
+ // 提交任务操作的URL
private static final String GTASK_POST_URL = "https://mail.google.com/tasks/r/ig";
-
+ // 单例实例
private static GTaskClient mInstance = null;
-
+ // HTTP客户端
private DefaultHttpClient mHttpClient;
-
+ // 当前使用的获取任务列表的URL
private String mGetUrl;
-
+ // 当前使用的提交任务操作的URL
private String mPostUrl;
-
+ // 客户端版本号
private long mClientVersion;
-
+ // 是否登录的标志
private boolean mLoggedin;
-
+ // 最后登录时间
private long mLastLoginTime;
-
+ // 操作ID
private int mActionId;
-
+ // 同步账户
private Account mAccount;
-
+ // 更新操作数组
private JSONArray mUpdateArray;
+ /**
+ * 私有构造函数，初始化客户端的各项属性。
+ */
private GTaskClient() {
mHttpClient = null;
mGetUrl = GTASK_GET_URL;
@@ -102,6 +109,11 @@ public class GTaskClient {
mUpdateArray = null;
}
+ /**
+ * 获取GTaskClient的单例实例。
+ *
+ * @return GTaskClient的单例实例
+ */
public static synchronized GTaskClient getInstance() {
if (mInstance == null) {
mInstance = new GTaskClient();
@@ -109,18 +121,23 @@ public class GTaskClient {
return mInstance;
}
+ /**
+ * 登录Google Tasks服务。
+ *
+ * @param activity 当前活动
+ * @return 登录成功返回true，失败返回false
+ */
public boolean login(Activity activity) {
- // we suppose that the cookie would expire after 5 minutes
- // then we need to re-login
+ // 假设cookie在5分钟后过期，需要重新登录
final long interval = 1000 * 60 * 5;
if (mLastLoginTime + interval < System.currentTimeMillis()) {
mLoggedin = false;
}
- // need to re-login after account switch
+ // 账户切换后需要重新登录
if (mLoggedin
&& !TextUtils.equals(getSyncAccount().name, NotesPreferenceActivity
- .getSyncAccountName(activity))) {
+ .getSyncAccountName(activity))) {
mLoggedin = false;
}
@@ -136,7 +153,7 @@ public class GTaskClient {
return false;
}
- // login with custom domain if necessary
+ // 如果是自定义域名账户，尝试使用自定义域名登录
if (!(mAccount.name.toLowerCase().endsWith("gmail.com") || mAccount.name.toLowerCase()
.endsWith("googlemail.com"))) {
StringBuilder url = new StringBuilder(GTASK_URL).append("a/");
@@ -151,7 +168,7 @@ public class GTaskClient {
}
}
- // try to login with google official url
+ // 如果自定义域名登录失败，尝试使用Google官方URL登录
if (!mLoggedin) {
mGetUrl = GTASK_GET_URL;
mPostUrl = GTASK_POST_URL;
@@ -164,6 +181,13 @@ public class GTaskClient {
return true;
}
+ /**
+ * 登录Google账户获取认证令牌。
+ *
+ * @param activity 当前活动
+ * @param invalidateToken 是否使现有令牌无效
+ * @return 认证令牌，失败返回null
+ */
private String loginGoogleAccount(Activity activity, boolean invalidateToken) {
String authToken;
AccountManager accountManager = AccountManager.get(activity);
@@ -189,7 +213,7 @@ public class GTaskClient {
return null;
}
- // get the token now
+ // 获取认证令牌
AccountManagerFuture accountManagerFuture = accountManager.getAuthToken(account,
"goanna_mobile", null, activity, null, null);
try {
@@ -197,7 +221,7 @@ public class GTaskClient {
authToken = authTokenBundle.getString(AccountManager.KEY_AUTHTOKEN);
if (invalidateToken) {
accountManager.invalidateAuthToken("com.google", authToken);
- loginGoogleAccount(activity, false);
+ return loginGoogleAccount(activity, false);
}
} catch (Exception e) {
Log.e(TAG, "get auth token failed");
@@ -207,10 +231,16 @@ public class GTaskClient {
return authToken;
}
+ /**
+ * 尝试登录Google Tasks服务。
+ *
+ * @param activity 当前活动
+ * @param authToken 认证令牌
+ * @return 登录成功返回true，失败返回false
+ */
private boolean tryToLoginGtask(Activity activity, String authToken) {
if (!loginGtask(authToken)) {
- // maybe the auth token is out of date, now let's invalidate the
- // token and try again
+ // 可能认证令牌过期，使令牌无效并重新尝试登录
authToken = loginGoogleAccount(activity, true);
if (authToken == null) {
Log.e(TAG, "login google account failed");
@@ -225,6 +255,12 @@ public class GTaskClient {
return true;
}
+ /**
+ * 使用认证令牌登录Google Tasks服务。
+ *
+ * @param authToken 认证令牌
+ * @return 登录成功返回true，失败返回false
+ */
private boolean loginGtask(String authToken) {
int timeoutConnection = 10000;
int timeoutSocket = 15000;
@@ -236,14 +272,14 @@ public class GTaskClient {
mHttpClient.setCookieStore(localBasicCookieStore);
HttpProtocolParams.setUseExpectContinue(mHttpClient.getParams(), false);
- // login gtask
+ // 登录Google Tasks
try {
String loginUrl = mGetUrl + "?auth=" + authToken;
HttpGet httpGet = new HttpGet(loginUrl);
HttpResponse response = null;
response = mHttpClient.execute(httpGet);
- // get the cookie now
+ // 获取cookie
List cookies = mHttpClient.getCookieStore().getCookies();
boolean hasAuthCookie = false;
for (Cookie cookie : cookies) {
@@ -255,7 +291,7 @@ public class GTaskClient {
Log.w(TAG, "it seems that there is no auth cookie");
}
- // get the client version
+ // 获取客户端版本号
String resString = getResponseContent(response.getEntity());
String jsBegin = "_setup(";
String jsEnd = ")}";
@@ -272,7 +308,7 @@ public class GTaskClient {
e.printStackTrace();
return false;
} catch (Exception e) {
- // simply catch all exceptions
+ // 捕获所有异常
Log.e(TAG, "httpget gtask_url failed");
return false;
}
@@ -280,10 +316,20 @@ public class GTaskClient {
return true;
}
+ /**
+ * 获取下一个操作ID。
+ *
+ * @return 操作ID
+ */
private int getActionId() {
return mActionId++;
}
+ /**
+ * 创建一个HttpPost请求对象。
+ *
+ * @return HttpPost请求对象
+ */
private HttpPost createHttpPost() {
HttpPost httpPost = new HttpPost(mPostUrl);
httpPost.setHeader("Content-Type", "application/x-www-form-urlencoded;charset=utf-8");
@@ -291,6 +337,13 @@ public class GTaskClient {
return httpPost;
}
+ /**
+ * 获取HTTP响应的内容。
+ *
+ * @param entity HTTP实体
+ * @return 响应内容
+ * @throws IOException 读取内容时发生的IO异常
+ */
private String getResponseContent(HttpEntity entity) throws IOException {
String contentEncoding = null;
if (entity.getContentEncoding() != null) {
@@ -323,6 +376,13 @@ public class GTaskClient {
}
}
+ /**
+ * 发送POST请求并返回响应的JSON对象。
+ *
+ * @param js 请求的JSON对象
+ * @return 响应的JSON对象
+ * @throws NetworkFailureException 网络请求失败异常
+ */
private JSONObject postRequest(JSONObject js) throws NetworkFailureException {
if (!mLoggedin) {
Log.e(TAG, "please login first");
@@ -336,7 +396,7 @@ public class GTaskClient {
UrlEncodedFormEntity entity = new UrlEncodedFormEntity(list, "UTF-8");
httpPost.setEntity(entity);
- // execute the post
+ // 执行POST请求
HttpResponse response = mHttpClient.execute(httpPost);
String jsString = getResponseContent(response.getEntity());
return new JSONObject(jsString);
@@ -360,20 +420,26 @@ public class GTaskClient {
}
}
+ /**
+ * 创建一个新的任务。
+ *
+ * @param task 要创建的任务
+ * @throws NetworkFailureException 网络请求失败异常
+ */
public void createTask(Task task) throws NetworkFailureException {
commitUpdate();
try {
JSONObject jsPost = new JSONObject();
JSONArray actionList = new JSONArray();
- // action_list
+ // 操作列表
actionList.put(task.getCreateAction(getActionId()));
jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, actionList);
- // client_version
+ // 客户端版本号
jsPost.put(GTaskStringUtils.GTASK_JSON_CLIENT_VERSION, mClientVersion);
- // post
+ // 发送POST请求
JSONObject jsResponse = postRequest(jsPost);
JSONObject jsResult = (JSONObject) jsResponse.getJSONArray(
GTaskStringUtils.GTASK_JSON_RESULTS).get(0);
@@ -386,20 +452,26 @@ public class GTaskClient {
}
}
+ /**
+ * 创建一个新的任务列表。
+ *
+ * @param tasklist 要创建的任务列表
+ * @throws NetworkFailureException 网络请求失败异常
+ */
public void createTaskList(TaskList tasklist) throws NetworkFailureException {
commitUpdate();
try {
JSONObject jsPost = new JSONObject();
JSONArray actionList = new JSONArray();
- // action_list
+ // 操作列表
actionList.put(tasklist.getCreateAction(getActionId()));
jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, actionList);
- // client version
+ // 客户端版本号
jsPost.put(GTaskStringUtils.GTASK_JSON_CLIENT_VERSION, mClientVersion);
- // post
+ // 发送POST请求
JSONObject jsResponse = postRequest(jsPost);
JSONObject jsResult = (JSONObject) jsResponse.getJSONArray(
GTaskStringUtils.GTASK_JSON_RESULTS).get(0);
@@ -412,15 +484,20 @@ public class GTaskClient {
}
}
+ /**
+ * 提交更新操作。
+ *
+ * @throws NetworkFailureException 网络请求失败异常
+ */
public void commitUpdate() throws NetworkFailureException {
if (mUpdateArray != null) {
try {
JSONObject jsPost = new JSONObject();
- // action_list
+ // 操作列表
jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, mUpdateArray);
- // client_version
+ // 客户端版本号
jsPost.put(GTaskStringUtils.GTASK_JSON_CLIENT_VERSION, mClientVersion);
postRequest(jsPost);
@@ -433,10 +510,15 @@ public class GTaskClient {
}
}
+ /**
+ * 添加一个更新节点到更新操作数组。
+ *
+ * @param node 要添加的更新节点
+ * @throws NetworkFailureException 网络请求失败异常
+ */
public void addUpdateNode(Node node) throws NetworkFailureException {
if (node != null) {
- // too many update items may result in an error
- // set max to 10 items
+ // 避免更新项过多导致错误，最多10项
if (mUpdateArray != null && mUpdateArray.length() > 10) {
commitUpdate();
}
@@ -447,6 +529,14 @@ public class GTaskClient {
}
}
+ /**
+ * 移动一个任务到另一个任务列表。
+ *
+ * @param task 要移动的任务
+ * @param preParent 任务原来的父任务列表
+ * @param curParent 任务要移动到的父任务列表
+ * @throws NetworkFailureException 网络请求失败异常
+ */
public void moveTask(Task task, TaskList preParent, TaskList curParent)
throws NetworkFailureException {
commitUpdate();
@@ -455,26 +545,25 @@ public class GTaskClient {
JSONArray actionList = new JSONArray();
JSONObject action = new JSONObject();
- // action_list
+ // 操作列表
action.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE,
GTaskStringUtils.GTASK_JSON_ACTION_TYPE_MOVE);
action.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, getActionId());
action.put(GTaskStringUtils.GTASK_JSON_ID, task.getGid());
if (preParent == curParent && task.getPriorSibling() != null) {
- // put prioring_sibing_id only if moving within the tasklist and
- // it is not the first one
+ // 如果在同一任务列表内移动且不是第一个任务，设置前一个兄弟任务ID
action.put(GTaskStringUtils.GTASK_JSON_PRIOR_SIBLING_ID, task.getPriorSibling());
}
action.put(GTaskStringUtils.GTASK_JSON_SOURCE_LIST, preParent.getGid());
action.put(GTaskStringUtils.GTASK_JSON_DEST_PARENT, curParent.getGid());
if (preParent != curParent) {
- // put the dest_list only if moving between tasklists
+ // 如果在不同任务列表之间移动，设置目标任务列表ID
action.put(GTaskStringUtils.GTASK_JSON_DEST_LIST, curParent.getGid());
}
actionList.put(action);
jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, actionList);
- // client_version
+ // 客户端版本号
jsPost.put(GTaskStringUtils.GTASK_JSON_CLIENT_VERSION, mClientVersion);
postRequest(jsPost);
@@ -486,18 +575,24 @@ public class GTaskClient {
}
}
+ /**
+ * 删除一个节点。
+ *
+ * @param node 要删除的节点
+ * @throws NetworkFailureException 网络请求失败异常
+ */
public void deleteNode(Node node) throws NetworkFailureException {
commitUpdate();
try {
JSONObject jsPost = new JSONObject();
JSONArray actionList = new JSONArray();
- // action_list
+ // 操作列表
node.setDeleted(true);
actionList.put(node.getUpdateAction(getActionId()));
jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, actionList);
- // client_version
+ // 客户端版本号
jsPost.put(GTaskStringUtils.GTASK_JSON_CLIENT_VERSION, mClientVersion);
postRequest(jsPost);
@@ -509,6 +604,12 @@ public class GTaskClient {
}
}
+ /**
+ * 获取所有任务列表。
+ *
+ * @return 任务列表的JSON数组
+ * @throws NetworkFailureException 网络请求失败异常
+ */
public JSONArray getTaskLists() throws NetworkFailureException {
if (!mLoggedin) {
Log.e(TAG, "please login first");
@@ -520,7 +621,7 @@ public class GTaskClient {
HttpResponse response = null;
response = mHttpClient.execute(httpGet);
- // get the task list
+ // 获取任务列表
String resString = getResponseContent(response.getEntity());
String jsBegin = "_setup(";
String jsEnd = ")}";
@@ -547,6 +648,13 @@ public class GTaskClient {
}
}
+ /**
+ * 获取指定任务列表中的任务。
+ *
+ * @param listGid 任务列表的全局ID
+ * @return 任务的JSON数组
+ * @throws NetworkFailureException 网络请求失败异常
+ */
public JSONArray getTaskList(String listGid) throws NetworkFailureException {
commitUpdate();
try {
@@ -554,7 +662,7 @@ public class GTaskClient {
JSONArray actionList = new JSONArray();
JSONObject action = new JSONObject();
- // action_list
+ // 操作列表
action.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE,
GTaskStringUtils.GTASK_JSON_ACTION_TYPE_GETALL);
action.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, getActionId());
@@ -563,7 +671,7 @@ public class GTaskClient {
actionList.put(action);
jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, actionList);
- // client_version
+ // 客户端版本号
jsPost.put(GTaskStringUtils.GTASK_JSON_CLIENT_VERSION, mClientVersion);
JSONObject jsResponse = postRequest(jsPost);
@@ -575,11 +683,19 @@ public class GTaskClient {
}
}
+ /**
+ * 获取当前同步的账户。
+ *
+ * @return 同步账户
+ */
public Account getSyncAccount() {
return mAccount;
}
+ /**
+ * 重置更新操作数组。
+ */
public void resetUpdateArray() {
mUpdateArray = null;
}
-}
+}
\ No newline at end of file
diff --git a/src/Notesmaster/app/src/main/java/net/micode/notes/gtask/remote/GTaskSyncService.java b/src/Notesmaster/app/src/main/java/net/micode/notes/gtask/remote/GTaskSyncService.java
index cca36f7..dc4e4f8 100644
--- a/src/Notesmaster/app/src/main/java/net/micode/notes/gtask/remote/GTaskSyncService.java
+++ b/src/Notesmaster/app/src/main/java/net/micode/notes/gtask/remote/GTaskSyncService.java
@@ -14,115 +14,222 @@
* limitations under the License.
*/
+// 声明包名，该服务属于 net.micode.notes.gtask.remote 包
package net.micode.notes.gtask.remote;
+// 导入 Activity 类，用于表示 Android 应用中的一个屏幕界面
import android.app.Activity;
+// 导入 Service 类，这是该类的基类，用于实现后台服务
import android.app.Service;
+// 导入 Context 类，用于提供应用程序的环境信息
import android.content.Context;
+// 导入 Intent 类，用于在不同组件间传递消息和启动操作
import android.content.Intent;
+// 导入 Bundle 类，用于在组件间传递数据
import android.os.Bundle;
+// 导入 IBinder 类，用于在不同进程间进行通信
import android.os.IBinder;
+/**
+ * GTaskSyncService 类继承自 Service，用于处理 GTask 的同步服务。
+ * 该服务提供了启动同步、取消同步等功能，并通过广播通知同步状态和进度。
+ */
public class GTaskSyncService extends Service {
+ // 定义一个常量字符串，用于在 Intent 中传递同步操作的类型
public final static String ACTION_STRING_NAME = "sync_action_type";
-
+ // 定义一个常量整数，表示启动同步的操作
public final static int ACTION_START_SYNC = 0;
-
+ // 定义一个常量整数，表示取消同步的操作
public final static int ACTION_CANCEL_SYNC = 1;
-
+ // 定义一个常量整数，表示无效的操作
public final static int ACTION_INVALID = 2;
-
+ // 定义一个常量字符串，作为同步服务广播的名称
public final static String GTASK_SERVICE_BROADCAST_NAME = "net.micode.notes.gtask.remote.gtask_sync_service";
-
+ // 定义一个常量字符串，用于在广播中表示是否正在同步
public final static String GTASK_SERVICE_BROADCAST_IS_SYNCING = "isSyncing";
-
+ // 定义一个常量字符串，用于在广播中传递同步进度消息
public final static String GTASK_SERVICE_BROADCAST_PROGRESS_MSG = "progressMsg";
+ // 静态变量，用于存储当前的同步任务
private static GTaskASyncTask mSyncTask = null;
-
+ // 静态变量，用于存储同步进度消息
private static String mSyncProgress = "";
+ /**
+ * 启动同步任务的方法。
+ * 如果当前没有正在进行的同步任务，则创建一个新的同步任务并执行。
+ */
private void startSync() {
+ // 检查当前是否没有同步任务正在进行
if (mSyncTask == null) {
+ // 创建一个新的 GTaskASyncTask 实例，并传入上下文和完成监听器
mSyncTask = new GTaskASyncTask(this, new GTaskASyncTask.OnCompleteListener() {
+ /**
+ * 同步任务完成时调用的方法。
+ * 重置同步任务，发送广播通知同步完成，并停止服务。
+ */
public void onComplete() {
+ // 同步任务完成后，将 mSyncTask 置为 null
mSyncTask = null;
+ // 发送广播，通知同步完成，传入空消息
sendBroadcast("");
+ // 停止当前服务
stopSelf();
}
});
+ // 发送广播，通知同步开始，传入空消息
sendBroadcast("");
+ // 执行同步任务
mSyncTask.execute();
}
}
+ /**
+ * 取消同步任务的方法。
+ * 如果当前有正在进行的同步任务，则取消该任务。
+ */
private void cancelSync() {
+ // 检查当前是否有同步任务正在进行
if (mSyncTask != null) {
+ // 调用同步任务的 cancelSync 方法取消同步
mSyncTask.cancelSync();
}
}
+ /**
+ * 服务创建时调用的方法。
+ * 初始化同步任务为 null。
+ */
@Override
public void onCreate() {
+ // 服务创建时，将 mSyncTask 置为 null
mSyncTask = null;
}
+ /**
+ * 服务启动时调用的方法。
+ * 根据传入的 Intent 中的操作类型，执行相应的同步操作。
+ *
+ * @param intent 启动服务时传入的 Intent
+ * @param flags 启动标志
+ * @param startId 启动 ID
+ * @return 返回服务的启动模式
+ */
@Override
public int onStartCommand(Intent intent, int flags, int startId) {
+ // 从 Intent 中获取 Bundle 数据
Bundle bundle = intent.getExtras();
+ // 检查 Bundle 是否存在且包含同步操作类型
if (bundle != null && bundle.containsKey(ACTION_STRING_NAME)) {
+ // 根据 Bundle 中的操作类型进行不同处理
switch (bundle.getInt(ACTION_STRING_NAME, ACTION_INVALID)) {
case ACTION_START_SYNC:
+ // 启动同步任务
startSync();
break;
case ACTION_CANCEL_SYNC:
+ // 取消同步任务
cancelSync();
break;
default:
break;
}
+ // 返回 START_STICKY 表示服务在被系统杀死后会自动重启
return START_STICKY;
}
+ // 如果 Bundle 不包含有效操作类型，调用父类的 onStartCommand 方法
return super.onStartCommand(intent, flags, startId);
}
+ /**
+ * 系统内存不足时调用的方法。
+ * 如果当前有正在进行的同步任务，则取消该任务。
+ */
@Override
public void onLowMemory() {
+ // 检查当前是否有同步任务正在进行
if (mSyncTask != null) {
+ // 调用同步任务的 cancelSync 方法取消同步
mSyncTask.cancelSync();
}
}
+ /**
+ * 绑定服务时调用的方法。
+ * 由于该服务不需要绑定，返回 null。
+ *
+ * @param intent 绑定服务时传入的 Intent
+ * @return 返回 null
+ */
public IBinder onBind(Intent intent) {
return null;
}
+ /**
+ * 发送广播通知同步状态和进度的方法。
+ *
+ * @param msg 同步进度消息
+ */
public void sendBroadcast(String msg) {
+ // 更新同步进度消息
mSyncProgress = msg;
+ // 创建一个新的 Intent，用于发送广播
Intent intent = new Intent(GTASK_SERVICE_BROADCAST_NAME);
+ // 在 Intent 中添加是否正在同步的信息
intent.putExtra(GTASK_SERVICE_BROADCAST_IS_SYNCING, mSyncTask != null);
+ // 在 Intent 中添加同步进度消息
intent.putExtra(GTASK_SERVICE_BROADCAST_PROGRESS_MSG, msg);
+ // 发送广播
sendBroadcast(intent);
}
+ /**
+ * 静态方法，用于从 Activity 启动同步服务。
+ *
+ * @param activity 启动同步服务的 Activity
+ */
public static void startSync(Activity activity) {
+ // 设置 GTaskManager 的 Activity 上下文
GTaskManager.getInstance().setActivityContext(activity);
+ // 创建一个新的 Intent，用于启动 GTaskSyncService
Intent intent = new Intent(activity, GTaskSyncService.class);
+ // 在 Intent 中添加启动同步的操作类型
intent.putExtra(GTaskSyncService.ACTION_STRING_NAME, GTaskSyncService.ACTION_START_SYNC);
+ // 启动服务
activity.startService(intent);
}
+ /**
+ * 静态方法，用于取消同步服务。
+ *
+ * @param context 上下文对象
+ */
public static void cancelSync(Context context) {
+ // 创建一个新的 Intent，用于启动 GTaskSyncService
Intent intent = new Intent(context, GTaskSyncService.class);
+ // 在 Intent 中添加取消同步的操作类型
intent.putExtra(GTaskSyncService.ACTION_STRING_NAME, GTaskSyncService.ACTION_CANCEL_SYNC);
+ // 启动服务
context.startService(intent);
}
+ /**
+ * 静态方法，用于检查当前是否正在进行同步。
+ *
+ * @return 如果正在同步返回 true，否则返回 false
+ */
public static boolean isSyncing() {
+ // 判断 mSyncTask 是否不为 null，即是否有同步任务正在进行
return mSyncTask != null;
}
+ /**
+ * 静态方法，用于获取当前的同步进度消息。
+ *
+ * @return 当前的同步进度消息
+ */
public static String getProgressString() {
+ // 返回当前的同步进度消息
return mSyncProgress;
}
-}
+}
\ No newline at end of file