Compare commits

..

23 Commits

Author SHA1 Message Date
13864042598 04c7485085 Merge branch 'huyunfei'
2 months ago
XJS 6e7f066ceb Merge branch 'xingjiasen'
2 months ago
XYJ 7939ce2f52 Merge branch 'xinyajie'
2 months ago
hyf 6e14c3527a Merge branch 'huyunfei'
2 months ago
hyf edb24d5740 质量分析报告
2 months ago
XYJ 8dd7a9b830 信亚杰 gtask包remote包
2 months ago
hyf 5ad54ad609 泛读报告
2 months ago
XJS bd8d18a546 邢加森 -gtask data包exception包
2 months ago
XYJ 51814cff35 信亚杰 data包注释
2 months ago
HYF 7f87b931f0 文档
2 months ago
HYF 3838db52b6 12.20
2 months ago
13864042598 8b526d7be0 10.17
4 months ago
XJS 1954950b7b 10.17-xingjiasen
4 months ago
XYJ db432618c6 10.17-xinyajie
4 months ago
13864042598 c7649f85c5 Merge branch 'main' of https://bdgit.educoder.net/pa2tefyxw/xiaomibianqian
4 months ago
HYF 4a1d1601ff hebingceshi
4 months ago
pa2tefyxw 411868b8c3 Merge pull request '合并测试' (#5) from huyunfei into main
4 months ago
13864042598 6535529958 Merge branch 'xinyajie' of https://bdgit.educoder.net/pa2tefyxw/xiaomibianqian into xinyajie
4 months ago
hyf b044e40ef9 Merge branch 'main' of https://bdgit.educoder.net/pa2tefyxw/xiaomibianqian into xinyajie
4 months ago
pa2tefyxw c10b60cb0c Update README.md
4 months ago
13864042598 64bfbfadfa Merge branch 'main' of https://bdgit.educoder.net/pa2tefyxw/xiaomibianqian into xinyajie
4 months ago
pa2tefyxw 037a05e1a6 Merge pull request 'huyunfei' (#1) from huyunfei into main
4 months ago
HYF b7ddca9ff8 xinyajie.txt
6 months ago

@ -0,0 +1 @@
main分支

@ -25,49 +25,75 @@ import android.util.Log;
import java.util.HashMap;
<<<<<<< HEAD
//ceshihebing2
public class Contact {
private static HashMap<String, String> sContactCache;
private static final String TAG = "Contact";
=======
// 该类用于获取与给定电话号码对应的联系人姓名,通过缓存已查询结果来提高性能
>>>>>>> xinyajie
public class Contact {
// 该类用于获取与给定电话号码对应的联系人姓名,通过缓存已查询结果来提高性能
private static HashMap<String, String> sContactCache;
// 日志标签,用于在 Log 输出中标识该类的相关信息
private static final String TAG = "Contact";
// 查询条件字符串,用于从联系人数据库中筛选出匹配电话号码的记录
// 它通过比较电话号码和联系人数据中的电话号码,确保数据类型为电话类型,并限制在特定的 raw_contact_id 范围内进行查询
// 其中PHONE_NUMBERS_EQUAL 是一个函数,用于比较电话号码是否相等,这里使用了占位符 '?',后续会替换为实际的电话号码
// Data.MIMETYPE 用于指定数据类型Phone.CONTENT_ITEM_TYPE 表示电话类型的数据
// Data.RAW_CONTACT_ID 用于指定原始联系人 ID这里通过子查询从 phone_lookup 表中获取满足 min_match = '+' 条件的 raw_contact_id
private static final String CALLER_ID_SELECTION = "PHONE_NUMBERS_EQUAL(" + Phone.NUMBER
+ ",?) AND " + Data.MIMETYPE + "='" + Phone.CONTENT_ITEM_TYPE + "'"
+ " AND " + Data.RAW_CONTACT_ID + " IN "
+ "(SELECT raw_contact_id "
+ " FROM phone_lookup"
+ " WHERE min_match = '+')";
// 根据给定的上下文和电话号码获取联系人姓名的静态方法
public static String getContact(Context context, String phoneNumber) {
// 如果缓存为空,则创建一个新的 HashMap 用于缓存
if(sContactCache == null) {
sContactCache = new HashMap<String, String>();
}
// 首先检查缓存中是否已经存在该电话号码对应的联系人姓名,如果存在则直接返回缓存中的结果
if(sContactCache.containsKey(phoneNumber)) {
return sContactCache.get(phoneNumber);
}
// 替换查询条件中的 '+' 为电话号码的最小匹配格式,以便进行更准确的查询
String selection = CALLER_ID_SELECTION.replace("+",
PhoneNumberUtils.toCallerIDMinMatch(phoneNumber));
// 使用 ContentResolver 查询联系人数据库,获取匹配电话号码的联系人姓名
// 查询的 URI 为 Data.CONTENT_URI表示联系人数据的通用 URI
// 查询的列仅包含 Phone.DISPLAY_NAME即联系人的显示名称
// 选择条件为上面生成的 selection选择参数为实际的电话号码
// 排序方式为默认,这里传入 null
Cursor cursor = context.getContentResolver().query(
Data.CONTENT_URI,
new String [] { Phone.DISPLAY_NAME },
selection,
new String[] { phoneNumber },
null);
// 如果查询结果不为空且游标能够移动到第一条记录,则表示找到了匹配的联系人
if (cursor != null && cursor.moveToFirst()) {
try {
// 从游标中获取联系人姓名,索引为 0因为查询结果只包含一列联系人姓名
String name = cursor.getString(0);
// 将查询到的电话号码和对应的联系人姓名存入缓存
sContactCache.put(phoneNumber, name);
// 返回联系人姓名
return name;
} catch (IndexOutOfBoundsException e) {
// 如果在获取游标数据时发生越界异常,则记录错误日志,并返回 null
Log.e(TAG, " Cursor get string error " + e.toString());
return null;
} finally {
// 无论是否发生异常,都需要关闭游标,释放资源
cursor.close();
}
} else {
// 如果没有找到匹配的联系人,则记录调试日志,并返回 null
Log.d(TAG, "No contact matched with number:" + phoneNumber);
return null;
}

@ -17,12 +17,20 @@
package net.micode.notes.data;
import android.net.Uri;
// 该类用于定义笔记应用程序中的各种常量和数据结构相关信息
public class Notes {
// 定义笔记应用的授权Authority用于 Content Provider 的标识
public static final String AUTHORITY = "micode_notes";
// 日志标签,用于在应用中标记与笔记相关的日志信息
public static final String TAG = "Notes";
// 定义不同类型的笔记或文件夹
public static final int TYPE_NOTE = 0;
public static final int TYPE_FOLDER = 1;
public static final int TYPE_SYSTEM = 2;
// 系统文件夹的标识符
// ID_ROOT_FOLDER 是默认文件夹的 ID
/**
* Following IDs are system folders' identifiers
@ -31,179 +39,194 @@ public class Notes {
* {@link Notes#ID_CALL_RECORD_FOLDER} is to store call records
*/
public static final int ID_ROOT_FOLDER = 0;
// ID_TEMPARAY_FOLDER 用于存放不属于任何文件夹的笔记
public static final int ID_TEMPARAY_FOLDER = -1;
// ID_CALL_RECORD_FOLDER 用于存储通话记录的文件夹 ID
public static final int ID_CALL_RECORD_FOLDER = -2;
// ID_TRASH_FOLER 垃圾桶文件夹 ID
public static final int ID_TRASH_FOLER = -3;
// 用于传递提醒日期的 Intent 额外数据键
public static final String INTENT_EXTRA_ALERT_DATE = "net.micode.notes.alert_date";
// 用于传递背景颜色 ID 的 Intent 额外数据键
public static final String INTENT_EXTRA_BACKGROUND_ID = "net.micode.notes.background_color_id";
// 用于传递小部件 ID 的 Intent 额外数据键
public static final String INTENT_EXTRA_WIDGET_ID = "net.micode.notes.widget_id";
// 用于传递小部件类型的 Intent 额外数据键
public static final String INTENT_EXTRA_WIDGET_TYPE = "net.micode.notes.widget_type";
// 用于传递文件夹 ID 的 Intent 额外数据键
public static final String INTENT_EXTRA_FOLDER_ID = "net.micode.notes.folder_id";
// 用于传递通话日期的 Intent 额外数据键
public static final String INTENT_EXTRA_CALL_DATE = "net.micode.notes.call_date";
// 无效的小部件类型
public static final int TYPE_WIDGET_INVALIDE = -1;
// 2x 小部件类型
public static final int TYPE_WIDGET_2X = 0;
// 4x 小部件类型
public static final int TYPE_WIDGET_4X = 1;
// 内部类,用于定义数据常量
public static class DataConstants {
// 文本笔记的 Content Item Type
public static final String NOTE = TextNote.CONTENT_ITEM_TYPE;
// 通话笔记的 Content Item Type
public static final String CALL_NOTE = CallNote.CONTENT_ITEM_TYPE;
}
// 用于查询所有笔记和文件夹的 Uri
/**
* Uri to query all notes and folders
*/
public static final Uri CONTENT_NOTE_URI = Uri.parse("content://" + AUTHORITY + "/note");
// 用于查询数据的 Uri
/**
* Uri to query data
*/
public static final Uri CONTENT_DATA_URI = Uri.parse("content://" + AUTHORITY + "/data");
// 定义笔记列的接口
public interface NoteColumns {
// 行的唯一 ID类型为长整型整数
/**
* The unique ID for a row
* <P> Type: INTEGER (long) </P>
*/
public static final String ID = "_id";
// 笔记或文件夹的父 ID类型为长整型整数
/**
* The parent's id for note or folder
* <P> Type: INTEGER (long) </P>
*/
public static final String PARENT_ID = "parent_id";
// 笔记或文件夹的创建日期,类型为长整型整数
/**
* Created data for note or folder
* <P> Type: INTEGER (long) </P>
*/
public static final String CREATED_DATE = "created_date";
// 最新修改日期,类型为长整型整数
/**
* Latest modified date
* <P> Type: INTEGER (long) </P>
*/
public static final String MODIFIED_DATE = "modified_date";
// 提醒日期,类型为长整型整数
/**
* Alert date
* <P> Type: INTEGER (long) </P>
*/
public static final String ALERTED_DATE = "alert_date";
// 文件夹名称或笔记的文本内容,类型为文本
/**
* Folder's name or text content of note
* <P> Type: TEXT </P>
*/
public static final String SNIPPET = "snippet";
// 笔记的小部件 ID类型为长整型整数
/**
* Note's widget id
* <P> Type: INTEGER (long) </P>
*/
public static final String WIDGET_ID = "widget_id";
// 笔记的小部件类型,类型为长整型整数
/**
* Note's widget type
* <P> Type: INTEGER (long) </P>
*/
public static final String WIDGET_TYPE = "widget_type";
// 笔记的背景颜色 ID类型为长整型整数
/**
* Note's background color's id
* <P> Type: INTEGER (long) </P>
*/
public static final String BG_COLOR_ID = "bg_color_id";
// 对于文本笔记,无附件时为 0多媒体笔记至少有一个附件时为 1类型为整数
/**
* For text note, it doesn't has attachment, for multi-media
* note, it has at least one attachment
* <P> Type: INTEGER </P>
*/
public static final String HAS_ATTACHMENT = "has_attachment";
// 文件夹中的笔记数量,类型为长整型整数
/**
* Folder's count of notes
* <P> Type: INTEGER (long) </P>
*/
public static final String NOTES_COUNT = "notes_count";
// 文件类型(文件夹或笔记),类型为整数
/**
* The file type: folder or note
* <P> Type: INTEGER </P>
*/
public static final String TYPE = "type";
// 最后同步 ID类型为长整型整数
/**
* The last sync id
* <P> Type: INTEGER (long) </P>
*/
public static final String SYNC_ID = "sync_id";
// 表示本地是否修改的标志,类型为整数
/**
* Sign to indicate local modified or not
* <P> Type: INTEGER </P>
*/
public static final String LOCAL_MODIFIED = "local_modified";
// 移动到临时文件夹之前的原始父 ID类型为整数
/**
* Original parent id before moving into temporary folder
* <P> Type : INTEGER </P>
*/
public static final String ORIGIN_PARENT_ID = "origin_parent_id";
// gtask ID类型为文本
/**
* The gtask id
* <P> Type : TEXT </P>
*/
public static final String GTASK_ID = "gtask_id";
// 版本代码,类型为长整型整数
/**
* The version code
* <P> Type : INTEGER (long) </P>
*/
public static final String VERSION = "version";
}
// 定义数据列的接口
public interface DataColumns {
// 行的唯一 ID类型为长整型整数
/**
* The unique ID for a row
* <P> Type: INTEGER (long) </P>
*/
public static final String ID = "_id";
// 此行表示的项目的 MIME 类型,类型为文本
/**
* The MIME type of the item represented by this row.
* <P> Type: Text </P>
*/
public static final String MIME_TYPE = "mime_type";
// 此数据所属笔记的引用 ID类型为长整型整数
/**
* The reference id to note that this data belongs to
* <P> Type: INTEGER (long) </P>
*/
public static final String NOTE_ID = "note_id";
// 笔记或文件夹的创建日期,类型为长整型整数
/**
* Created data for note or folder
* <P> Type: INTEGER (long) </P>
*/
public static final String CREATED_DATE = "created_date";
// 最新修改日期,类型为长整型整数
/**
* Latest modified date
* <P> Type: INTEGER (long) </P>
*/
public static final String MODIFIED_DATE = "modified_date";
// 数据内容,类型为文本
/**
* Data's content
* <P> Type: TEXT </P>
*/
public static final String CONTENT = "content";
// 通用数据列,含义取决于 MIME_TYPE用于整数数据类型
/**
* Generic data column, the meaning is {@link #MIMETYPE} specific, used for
@ -211,28 +234,28 @@ public class Notes {
* <P> Type: INTEGER </P>
*/
public static final String DATA1 = "data1";
// 通用数据列,含义取决于 MIME_TYPE用于整数数据类型
/**
* Generic data column, the meaning is {@link #MIMETYPE} specific, used for
* integer data type
* <P> Type: INTEGER </P>
*/
public static final String DATA2 = "data2";
// 通用数据列,含义取决于 MIME_TYPE用于文本数据类型
/**
* Generic data column, the meaning is {@link #MIMETYPE} specific, used for
* TEXT data type
* <P> Type: TEXT </P>
*/
public static final String DATA3 = "data3";
// 通用数据列,含义取决于 MIME_TYPE用于文本数据类型
/**
* Generic data column, the meaning is {@link #MIMETYPE} specific, used for
* TEXT data type
* <P> Type: TEXT </P>
*/
public static final String DATA4 = "data4";
// 通用数据列,含义取决于 MIME_TYPE用于文本数据类型
/**
* Generic data column, the meaning is {@link #MIMETYPE} specific, used for
* TEXT data type
@ -240,8 +263,10 @@ public class Notes {
*/
public static final String DATA5 = "data5";
}
// 文本笔记类,实现 DataColumns 接口
public static final class TextNote implements DataColumns {
// 表示文本是否处于清单模式的模式1 为清单模式0 为正常模式,类型为整数
/**
* Mode to indicate the text in check list mode or not
* <P> Type: Integer 1:check list mode 0: normal mode </P>
@ -249,31 +274,32 @@ public class Notes {
public static final String MODE = DATA1;
public static final int MODE_CHECK_LIST = 1;
// 文本笔记的 Content Type目录
public static final String CONTENT_TYPE = "vnd.android.cursor.dir/text_note";
// 文本笔记的 Content Item Type项目
public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/text_note";
// 文本笔记的 Content Uri
public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/text_note");
}
// 通话笔记类,实现 DataColumns 接口
public static final class CallNote implements DataColumns {
// 通话记录的通话日期,类型为长整型整数
/**
* Call date for this record
* <P> Type: INTEGER (long) </P>
*/
public static final String CALL_DATE = DATA1;
// 通话记录的电话号码,类型为文本
/**
* Phone number for this record
* <P> Type: TEXT </P>
*/
public static final String PHONE_NUMBER = DATA3;
// 通话笔记的 Content Type目录
public static final String CONTENT_TYPE = "vnd.android.cursor.dir/call_note";
// 通话笔记的 Content Item Type项目
public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/call_note";
// 通话笔记的 Content Uri
public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/call_note");
}
}

@ -21,27 +21,28 @@ import android.content.Context;
import android.database.sqlite.SQLiteDatabase;
import android.database.sqlite.SQLiteOpenHelper;
import android.util.Log;
// 该类继承自 SQLiteOpenHelper用于管理笔记应用的数据库创建、升级和相关操作
import net.micode.notes.data.Notes.DataColumns;
import net.micode.notes.data.Notes.DataConstants;
import net.micode.notes.data.Notes.NoteColumns;
public class NotesDatabaseHelper extends SQLiteOpenHelper {
// 数据库名称
private static final String DB_NAME = "note.db";
// 数据库版本号
private static final int DB_VERSION = 4;
// 定义数据库表名的接口
public interface TABLE {
public static final String NOTE = "note";
public static final String DATA = "data";
}
// 日志标签,用于在数据库操作过程中记录日志信息
private static final String TAG = "NotesDatabaseHelper";
// 单例模式实例
private static NotesDatabaseHelper mInstance;
// 创建笔记表的 SQL 语句
private static final String CREATE_NOTE_TABLE_SQL =
"CREATE TABLE " + TABLE.NOTE + "(" +
NoteColumns.ID + " INTEGER PRIMARY KEY," +
@ -62,7 +63,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
NoteColumns.GTASK_ID + " TEXT NOT NULL DEFAULT ''," +
NoteColumns.VERSION + " INTEGER NOT NULL DEFAULT 0" +
")";
// 创建数据表的 SQL 语句
private static final String CREATE_DATA_TABLE_SQL =
"CREATE TABLE " + TABLE.DATA + "(" +
DataColumns.ID + " INTEGER PRIMARY KEY," +
@ -77,11 +78,11 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
DataColumns.DATA4 + " TEXT NOT NULL DEFAULT ''," +
DataColumns.DATA5 + " TEXT NOT NULL DEFAULT ''" +
")";
// 在数据表上创建基于 note_id 的索引 SQL 语句,如果不存在则创建
private static final String CREATE_DATA_NOTE_ID_INDEX_SQL =
"CREATE INDEX IF NOT EXISTS note_id_index ON " +
TABLE.DATA + "(" + DataColumns.NOTE_ID + ");";
// 当笔记移动到文件夹时增加文件夹笔记数量的触发器 SQL 语句
/**
* Increase folder's note count when move note to the folder
*/
@ -93,7 +94,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
" SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + " + 1" +
" WHERE " + NoteColumns.ID + "=new." + NoteColumns.PARENT_ID + ";" +
" END";
// 当笔记从文件夹移出时减少文件夹笔记数量的触发器 SQL 语句
/**
* Decrease folder's note count when move note from folder
*/
@ -106,7 +107,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
" WHERE " + NoteColumns.ID + "=old." + NoteColumns.PARENT_ID +
" AND " + NoteColumns.NOTES_COUNT + ">0" + ";" +
" END";
// 当在文件夹中插入新笔记时增加文件夹笔记数量的触发器 SQL 语句
/**
* Increase folder's note count when insert new note to the folder
*/
@ -118,7 +119,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
" SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + " + 1" +
" WHERE " + NoteColumns.ID + "=new." + NoteColumns.PARENT_ID + ";" +
" END";
// 当从文件夹中删除笔记时减少文件夹笔记数量的触发器 SQL 语句
/**
* Decrease folder's note count when delete note from the folder
*/
@ -131,7 +132,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
" WHERE " + NoteColumns.ID + "=old." + NoteColumns.PARENT_ID +
" AND " + NoteColumns.NOTES_COUNT + ">0;" +
" END";
// 当插入类型为笔记的数据时更新笔记内容的触发器 SQL 语句
/**
* Update note's content when insert data with type {@link DataConstants#NOTE}
*/
@ -144,7 +145,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
" SET " + NoteColumns.SNIPPET + "=new." + DataColumns.CONTENT +
" WHERE " + NoteColumns.ID + "=new." + DataColumns.NOTE_ID + ";" +
" END";
// 当笔记类型的数据更新时更新笔记内容的触发器 SQL 语句
/**
* Update note's content when data with {@link DataConstants#NOTE} type has changed
*/
@ -157,7 +158,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
" SET " + NoteColumns.SNIPPET + "=new." + DataColumns.CONTENT +
" WHERE " + NoteColumns.ID + "=new." + DataColumns.NOTE_ID + ";" +
" END";
// 当笔记类型的数据删除时更新笔记内容的触发器 SQL 语句
/**
* Update note's content when data with {@link DataConstants#NOTE} type has deleted
*/
@ -170,7 +171,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
" SET " + NoteColumns.SNIPPET + "=''" +
" WHERE " + NoteColumns.ID + "=old." + DataColumns.NOTE_ID + ";" +
" END";
// 当笔记被删除时删除其关联数据的触发器 SQL 语句
/**
* Delete datas belong to note which has been deleted
*/
@ -181,7 +182,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
" DELETE FROM " + TABLE.DATA +
" WHERE " + DataColumns.NOTE_ID + "=old." + NoteColumns.ID + ";" +
" END";
// 当文件夹被删除时删除其关联笔记的触发器 SQL 语句
/**
* Delete notes belong to folder which has been deleted
*/
@ -192,7 +193,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
" DELETE FROM " + TABLE.NOTE +
" WHERE " + NoteColumns.PARENT_ID + "=old." + NoteColumns.ID + ";" +
" END";
// 当文件夹被移动到垃圾桶文件夹时移动其关联笔记的触发器 SQL 语句
/**
* Move notes belong to folder which has been moved to trash folder
*/
@ -205,18 +206,18 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
" SET " + NoteColumns.PARENT_ID + "=" + Notes.ID_TRASH_FOLER +
" WHERE " + NoteColumns.PARENT_ID + "=old." + NoteColumns.ID + ";" +
" END";
// 构造函数,调用父类 SQLiteOpenHelper 的构造函数,传入上下文、数据库名称、游标工厂(这里为 null和版本号
public NotesDatabaseHelper(Context context) {
super(context, DB_NAME, null, DB_VERSION);
}
// 创建笔记表的方法,执行创建表的 SQL 语句,重新创建触发器,并创建系统文件夹
public void createNoteTable(SQLiteDatabase db) {
db.execSQL(CREATE_NOTE_TABLE_SQL);
reCreateNoteTableTriggers(db);
createSystemFolder(db);
Log.d(TAG, "note table has been created");
}
// 重新创建笔记表触发器的方法,先删除已存在的相关触发器,再创建新的触发器
private void reCreateNoteTableTriggers(SQLiteDatabase db) {
db.execSQL("DROP TRIGGER IF EXISTS increase_folder_count_on_update");
db.execSQL("DROP TRIGGER IF EXISTS decrease_folder_count_on_update");
@ -234,17 +235,17 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
db.execSQL(FOLDER_DELETE_NOTES_ON_DELETE_TRIGGER);
db.execSQL(FOLDER_MOVE_NOTES_ON_TRASH_TRIGGER);
}
// 创建系统文件夹的方法,向笔记表中插入通话记录文件夹、根文件夹、临时文件夹和垃圾桶文件夹的记录
private void createSystemFolder(SQLiteDatabase db) {
ContentValues values = new ContentValues();
// 通话记录文件夹
/**
* call record foler for call notes
*/
values.put(NoteColumns.ID, Notes.ID_CALL_RECORD_FOLDER);
values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM);
db.insert(TABLE.NOTE, null, values);
// 根文件夹
/**
* root folder which is default folder
*/
@ -252,7 +253,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
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
*/
@ -260,7 +261,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
values.put(NoteColumns.ID, Notes.ID_TEMPARAY_FOLDER);
values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM);
db.insert(TABLE.NOTE, null, values);
// 垃圾桶文件夹
/**
* create trash folder
*/
@ -269,14 +270,14 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM);
db.insert(TABLE.NOTE, null, values);
}
// 创建数据表的方法,执行创建表的 SQL 语句,重新创建触发器,并创建索引
public void createDataTable(SQLiteDatabase db) {
db.execSQL(CREATE_DATA_TABLE_SQL);
reCreateDataTableTriggers(db);
db.execSQL(CREATE_DATA_NOTE_ID_INDEX_SQL);
Log.d(TAG, "data table has been created");
}
// 重新创建数据表触发器的方法,先删除已存在的相关触发器,再创建新的触发器
private void reCreateDataTableTriggers(SQLiteDatabase db) {
db.execSQL("DROP TRIGGER IF EXISTS update_note_content_on_insert");
db.execSQL("DROP TRIGGER IF EXISTS update_note_content_on_update");
@ -286,20 +287,20 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
db.execSQL(DATA_UPDATE_NOTE_CONTENT_ON_UPDATE_TRIGGER);
db.execSQL(DATA_UPDATE_NOTE_CONTENT_ON_DELETE_TRIGGER);
}
// 单例模式获取实例的方法,确保只有一个 NotesDatabaseHelper 实例存在
static synchronized NotesDatabaseHelper getInstance(Context context) {
if (mInstance == null) {
mInstance = new NotesDatabaseHelper(context);
}
return mInstance;
}
// 重写 onCreate 方法,在数据库首次创建时调用,创建笔记表和数据表
@Override
public void onCreate(SQLiteDatabase db) {
createNoteTable(db);
createDataTable(db);
}
// 重写 onUpgrade 方法,在数据库版本升级时调用,根据不同的旧版本执行相应的升级操作
@Override
public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
boolean reCreateTriggers = false;
@ -307,7 +308,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
if (oldVersion == 1) {
upgradeToV2(db);
skipV2 = true; // this upgrade including the upgrade from v2 to v3
skipV2 = true; // 此次升级包含从 v2 到 v3 的升级
oldVersion++;
}
@ -332,29 +333,29 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
+ "fails");
}
}
// 从版本 1 升级到版本 2 的方法,删除旧表并重新创建新表
private void upgradeToV2(SQLiteDatabase db) {
db.execSQL("DROP TABLE IF EXISTS " + TABLE.NOTE);
db.execSQL("DROP TABLE IF EXISTS " + TABLE.DATA);
createNoteTable(db);
createDataTable(db);
}
// 从版本 2 升级到版本 3 的方法,删除无用触发器,添加 gtask_id 列,并添加垃圾桶系统文件夹
private void upgradeToV3(SQLiteDatabase db) {
// drop unused triggers
// 删除无用触发器
db.execSQL("DROP TRIGGER IF EXISTS update_note_modified_date_on_insert");
db.execSQL("DROP TRIGGER IF EXISTS update_note_modified_date_on_delete");
db.execSQL("DROP TRIGGER IF EXISTS update_note_modified_date_on_update");
// add a column for gtask id
// 添加 gtask_id 列
db.execSQL("ALTER TABLE " + TABLE.NOTE + " ADD COLUMN " + NoteColumns.GTASK_ID
+ " TEXT NOT NULL DEFAULT ''");
// add a trash system folder
// 添加垃圾桶系统文件夹
ContentValues values = new ContentValues();
values.put(NoteColumns.ID, Notes.ID_TRASH_FOLER);
values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM);
db.insert(TABLE.NOTE, null, values);
}
// 从版本 3 升级到版本 4 的方法,添加 version 列
private void upgradeToV4(SQLiteDatabase db) {
db.execSQL("ALTER TABLE " + TABLE.NOTE + " ADD COLUMN " + NoteColumns.VERSION
+ " INTEGER NOT NULL DEFAULT 0");

@ -34,14 +34,15 @@ import net.micode.notes.data.Notes.DataColumns;
import net.micode.notes.data.Notes.NoteColumns;
import net.micode.notes.data.NotesDatabaseHelper.TABLE;
// 该类继承自 ContentProvider用于在 Android 系统中提供笔记数据的增删改查功能,并处理搜索相关操作
public class NotesProvider extends ContentProvider {
// 用于匹配不同的 Uri 模式的 UriMatcher 实例
private static final UriMatcher mMatcher;
// 数据库帮助类实例,用于操作数据库
private NotesDatabaseHelper mHelper;
// 日志标签,用于记录日志信息
private static final String TAG = "NotesProvider";
// 定义不同 Uri 模式的匹配码
private static final int URI_NOTE = 1;
private static final int URI_NOTE_ITEM = 2;
private static final int URI_DATA = 3;
@ -49,7 +50,7 @@ public class NotesProvider extends ContentProvider {
private static final int URI_SEARCH = 5;
private static final int URI_SEARCH_SUGGEST = 6;
// 静态代码块,用于初始化 UriMatcher添加各种 Uri 模式的匹配规则
static {
mMatcher = new UriMatcher(UriMatcher.NO_MATCH);
mMatcher.addURI(Notes.AUTHORITY, "note", URI_NOTE);
@ -60,7 +61,8 @@ public class NotesProvider extends ContentProvider {
mMatcher.addURI(Notes.AUTHORITY, SearchManager.SUGGEST_URI_PATH_QUERY, URI_SEARCH_SUGGEST);
mMatcher.addURI(Notes.AUTHORITY, SearchManager.SUGGEST_URI_PATH_QUERY + "/*", URI_SEARCH_SUGGEST);
}
// 搜索结果投影字符串,用于定义搜索结果中返回的列信息
// 包括笔记 ID、将笔记 ID 作为意图额外数据、修剪和替换换行符后的笔记摘要作为搜索建议的文本列、图标资源 ID、意图动作和意图数据类型
/**
* 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.
@ -72,52 +74,61 @@ public class NotesProvider extends ContentProvider {
+ 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;
// 搜索查询语句,用于从笔记表中查询符合搜索条件的笔记信息
// 搜索条件是笔记摘要包含指定字符串,且笔记不在垃圾桶文件夹中,并且是普通笔记类型
private static String NOTES_SNIPPET_SEARCH_QUERY = "SELECT " + NOTES_SEARCH_PROJECTION
+ " FROM " + TABLE.NOTE
+ " WHERE " + NoteColumns.SNIPPET + " LIKE ?"
+ " AND " + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER
+ " AND " + NoteColumns.TYPE + "=" + Notes.TYPE_NOTE;
// 重写 ContentProvider 的 onCreate 方法,在 ContentProvider 启动时调用
// 用于获取 NotesDatabaseHelper 的单例实例
@Override
public boolean onCreate() {
mHelper = NotesDatabaseHelper.getInstance(getContext());
return true;
}
// 重写 ContentProvider 的 query 方法,用于处理数据查询请求
@Override
public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs,
String sortOrder) {
Cursor c = null;
SQLiteDatabase db = mHelper.getReadableDatabase();
String id = null;
// 根据 Uri 匹配码执行不同的查询操作
switch (mMatcher.match(uri)) {
case URI_NOTE:
// 查询笔记表,返回符合条件的游标
c = db.query(TABLE.NOTE, projection, selection, selectionArgs, null, null,
sortOrder);
break;
case URI_NOTE_ITEM:
// 获取路径片段中的笔记 ID查询指定 ID 的笔记
id = uri.getPathSegments().get(1);
c = db.query(TABLE.NOTE, projection, NoteColumns.ID + "=" + id
+ parseSelection(selection), selectionArgs, null, null, sortOrder);
break;
case URI_DATA:
// 查询数据表,返回符合条件的游标
c = db.query(TABLE.DATA, projection, selection, selectionArgs, null, null,
sortOrder);
break;
case URI_DATA_ITEM:
// 获取路径片段中的数据 ID查询指定 ID 的数据
id = uri.getPathSegments().get(1);
c = db.query(TABLE.DATA, projection, DataColumns.ID + "=" + id
+ parseSelection(selection), selectionArgs, null, null, sortOrder);
break;
case URI_SEARCH:
case URI_SEARCH_SUGGEST:
// 检查是否指定了不允许的参数,如果指定则抛出异常
if (sortOrder != null || projection != null) {
throw new IllegalArgumentException(
"do not specify sortOrder, selection, selectionArgs, or projection" + "with this query");
}
String searchString = null;
// 根据 Uri 匹配码获取搜索字符串
if (mMatcher.match(uri) == URI_SEARCH_SUGGEST) {
if (uri.getPathSegments().size() > 1) {
searchString = uri.getPathSegments().get(1);
@ -125,12 +136,13 @@ public class NotesProvider extends ContentProvider {
} else {
searchString = uri.getQueryParameter("pattern");
}
// 如果搜索字符串为空,则返回 null
if (TextUtils.isEmpty(searchString)) {
return null;
}
try {
// 格式化搜索字符串,执行原始查询并返回游标
searchString = String.format("%%%s%%", searchString);
c = db.rawQuery(NOTES_SNIPPET_SEARCH_QUERY,
new String[] { searchString });
@ -139,61 +151,71 @@ public class NotesProvider extends ContentProvider {
}
break;
default:
// 如果 Uri 不匹配任何已知模式,则抛出异常
throw new IllegalArgumentException("Unknown URI " + uri);
}
// 如果游标不为空,则设置通知 Uri以便在数据变化时接收通知
if (c != null) {
c.setNotificationUri(getContext().getContentResolver(), uri);
}
return c;
}
// 重写 ContentProvider 的 insert 方法,用于处理数据插入请求
@Override
public Uri insert(Uri uri, ContentValues values) {
SQLiteDatabase db = mHelper.getWritableDatabase();
long dataId = 0, noteId = 0, insertedId = 0;
// 根据 Uri 匹配码执行不同的插入操作
switch (mMatcher.match(uri)) {
case URI_NOTE:
// 插入笔记数据,获取插入的笔记 ID
insertedId = noteId = db.insert(TABLE.NOTE, null, values);
break;
case URI_DATA:
// 获取数据所属的笔记 ID如果不存在则记录错误日志
if (values.containsKey(DataColumns.NOTE_ID)) {
noteId = values.getAsLong(DataColumns.NOTE_ID);
} else {
Log.d(TAG, "Wrong data format without note id:" + values.toString());
}
// 插入数据,获取插入的数据 ID
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);
}
// 返回插入数据后的 Uri包含插入的 ID
return ContentUris.withAppendedId(uri, insertedId);
}
// 重写 ContentProvider 的 delete 方法,用于处理数据删除请求
@Override
public int delete(Uri uri, String selection, String[] selectionArgs) {
int count = 0;
String id = null;
SQLiteDatabase db = mHelper.getWritableDatabase();
boolean deleteData = false;
// 根据 Uri 匹配码执行不同的删除操作
switch (mMatcher.match(uri)) {
case URI_NOTE:
// 添加额外的条件,确保只删除有效 ID 的笔记
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 小于等于 0则不允许删除可能是系统文件夹
/**
* ID that smaller than 0 is system folder which is not allowed to
* trash
@ -206,18 +228,22 @@ public class NotesProvider extends ContentProvider {
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);
count = db.delete(TABLE.DATA,
DataColumns.ID + "=" + id + parseSelection(selection), selectionArgs);
deleteData = true;
break;
default:
// 如果 Uri 不匹配任何已知模式,则抛出异常
throw new IllegalArgumentException("Unknown URI " + uri);
}
// 如果删除了数据且有数据被删除,则通知笔记 Uri 和删除的 Uri 数据变化
if (count > 0) {
if (deleteData) {
getContext().getContentResolver().notifyChange(Notes.CONTENT_NOTE_URI, null);
@ -226,38 +252,44 @@ public class NotesProvider extends ContentProvider {
}
return count;
}
// 重写 ContentProvider 的 update 方法,用于处理数据更新请求
@Override
public int update(Uri uri, ContentValues values, String selection, String[] selectionArgs) {
int count = 0;
String id = null;
SQLiteDatabase db = mHelper.getWritableDatabase();
boolean updateData = false;
// 根据 Uri 匹配码执行不同的更新操作
switch (mMatcher.match(uri)) {
case URI_NOTE:
// 增加笔记版本号,执行更新操作
increaseNoteVersion(-1, selection, selectionArgs);
count = db.update(TABLE.NOTE, values, selection, selectionArgs);
break;
case URI_NOTE_ITEM:
// 获取路径片段中的笔记 ID增加笔记版本号执行更新操作
id = uri.getPathSegments().get(1);
increaseNoteVersion(Long.valueOf(id), selection, selectionArgs);
count = db.update(TABLE.NOTE, values, NoteColumns.ID + "=" + id
+ parseSelection(selection), selectionArgs);
break;
case URI_DATA:
// 更新数据,设置标志位
count = db.update(TABLE.DATA, values, selection, selectionArgs);
updateData = true;
break;
case URI_DATA_ITEM:
// 获取路径片段中的数据 ID更新数据
id = uri.getPathSegments().get(1);
count = db.update(TABLE.DATA, values, DataColumns.ID + "=" + id
+ parseSelection(selection), selectionArgs);
updateData = true;
break;
default:
// 如果 Uri 不匹配任何已知模式,则抛出异常
throw new IllegalArgumentException("Unknown URI " + uri);
}
// 如果更新了数据且有数据被更新,则通知笔记 Uri 和更新的 Uri 数据变化
if (count > 0) {
if (updateData) {
getContext().getContentResolver().notifyChange(Notes.CONTENT_NOTE_URI, null);
@ -266,11 +298,11 @@ public class NotesProvider extends ContentProvider {
}
return count;
}
// 辅助方法,用于解析选择条件,添加括号和 AND 连接符
private String parseSelection(String selection) {
return (!TextUtils.isEmpty(selection) ? " AND (" + selection + ')' : "");
}
// 增加笔记版本号的方法,根据指定的笔记 ID 和选择条件构建更新 SQL 语句并执行
private void increaseNoteVersion(long id, String selection, String[] selectionArgs) {
StringBuilder sql = new StringBuilder(120);
sql.append("UPDATE ");
@ -295,10 +327,10 @@ public class NotesProvider extends ContentProvider {
mHelper.getWritableDatabase().execSQL(sql.toString());
}
// 重写 ContentProvider 的 getType 方法,目前未实现,返回 null
@Override
public String getType(Uri uri) {
// TODO Auto-generated method stub
// TODO Auto-generated method stub
return null;
}

@ -14,66 +14,90 @@
* limitations under the License.
*/
<<<<<<< HEAD
package net.micode.notes.gtask.data;//测试
=======
package net.micode.notes.gtask.data;// 该类所在的包用于组织代码结构可能与gtask数据相关
>>>>>>> xingjiasen
import android.database.Cursor;
import android.util.Log;
import net.micode.notes.tool.GTaskStringUtils;
import net.micode.notes.tool.GTaskStringUtils;// 自定义的工具类用于处理与gtask相关的字符串操作
import org.json.JSONException;
import org.json.JSONObject;
// MetaData类继承自Task类假设Task类是一个基类提供了一些通用的任务相关功能
public class MetaData extends Task {
// 定义一个常量TAG用于在日志记录中标识该类值为类的简单名称
private final static String TAG = MetaData.class.getSimpleName();
// 用于存储相关的gid可能是与gtask相关的唯一标识符
private String mRelatedGid = null;
// 设置元数据的方法接受一个gid字符串和一个JSONObject类型的元数据信息
public void setMeta(String gid, JSONObject metaInfo) {
try {
// 尝试将gid放入元数据信息的指定字段假设GTaskStringUtils.META_HEAD_GTASK_ID是一个常量表示在JSONObject中存储gid的键
metaInfo.put(GTaskStringUtils.META_HEAD_GTASK_ID, gid);
} catch (JSONException e) {
// 如果在放入gid时发生JSON异常记录错误日志提示无法放入相关gid
Log.e(TAG, "failed to put related gid");
}
// 将元数据信息转换为字符串并设置为笔记内容假设Task类中有setNotes方法用于设置笔记内容
setNotes(metaInfo.toString());
// 设置名称为指定的常量假设GTaskStringUtils.META_NOTE_NAME是一个常量表示元数据的名称
setName(GTaskStringUtils.META_NOTE_NAME);
}
// 获取相关gid的方法
public String getRelatedGid() {
return mRelatedGid;
}
// 重写isWorthSaving方法假设该方法在Task类中定义用于判断是否值得保存
// 判断依据是笔记内容是否不为空
@Override
public boolean isWorthSaving() {
return getNotes() != null;
}
// 重写setContentByRemoteJSON方法假设该方法在Task类中定义用于根据远程JSON数据设置内容
@Override
public void setContentByRemoteJSON(JSONObject js) {
// 先调用父类的setContentByRemoteJSON方法
super.setContentByRemoteJSON(js);
if (getNotes() != null) {
try {
// 从笔记内容创建一个新的JSONObject去除首尾空格后
JSONObject metaInfo = new JSONObject(getNotes().trim());
// 从元数据信息中获取相关gid并赋值给mRelatedGid
mRelatedGid = metaInfo.getString(GTaskStringUtils.META_HEAD_GTASK_ID);
mRelatedGid = metaInfo.getString(GTaskStringUtils.META_HEAD_GTASK_ID);
} catch (JSONException e) {
// 如果获取相关gid时发生JSON异常记录警告日志提示无法获取相关gid并将mRelatedGid设置为null
Log.w(TAG, "failed to get related gid");
mRelatedGid = null;
}
}
}
// 重写setContentByLocalJSON方法假设该方法在Task类中定义用于根据本地JSON数据设置内容
// 这里明确表示该方法不应该被调用如果被调用则抛出IllegalAccessError异常并给出提示信息
@Override
public void setContentByLocalJSON(JSONObject js) {
// this function should not be called
throw new IllegalAccessError("MetaData:setContentByLocalJSON should not be called");
}
// 重写getLocalJSONFromContent方法假设该方法在Task类中定义用于从内容获取本地JSON数据
// 这里明确表示该方法不应该被调用如果被调用则抛出IllegalAccessError异常并给出提示信息
@Override
public JSONObject getLocalJSONFromContent() {
throw new IllegalAccessError("MetaData:getLocalJSONFromContent should not be called");
}
// 重写getSyncAction方法假设该方法在Task类中定义用于获取同步操作相关信息
// 这里明确表示该方法不应该被调用如果被调用则抛出IllegalAccessError异常并给出提示信息
@Override
public int getSyncAction(Cursor c) {
throw new IllegalAccessError("MetaData:getSyncAction should not be called");

@ -20,7 +20,9 @@ import android.database.Cursor;
import org.json.JSONObject;
// 定义一个抽象类Node可能是用于表示某种数据节点作为其他具体节点类的基类
public abstract class Node {
// 定义一系列常量,表示同步操作的类型
public static final int SYNC_ACTION_NONE = 0;
public static final int SYNC_ACTION_ADD_REMOTE = 1;
@ -39,14 +41,16 @@ public abstract class Node {
public static final int SYNC_ACTION_ERROR = 8;
// 用于存储节点的唯一标识符(可能是全局唯一的)
private String mGid;
// 用于存储节点的名称
private String mName;
// 用于存储节点的最后修改时间
private long mLastModified;
// 用于标记节点是否已被删除
private boolean mDeleted;
// 无参构造函数,初始化节点的属性
public Node() {
mGid = null;
mName = "";
@ -54,46 +58,62 @@ public abstract class Node {
mDeleted = false;
}
// 抽象方法用于获取创建操作的JSONObject表示具体实现由子类提供
// 参数actionId可能用于指定创建操作的具体类型或相关参数
public abstract JSONObject getCreateAction(int actionId);
// 抽象方法用于获取更新操作的JSONObject表示具体实现由子类提供
// 参数actionId可能用于指定更新操作的具体类型或相关参数
public abstract JSONObject getUpdateAction(int actionId);
// 抽象方法用于根据远程JSON数据设置节点内容具体实现由子类提供
public abstract void setContentByRemoteJSON(JSONObject js);
// 抽象方法用于根据本地JSON数据设置节点内容具体实现由子类提供
public abstract void setContentByLocalJSON(JSONObject js);
// 抽象方法用于从节点内容获取本地JSON数据具体实现由子类提供
public abstract JSONObject getLocalJSONFromContent();
// 抽象方法,用于根据数据库游标获取节点的同步操作类型,具体实现由子类提供
public abstract int getSyncAction(Cursor c);
// 设置节点的唯一标识符
public void setGid(String gid) {
this.mGid = gid;
}
// 设置节点的名称
public void setName(String name) {
this.mName = name;
}
// 设置节点的最后修改时间
public void setLastModified(long lastModified) {
this.mLastModified = lastModified;
}
// 设置节点的删除标记
public void setDeleted(boolean deleted) {
this.mDeleted = deleted;
}
// 获取节点的唯一标识符
public String getGid() {
return this.mGid;
}
// 获取节点的名称
public String getName() {
return this.mName;
}
// 获取节点的最后修改时间
public long getLastModified() {
return this.mLastModified;
}
// 获取节点的删除标记
public boolean getDeleted() {
return this.mDeleted;
}

@ -35,137 +35,195 @@ import org.json.JSONException;
import org.json.JSONObject;
// SqlData类可能用于处理与SQL数据库相关的数据操作与gtask数据相关
public class SqlData {
// 定义一个常量TAG用于在日志记录中标识该类值为类的简单名称
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_TYPE列的索引
public static final int DATA_MIME_TYPE_COLUMN = 1;
// 定义常量表示在投影列数组中CONTENT列的索引
public static final int DATA_CONTENT_COLUMN = 2;
// 定义常量表示在投影列数组中DATA1列的索引假设是CONTENT相关的数据1列
public static final int DATA_CONTENT_DATA_1_COLUMN = 3;
// 定义常量表示在投影列数组中DATA3列的索引假设是CONTENT相关的数据3列
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;
// 存储与数据内容相关的数据1具体含义根据业务而定
private long mDataContentData1;
// 存储与数据内容相关的数据3具体含义根据业务而定
private String mDataContentData3;
// 用于存储要更新的数据值
private ContentValues mDiffDataValues;
// 构造函数用于创建一个新的SqlData实例通常用于插入新数据
public SqlData(Context context) {
// 获取上下文的内容解析器,用于与内容提供器交互
mContentResolver = context.getContentResolver();
// 标记为创建操作
mIsCreate = true;
// 初始化数据ID为无效值
mDataId = INVALID_ID;
// 初始化MIME类型为默认值假设DataConstants.NOTE是一个常量表示笔记类型的MIME类型
mDataMimeType = DataConstants.NOTE;
// 初始化数据内容为空字符串
mDataContent = "";
// 初始化数据内容相关的数据1为0
mDataContentData1 = 0;
// 初始化数据内容相关的数据3为空字符串
mDataContentData3 = "";
// 创建一个新的ContentValues实例用于存储要更新的数据
mDiffDataValues = new ContentValues();
}
// 构造函数用于根据数据库游标创建一个SqlData实例通常用于查询现有数据
public SqlData(Context context, Cursor c) {
mContentResolver = context.getContentResolver();
// 标记为非创建操作(即查询或更新现有数据)
mIsCreate = false;
// 从游标加载数据到对象属性中
loadFromCursor(c);
mDiffDataValues = new ContentValues();
}
// 从游标加载数据到对象属性的私有方法
private void loadFromCursor(Cursor c) {
// 从游标获取ID列的值并赋值给mDataId
mDataId = c.getLong(DATA_ID_COLUMN);
// 从游标获取MIME_TYPE列的值并赋值给mDataMimeType
mDataMimeType = c.getString(DATA_MIME_TYPE_COLUMN);
// 从游标获取CONTENT列的值并赋值给mDataContent
mDataContent = c.getString(DATA_CONTENT_COLUMN);
// 从游标获取CONTENT相关的数据1列的值并赋值给mDataContentData1
mDataContentData1 = c.getLong(DATA_CONTENT_DATA_1_COLUMN);
// 从游标获取CONTENT相关的数据3列的值并赋值给mDataContentData3
mDataContentData3 = c.getString(DATA_CONTENT_DATA_3_COLUMN);
}
// 设置数据内容的方法接受一个JSONObject作为参数
public void setContent(JSONObject js) throws JSONException {
// 从JSON对象获取ID值如果不存在则使用无效ID
long dataId = js.has(DataColumns.ID) ? js.getLong(DataColumns.ID) : INVALID_ID;
// 如果是创建操作或者数据ID发生了变化则将新的ID值放入要更新的ContentValues中
if (mIsCreate || mDataId != dataId) {
mDiffDataValues.put(DataColumns.ID, dataId);
}
// 更新数据ID
mDataId = dataId;
// 从JSON对象获取MIME_TYPE值如果不存在则使用默认的MIME类型
String dataMimeType = js.has(DataColumns.MIME_TYPE) ? js.getString(DataColumns.MIME_TYPE)
: DataConstants.NOTE;
// 如果是创建操作或者MIME类型发生了变化则将新的MIME类型放入要更新的ContentValues中
if (mIsCreate || !mDataMimeType.equals(dataMimeType)) {
mDiffDataValues.put(DataColumns.MIME_TYPE, dataMimeType);
}
// 更新MIME类型
mDataMimeType = dataMimeType;
// 从JSON对象获取CONTENT值如果不存在则使用空字符串
String dataContent = js.has(DataColumns.CONTENT) ? js.getString(DataColumns.CONTENT) : "";
// 如果是创建操作或者数据内容发生了变化则将新的内容放入要更新的ContentValues中
if (mIsCreate || !mDataContent.equals(dataContent)) {
mDiffDataValues.put(DataColumns.CONTENT, dataContent);
}
// 更新数据内容
mDataContent = dataContent;
// 从JSON对象获取CONTENT相关的数据1值如果不存在则使用0
long dataContentData1 = js.has(DataColumns.DATA1) ? js.getLong(DataColumns.DATA1) : 0;
// 如果是创建操作或者数据内容相关的数据1发生了变化则将新的值放入要更新的ContentValues中
if (mIsCreate || mDataContentData1 != dataContentData1) {
mDiffDataValues.put(DataColumns.DATA1, dataContentData1);
}
// 更新数据内容相关的数据1
mDataContentData1 = dataContentData1;
// 从JSON对象获取CONTENT相关的数据3值如果不存在则使用空字符串
String dataContentData3 = js.has(DataColumns.DATA3) ? js.getString(DataColumns.DATA3) : "";
// 如果是创建操作或者数据内容相关的数据3发生了变化则将新的值放入要更新的ContentValues中
if (mIsCreate || !mDataContentData3.equals(dataContentData3)) {
mDiffDataValues.put(DataColumns.DATA3, dataContentData3);
}
// 更新数据内容相关的数据3
mDataContentData3 = dataContentData3;
}
// 获取数据内容的方法返回一个JSONObject
public JSONObject getContent() throws JSONException {
// 如果是创建操作记录错误日志并返回null因为数据还未在数据库中创建
if (mIsCreate) {
Log.e(TAG, "it seems that we haven't created this in database yet");
return null;
}
// 创建一个新的JSONObject
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);
// 将数据内容相关的数据1放入JSON对象
js.put(DataColumns.DATA1, mDataContentData1);
// 将数据内容相关的数据3放入JSON对象
js.put(DataColumns.DATA3, mDataContentData3);
return js;
}
// 提交数据到数据库的方法接受笔记ID、是否验证版本和版本号作为参数
public void commit(long noteId, boolean validateVersion, long version) {
// 如果是创建操作
if (mIsCreate) {
// 如果数据ID为无效值且要更新的ContentValues中包含ID列则移除ID列可能是因为插入操作不需要手动指定ID
if (mDataId == INVALID_ID && mDiffDataValues.containsKey(DataColumns.ID)) {
mDiffDataValues.remove(DataColumns.ID);
}
// 将笔记ID放入要更新的ContentValues中
mDiffDataValues.put(DataColumns.NOTE_ID, noteId);
// 使用内容解析器插入数据到指定的URI假设Notes.CONTENT_DATA_URI是一个常量表示数据插入的URI
Uri uri = mContentResolver.insert(Notes.CONTENT_DATA_URI, mDiffDataValues);
try {
// 尝试从插入后的URI路径片段中获取插入数据的ID并赋值给mDataId
mDataId = Long.valueOf(uri.getPathSegments().get(1));
} catch (NumberFormatException e) {
// 如果获取ID时发生数字格式异常记录错误日志并抛出ActionFailureException异常表示创建笔记失败
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) {
// 使用内容解析器更新指定ID的数据不进行版本验证
result = mContentResolver.update(ContentUris.withAppendedId(
Notes.CONTENT_DATA_URI, mDataId), mDiffDataValues, null, null);
} else {
// 使用内容解析器更新指定ID的数据并根据版本号进行验证假设NoteColumns.VERSION是一个常量表示版本列
result = mContentResolver.update(ContentUris.withAppendedId(
Notes.CONTENT_DATA_URI, mDataId), mDiffDataValues,
" ? in (SELECT " + NoteColumns.ID + " FROM " + TABLE.NOTE
@ -173,16 +231,19 @@ public class SqlData {
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的方法
public long getId() {
return mDataId;
}

@ -37,12 +37,13 @@ import org.json.JSONObject;
import java.util.ArrayList;
// SqlNote类可能用于处理与SQL数据库中笔记相关的数据操作与gtask数据相关
public class SqlNote {
// 定义一个常量TAG用于在日志记录中标识该类值为类的简单名称
private static final String TAG = SqlNote.class.getSimpleName();
// 定义一个无效的ID值用于初始化或表示无效的情况
private static final int INVALID_ID = -99999;
// 定义一个字符串数组,用于指定从数据库查询笔记时的投影列(即要查询的列)
public static final String[] PROJECTION_NOTE = new String[] {
NoteColumns.ID, NoteColumns.ALERTED_DATE, NoteColumns.BG_COLOR_ID,
NoteColumns.CREATED_DATE, NoteColumns.HAS_ATTACHMENT, NoteColumns.MODIFIED_DATE,
@ -51,83 +52,86 @@ public class SqlNote {
NoteColumns.LOCAL_MODIFIED, NoteColumns.ORIGIN_PARENT_ID, NoteColumns.GTASK_ID,
NoteColumns.VERSION
};
// 定义常量表示在投影列数组中ID列的索引
public static final int ID_COLUMN = 0;
// 定义常量表示在投影列数组中ALERTED_DATE列的索引
public static final int ALERTED_DATE_COLUMN = 1;
// 定义常量表示在投影列数组中BG_COLOR_ID列的索引
public static final int BG_COLOR_ID_COLUMN = 2;
// 定义常量表示在投影列数组中CREATED_DATE列的索引
public static final int CREATED_DATE_COLUMN = 3;
// 定义常量表示在投影列数组中HAS_ATTACHMENT列的索引
public static final int HAS_ATTACHMENT_COLUMN = 4;
// 定义常量表示在投影列数组中MODIFIED_DATE列的索引
public static final int MODIFIED_DATE_COLUMN = 5;
// 定义常量表示在投影列数组中NOTES_COUNT列的索引
public static final int NOTES_COUNT_COLUMN = 6;
// 定义常量表示在投影列数组中PARENT_ID列的索引
public static final int PARENT_ID_COLUMN = 7;
// 定义常量表示在投影列数组中SNIPPET列的索引
public static final int SNIPPET_COLUMN = 8;
// 定义常量表示在投影列数组中TYPE列的索引
public static final int TYPE_COLUMN = 9;
// 定义常量表示在投影列数组中WIDGET_ID列的索引
public static final int WIDGET_ID_COLUMN = 10;
// 定义常量表示在投影列数组中WIDGET_TYPE列的索引
public static final int WIDGET_TYPE_COLUMN = 11;
// 定义常量表示在投影列数组中SYNC_ID列的索引
public static final int SYNC_ID_COLUMN = 12;
// 定义常量表示在投影列数组中LOCAL_MODIFIED列的索引
public static final int LOCAL_MODIFIED_COLUMN = 13;
// 定义常量表示在投影列数组中ORIGIN_PARENT_ID列的索引
public static final int ORIGIN_PARENT_ID_COLUMN = 14;
// 定义常量表示在投影列数组中GTASK_ID列的索引
public static final int GTASK_ID_COLUMN = 15;
// 定义常量表示在投影列数组中VERSION列的索引
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;
// 存储笔记是否有附件0或1表示
private int mHasAttachment;
// 存储笔记的修改日期
private long mModifiedDate;
// 存储笔记的父ID
private long mParentId;
// 存储笔记的摘要或片段内容
private String mSnippet;
// 存储笔记的类型如普通笔记、文件夹等类型假设Notes.TYPE_NOTE等是常量表示不同类型
private int mType;
// 存储笔记关联的小部件ID
private int mWidgetId;
// 存储笔记关联的小部件类型
private int mWidgetType;
// 存储笔记的原始父ID可能用于记录笔记的来源或初始父节点
private long mOriginParent;
// 存储笔记的版本号
private long mVersion;
// 用于存储要更新的笔记数据值
private ContentValues mDiffNoteValues;
// 存储与笔记相关的数据列表可能是笔记包含的数据内容每个元素是SqlData类型
private ArrayList<SqlData> mDataList;
// 构造函数用于创建一个新的SqlNote实例通常用于插入新笔记
public SqlNote(Context context) {
mContext = context;
mContentResolver = context.getContentResolver();
mIsCreate = true;
mId = INVALID_ID;
mAlertDate = 0;
// 使用ResourceParser获取默认的背景颜色ID假设ResourceParser类提供了相关方法
mBgColorId = ResourceParser.getDefaultBgId(context);
mCreatedDate = System.currentTimeMillis();
mHasAttachment = 0;
@ -135,6 +139,7 @@ public class SqlNote {
mParentId = 0;
mSnippet = "";
mType = Notes.TYPE_NOTE;
// 使用无效的小部件ID初始化假设AppWidgetManager.INVALID_APPWIDGET_ID是一个常量表示无效ID
mWidgetId = AppWidgetManager.INVALID_APPWIDGET_ID;
mWidgetType = Notes.TYPE_WIDGET_INVALIDE;
mOriginParent = 0;
@ -143,17 +148,20 @@ public class SqlNote {
mDataList = new ArrayList<SqlData>();
}
// 构造函数用于根据数据库游标创建一个SqlNote实例通常用于查询现有笔记
public SqlNote(Context context, Cursor c) {
mContext = context;
mContentResolver = context.getContentResolver();
mIsCreate = false;
loadFromCursor(c);
mDataList = new ArrayList<SqlData>();
// 如果笔记类型是普通笔记则加载数据内容调用loadDataContent方法
if (mType == Notes.TYPE_NOTE)
loadDataContent();
mDiffNoteValues = new ContentValues();
}
// 构造函数用于根据指定的ID从数据库加载笔记数据创建一个SqlNote实例
public SqlNote(Context context, long id) {
mContext = context;
mContentResolver = context.getContentResolver();
@ -166,15 +174,18 @@ public class SqlNote {
}
// 从指定ID的游标加载笔记数据的私有方法
private void loadFromCursor(long id) {
Cursor c = null;
try {
// 使用内容解析器查询指定ID的笔记数据投影列为PROJECTION_NOTE查询条件为_id等于指定ID
c = mContentResolver.query(Notes.CONTENT_NOTE_URI, PROJECTION_NOTE, "(_id=?)",
new String[] {
String.valueOf(id)
}, null);
if (c != null) {
c.moveToNext();
// 从游标加载数据到对象属性中
loadFromCursor(c);
} else {
Log.w(TAG, "loadFromCursor: cursor = null");
@ -185,6 +196,7 @@ public class SqlNote {
}
}
// 从游标加载笔记数据到对象属性的私有方法
private void loadFromCursor(Cursor c) {
mId = c.getLong(ID_COLUMN);
mAlertDate = c.getLong(ALERTED_DATE_COLUMN);
@ -200,10 +212,12 @@ public class SqlNote {
mVersion = c.getLong(VERSION_COLUMN);
}
// 加载笔记数据内容的私有方法将与笔记相关的数据加载到mDataList中
private void loadDataContent() {
Cursor c = null;
mDataList.clear();
try {
// 使用内容解析器查询与笔记相关的数据投影列为SqlData.PROJECTION_DATA查询条件为note_id等于笔记ID
c = mContentResolver.query(Notes.CONTENT_DATA_URI, SqlData.PROJECTION_DATA,
"(note_id=?)", new String[] {
String.valueOf(mId)
@ -214,6 +228,7 @@ public class SqlNote {
return;
}
while (c.moveToNext()) {
// 根据游标创建SqlData实例并添加到数据列表中
SqlData data = new SqlData(mContext, c);
mDataList.add(data);
}
@ -226,13 +241,16 @@ public class SqlNote {
}
}
// 设置笔记内容的方法接受一个JSONObject作为参数
public boolean setContent(JSONObject js) {
try {
// 从JSON对象获取笔记头部信息假设GTaskStringUtils.META_HEAD_NOTE是一个常量表示笔记头部信息的键
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)) {
@ -247,6 +265,7 @@ public class SqlNote {
}
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) {

@ -31,20 +31,22 @@ import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;
// Task类继承自Node类可能用于表示任务相关的数据结构与gtask数据相关
public class Task extends Node {
// 定义一个常量TAG用于在日志记录中标识该类值为类的简单名称
private static final String TAG = Task.class.getSimpleName();
// 标记任务是否已完成
private boolean mCompleted;
// 存储任务的笔记内容
private String mNotes;
// 存储任务的元数据信息可能是与任务相关的额外信息以JSONObject形式存储
private JSONObject mMetaInfo;
// 存储任务的前一个兄弟任务(用于构建任务列表的顺序关系)
private Task mPriorSibling;
// 存储任务所属的父任务列表(表示任务的层级关系)
private TaskList mParent;
// 构造函数,初始化任务对象的属性
public Task() {
super();
mCompleted = false;
@ -54,47 +56,54 @@ public class Task extends Node {
mMetaInfo = null;
}
// 生成创建任务的JSON对象的方法用于与外部系统可能是gtask服务端交互指定创建任务的相关信息
public JSONObject getCreateAction(int actionId) {
JSONObject js = new JSONObject();
try {
// action_type
// 设置操作类型为创建任务假设GTaskStringUtils.GTASK_JSON_ACTION_TYPE_CREATE是一个常量表示创建操作类型
js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE,
GTaskStringUtils.GTASK_JSON_ACTION_TYPE_CREATE);
// action_id
// 设置操作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");
// 设置任务实体类型为任务假设GTaskStringUtils.GTASK_JSON_TYPE_TASK是一个常量表示任务类型
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
// 设置目标父类型为组假设GTaskStringUtils.GTASK_JSON_TYPE_GROUP是一个常量表示组类型
js.put(GTaskStringUtils.GTASK_JSON_DEST_PARENT_TYPE,
GTaskStringUtils.GTASK_JSON_TYPE_GROUP);
// list_id
// 设置列表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) {
// 如果在创建JSON对象过程中发生异常记录错误日志打印堆栈跟踪并抛出ActionFailureException异常表示生成创建任务的JSON对象失败
Log.e(TAG, e.toString());
e.printStackTrace();
throw new ActionFailureException("fail to generate task-create jsonobject");
@ -103,30 +112,36 @@ public class Task extends Node {
return js;
}
// 生成更新任务的JSON对象的方法用于与外部系统可能是gtask服务端交互指定更新任务的相关信息
public JSONObject getUpdateAction(int actionId) {
JSONObject js = new JSONObject();
try {
// action_type
// 设置操作类型为更新任务假设GTaskStringUtils.GTASK_JSON_ACTION_TYPE_UPDATE是一个常量表示更新操作类型
js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE,
GTaskStringUtils.GTASK_JSON_ACTION_TYPE_UPDATE);
// action_id
// 设置操作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) {
// 如果在创建JSON对象过程中发生异常记录错误日志打印堆栈跟踪并抛出ActionFailureException异常表示生成更新任务的JSON对象失败
Log.e(TAG, e.toString());
e.printStackTrace();
throw new ActionFailureException("fail to generate task-update jsonobject");
@ -134,40 +149,41 @@ public class Task extends Node {
return js;
}
// 根据远程JSON数据设置任务内容的方法从远程获取的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) {
// 如果在解析JSON数据过程中发生异常记录错误日志打印堆栈跟踪并抛出ActionFailureException异常表示从JSON对象获取任务内容失败
Log.e(TAG, e.toString());
e.printStackTrace();
throw new ActionFailureException("fail to get task content from jsonobject");
@ -175,6 +191,7 @@ public class Task extends Node {
}
}
// 根据本地JSON数据设置任务内容的方法从本地存储的JSON数据中解析并设置任务的名称根据特定的结构和条件
public void setContentByLocalJSON(JSONObject js) {
if (js == null || !js.has(GTaskStringUtils.META_HEAD_NOTE)
|| !js.has(GTaskStringUtils.META_HEAD_DATA)) {
@ -204,11 +221,12 @@ public class Task extends Node {
}
}
// 从任务内容生成本地JSON对象的方法根据任务的当前状态是否有元数据等构建用于本地存储或传输的JSON对象
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;
@ -225,7 +243,7 @@ public class Task extends Node {
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);
@ -247,6 +265,7 @@ public class Task extends Node {
}
}
// 设置任务元数据信息的方法接受一个MetaData对象从其中获取笔记内容并尝试转换为JSONObject作为元数据
public void setMetaInfo(MetaData metaData) {
if (metaData != null && metaData.getNotes() != null) {
try {
@ -258,6 +277,7 @@ public class Task extends Node {
}
}
// 根据数据库游标获取任务的同步操作类型的方法通过比较任务的各种属性如元数据中的笔记ID、本地修改标记、gtask ID等与数据库中的数据来确定同步操作类型
public int getSyncAction(Cursor c) {
try {
JSONObject noteInfo = null;
@ -275,29 +295,29 @@ public class Task extends Node {
return SYNC_ACTION_UPDATE_LOCAL;
}
// validate the note id now
// 验证笔记ID是否匹配
if (c.getLong(SqlNote.ID_COLUMN) != noteInfo.getLong(NoteColumns.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
// 验证gtask ID是否匹配
if (!c.getString(SqlNote.GTASK_ID_COLUMN).equals(getGid())) {
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;
@ -311,39 +331,48 @@ public class Task extends Node {
return SYNC_ACTION_ERROR;
}
// 判断任务是否值得保存的方法,根据任务是否有元数据、名称或笔记内容来确定
public boolean isWorthSaving() {
return mMetaInfo != null || (getName() != null && getName().trim().length() > 0)
|| (getNotes() != null && getNotes().trim().length() > 0);
}
// 设置任务完成标记的方法
public void setCompleted(boolean completed) {
this.mCompleted = completed;
}
// 设置任务笔记内容的方法
public void setNotes(String notes) {
this.mNotes = notes;
}
// 设置任务前一个兄弟任务的方法
public void setPriorSibling(Task priorSibling) {
this.mPriorSibling = priorSibling;
}
// 设置任务父任务列表的方法
public void setParent(TaskList parent) {
this.mParent = parent;
}
// 获取任务完成标记的方法
public boolean getCompleted() {
return this.mCompleted;
}
// 获取任务笔记内容的方法
public String getNotes() {
return this.mNotes;
}
// 获取任务前一个兄弟任务的方法
public Task getPriorSibling() {
return this.mPriorSibling;
}
// 获取任务父任务列表的方法
public TaskList getParent() {
return this.mParent;
}

@ -29,43 +29,51 @@ import org.json.JSONObject;
import java.util.ArrayList;
// TaskList类继承自Node类可能用于表示任务列表相关的数据结构与gtask数据相关
public class TaskList extends Node {
// 定义一个常量TAG用于在日志记录中标识该类值为类的简单名称
private static final String TAG = TaskList.class.getSimpleName();
// 存储任务列表的索引(可能用于在某个父级结构中的排序或标识)
private int mIndex;
// 存储任务列表中的任务集合使用ArrayList存储任务对象
private ArrayList<Task> mChildren;
// 构造函数,初始化任务列表对象的属性
public TaskList() {
super();
mChildren = new ArrayList<Task>();
mIndex = 1;
}
// 生成创建任务列表的JSON对象的方法用于与外部系统可能是gtask服务端交互指定创建任务列表的相关信息
public JSONObject getCreateAction(int actionId) {
JSONObject js = new JSONObject();
try {
// action_type
// 设置操作类型为创建任务列表假设GTaskStringUtils.GTASK_JSON_ACTION_TYPE_CREATE是一个常量表示创建操作类型
js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE,
GTaskStringUtils.GTASK_JSON_ACTION_TYPE_CREATE);
// action_id
// 设置操作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");
// 设置任务列表实体类型为组假设GTaskStringUtils.GTASK_JSON_TYPE_GROUP是一个常量表示组类型
entity.put(GTaskStringUtils.GTASK_JSON_ENTITY_TYPE,
GTaskStringUtils.GTASK_JSON_TYPE_GROUP);
// 将任务列表实体添加到操作JSON对象中
js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity);
} catch (JSONException e) {
// 如果在创建JSON对象过程中发生异常记录错误日志打印堆栈跟踪并抛出ActionFailureException异常表示生成创建任务列表的JSON对象失败
Log.e(TAG, e.toString());
e.printStackTrace();
throw new ActionFailureException("fail to generate tasklist-create jsonobject");
@ -74,27 +82,32 @@ public class TaskList extends Node {
return js;
}
// 生成更新任务列表的JSON对象的方法用于与外部系统可能是gtask服务端交互指定更新任务列表的相关信息
public JSONObject getUpdateAction(int actionId) {
JSONObject js = new JSONObject();
try {
// action_type
// 设置操作类型为更新任务列表假设GTaskStringUtils.GTASK_JSON_ACTION_TYPE_UPDATE是一个常量表示更新操作类型
js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE,
GTaskStringUtils.GTASK_JSON_ACTION_TYPE_UPDATE);
// action_id
// 设置操作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) {
// 如果在创建JSON对象过程中发生异常记录错误日志打印堆栈跟踪并抛出ActionFailureException异常表示生成更新任务列表的JSON对象失败
Log.e(TAG, e.toString());
e.printStackTrace();
throw new ActionFailureException("fail to generate tasklist-update jsonobject");
@ -103,25 +116,27 @@ public class TaskList extends Node {
return js;
}
// 根据远程JSON数据设置任务列表内容的方法从远程获取的JSON数据中解析并设置任务列表的各种属性如ID、最后修改时间、名称
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) {
// 如果在解析JSON数据过程中发生异常记录错误日志打印堆栈跟踪并抛出ActionFailureException异常表示从JSON对象获取任务列表内容失败
Log.e(TAG, e.toString());
e.printStackTrace();
throw new ActionFailureException("fail to get tasklist content from jsonobject");
@ -129,6 +144,7 @@ public class TaskList extends Node {
}
}
// 根据本地JSON数据设置任务列表内容的方法从本地存储的JSON数据中解析并设置任务列表的名称根据特定的结构和条件区分文件夹类型和系统类型
public void setContentByLocalJSON(JSONObject js) {
if (js == null || !js.has(GTaskStringUtils.META_HEAD_NOTE)) {
Log.w(TAG, "setContentByLocalJSON: nothing is avaiable");
@ -157,6 +173,7 @@ public class TaskList extends Node {
}
}
// 从任务列表内容生成本地JSON对象的方法根据任务列表的当前状态构建用于本地存储或传输的JSON对象包含任务列表名称、类型等信息
public JSONObject getLocalJSONFromContent() {
try {
JSONObject js = new JSONObject();
@ -183,28 +200,29 @@ public class TaskList extends Node {
}
}
// 从任务列表内容生成本地JSON对象的方法根据任务列表的当前状态构建用于本地存储或传输的JSON对象包含任务列表名称、类型等信息
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
// 验证gtask ID是否匹配
if (!c.getString(SqlNote.GTASK_ID_COLUMN).equals(getGid())) {
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;
}
}
@ -216,16 +234,18 @@ public class TaskList extends Node {
return SYNC_ACTION_ERROR;
}
// 获取任务列表中任务数量的方法
public int getChildTaskCount() {
return mChildren.size();
}
// 向任务列表中添加任务的方法,将任务添加到任务列表末尾,并设置任务的前一个兄弟任务和父任务列表
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,6 +254,7 @@ public class TaskList extends Node {
return ret;
}
// 向任务列表中指定位置添加任务的方法,根据指定索引将任务插入到任务列表中,并更新任务列表中任务的前一个兄弟任务关系
public boolean addChildTask(Task task, int index) {
if (index < 0 || index > mChildren.size()) {
Log.e(TAG, "add child task: invalid index");
@ -244,7 +265,7 @@ public class TaskList extends Node {
if (task != null && pos == -1) {
mChildren.add(index, task);
// update the task list
// 更新任务列表
Task preTask = null;
Task afterTask = null;
if (index != 0)
@ -260,6 +281,7 @@ public class TaskList extends Node {
return true;
}
// 从任务列表中移除任务的方法,从任务列表中移除指定任务,并重置任务的前一个兄弟任务和父任务关系,同时更新任务列表中任务的前一个兄弟任务关系
public boolean removeChildTask(Task task) {
boolean ret = false;
int index = mChildren.indexOf(task);
@ -267,11 +289,11 @@ public class TaskList extends Node {
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,6 +303,7 @@ public class TaskList extends Node {
return ret;
}
// 在任务列表中移动任务到指定位置的方法,先移除任务再添加到指定位置,实现任务在任务列表中的移动
public boolean moveChildTask(Task task, int index) {
if (index < 0 || index >= mChildren.size()) {
@ -299,6 +322,7 @@ public class TaskList extends Node {
return (removeChildTask(task) && addChildTask(task, index));
}
// 根据任务ID查找任务列表中的任务的方法遍历任务列表查找并返回具有指定ID的任务如果未找到则返回null
public Task findChildTaskByGid(String gid) {
for (int i = 0; i < mChildren.size(); i++) {
Task t = mChildren.get(i);
@ -309,10 +333,12 @@ public class TaskList extends Node {
return null;
}
// 获取任务在任务列表中的索引的方法,返回任务在任务列表中的位置索引,如果任务不在列表中则返回 -1
public int getChildTaskIndex(Task task) {
return mChildren.indexOf(task);
}
// 根据索引获取任务列表中的任务的方法根据指定索引返回任务列表中的任务如果索引无效则记录错误日志并返回null
public Task getChildTaskByIndex(int index) {
if (index < 0 || index >= mChildren.size()) {
Log.e(TAG, "getTaskByIndex: invalid index");
@ -321,6 +347,7 @@ public class TaskList extends Node {
return mChildren.get(index);
}
// 根据任务ID获取任务列表中的任务的方法与findChildTaskByGid方法功能类似可能是为了提供不同的查找方式
public Task getChilTaskByGid(String gid) {
for (Task task : mChildren) {
if (task.getGid().equals(gid))
@ -328,15 +355,17 @@ public class TaskList extends Node {
}
return null;
}
// 获取任务列表中所有任务的列表的方法
public ArrayList<Task> getChildTaskList() {
return this.mChildren;
}
// 设置任务列表索引的方法
public void setIndex(int index) {
this.mIndex = index;
}
// 获取任务列表索引的方法
public int getIndex() {
return this.mIndex;
}

@ -15,18 +15,22 @@
*/
package net.micode.notes.gtask.exception;
// 定义一个名为ActionFailureException的异常类它继承自RuntimeException表示运行时异常
public class ActionFailureException extends RuntimeException {
// serialVersionUID用于在序列化和反序列化过程中验证类的版本一致性
private static final long serialVersionUID = 4425249765923293627L;
// 无参构造函数调用父类RuntimeException的无参构造函数
public ActionFailureException() {
super();
}
// 带字符串参数的构造函数,将传入的字符串作为异常信息传递给父类构造函数
public ActionFailureException(String paramString) {
super(paramString);
}
// 带字符串和Throwable参数的构造函数将传入的字符串作为异常信息Throwable作为异常原因传递给父类构造函数
public ActionFailureException(String paramString, Throwable paramThrowable) {
super(paramString, paramThrowable);
}

@ -16,17 +16,22 @@
package net.micode.notes.gtask.exception;
// 定义一个名为NetworkFailureException的异常类它继承自Exception表示这是一个需要被检查处理的异常
public class NetworkFailureException extends Exception {
// serialVersionUID用于在序列化和反序列化过程中验证类的版本一致性
private static final long serialVersionUID = 2107610287180234136L;
// 无参构造函数调用父类Exception的无参构造函数
public NetworkFailureException() {
super();
}
// 带字符串参数的构造函数,将传入的字符串作为异常信息传递给父类构造函数
public NetworkFailureException(String paramString) {
super(paramString);
}
// 带字符串和Throwable参数的构造函数将传入的字符串作为异常信息Throwable作为异常原因传递给父类构造函数
public NetworkFailureException(String paramString, Throwable paramThrowable) {
super(paramString, paramThrowable);
}

@ -28,47 +28,53 @@ import net.micode.notes.R;
import net.micode.notes.ui.NotesListActivity;
import net.micode.notes.ui.NotesPreferenceActivity;
// 该类继承自 AsyncTask用于在后台执行与 GTask 同步相关的任务,并在任务执行过程中更新进度、处理结果并显示通知
public class GTaskASyncTask extends AsyncTask<Void, String, Integer> {
// 用于标识 GTask 同步通知的 ID
private static int GTASK_SYNC_NOTIFICATION_ID = 5234235;
// 定义任务完成监听器接口
public interface OnCompleteListener {
void onComplete();
}
// 上下文对象,用于获取系统服务和资源
private Context mContext;
// 通知管理器,用于显示通知
private NotificationManager mNotifiManager;
// GTask 管理器实例,用于执行同步操作
private GTaskManager mTaskManager;
// 任务完成监听器实例
private OnCompleteListener mOnCompleteListener;
// 构造函数,初始化相关成员变量
public GTaskASyncTask(Context context, OnCompleteListener listener) {
mContext = context;
mOnCompleteListener = listener;
// 获取通知管理器服务
mNotifiManager = (NotificationManager) mContext
.getSystemService(Context.NOTIFICATION_SERVICE);
// 获取 GTask 管理器单例实例
mTaskManager = GTaskManager.getInstance();
}
// 取消同步的方法,调用 GTask 管理器的取消同步方法
public void cancelSync() {
mTaskManager.cancelSync();
}
// 发布进度的方法,调用父类的 publishProgress 方法传递进度信息
public void publishProgess(String message) {
publishProgress(new String[] {
message
});
}
// 显示通知的私有方法,根据给定的 tickerId 和内容创建并显示通知
private void showNotification(int tickerId, String content) {
// 创建通知对象,设置图标、标题和时间
Notification notification = new Notification(R.drawable.notification, mContext
.getString(tickerId), System.currentTimeMillis());
// 设置通知默认的灯光效果
notification.defaults = Notification.DEFAULT_LIGHTS;
// 设置通知自动取消
notification.flags = Notification.FLAG_AUTO_CANCEL;
PendingIntent pendingIntent;
// 根据 tickerId 设置不同的点击意图
if (tickerId != R.string.ticker_success) {
pendingIntent = PendingIntent.getActivity(mContext, 0, new Intent(mContext,
NotesPreferenceActivity.class), 0);
@ -77,32 +83,40 @@ public class GTaskASyncTask extends AsyncTask<Void, String, Integer> {
pendingIntent = PendingIntent.getActivity(mContext, 0, new Intent(mContext,
NotesListActivity.class), 0);
}
// 设置通知的详细信息和点击意图
notification.setLatestEventInfo(mContext, mContext.getString(R.string.app_name), content,
pendingIntent);
// 显示通知
mNotifiManager.notify(GTASK_SYNC_NOTIFICATION_ID, notification);
}
// 重写 doInBackground 方法,在后台线程执行同步任务
@Override
protected Integer doInBackground(Void... unused) {
// 发布登录进度通知
publishProgess(mContext.getString(R.string.sync_progress_login, NotesPreferenceActivity
.getSyncAccountName(mContext)));
// 调用 GTask 管理器的同步方法并返回结果
return mTaskManager.sync(mContext, this);
}
// 重写 onProgressUpdate 方法,在主线程更新进度通知
@Override
protected void onProgressUpdate(String... progress) {
// 显示同步进度通知
showNotification(R.string.ticker_syncing, progress[0]);
// 如果上下文是 GTaskSyncService则发送广播传递进度信息
if (mContext instanceof GTaskSyncService) {
((GTaskSyncService) mContext).sendBroadcast(progress[0]);
}
}
// 重写 onPostExecute 方法,在主线程处理同步任务结果
@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());
// 设置最后同步时间
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) {
@ -111,6 +125,7 @@ public class GTaskASyncTask extends AsyncTask<Void, String, Integer> {
showNotification(R.string.ticker_cancel, mContext
.getString(R.string.error_sync_cancelled));
}
// 如果有任务完成监听器,则在新线程中触发监听器的 onComplete 方法
if (mOnCompleteListener != null) {
new Thread(new Runnable() {

@ -59,37 +59,39 @@ import java.util.List;
import java.util.zip.GZIPInputStream;
import java.util.zip.Inflater;
import java.util.zip.InflaterInputStream;
// 该类是与 Google TasksGTask进行交互的客户端类负责处理登录、任务和任务列表的创建、更新、移动、删除以及获取等操作
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 客户端实例,用于发送 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;
// 同步的 Google 账户
private Account mAccount;
// 用于存储待提交的更新操作数组
private JSONArray mUpdateArray;
// 私有构造函数,初始化成员变量
private GTaskClient() {
mHttpClient = null;
mGetUrl = GTASK_GET_URL;
@ -101,23 +103,21 @@ public class GTaskClient {
mAccount = null;
mUpdateArray = null;
}
// 单例模式获取实例的方法
public static synchronized GTaskClient getInstance() {
if (mInstance == null) {
mInstance = new GTaskClient();
}
return mInstance;
}
// 登录方法,根据账户状态和设置进行登录操作
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))) {
@ -130,13 +130,13 @@ public class GTaskClient {
}
mLastLoginTime = System.currentTimeMillis();
// 登录 Google 账户获取授权令牌
String authToken = loginGoogleAccount(activity, false);
if (authToken == null) {
Log.e(TAG, "login google account failed");
return false;
}
// login with custom domain if necessary
// 如果账户不是 gmail.com 或 googlemail.com 结尾,使用自定义域名登录 GTask
if (!(mAccount.name.toLowerCase().endsWith("gmail.com") || mAccount.name.toLowerCase()
.endsWith("googlemail.com"))) {
StringBuilder url = new StringBuilder(GTASK_URL).append("a/");
@ -150,8 +150,8 @@ public class GTaskClient {
mLoggedin = true;
}
}
// try to login with google official url
// 使用 Google 官方 URL 登录 GTask
if (!mLoggedin) {
mGetUrl = GTASK_GET_URL;
mPostUrl = GTASK_POST_URL;
@ -159,21 +159,23 @@ public class GTaskClient {
return false;
}
}
mLoggedin = true;
return true;
}
// 登录 Google 账户的私有方法
private String loginGoogleAccount(Activity activity, boolean invalidateToken) {
String authToken;
// 获取账户管理器实例
AccountManager accountManager = AccountManager.get(activity);
// 获取所有 Google 账户
Account[] accounts = accountManager.getAccountsByType("com.google");
if (accounts.length == 0) {
Log.e(TAG, "there is no available google account");
return null;
}
// 获取同步账户名称
String accountName = NotesPreferenceActivity.getSyncAccountName(activity);
Account account = null;
for (Account a : accounts) {
@ -188,8 +190,7 @@ public class GTaskClient {
Log.e(TAG, "unable to get an account with the same name in the settings");
return null;
}
// get the token now
// 获取授权令牌
AccountManagerFuture<Bundle> accountManagerFuture = accountManager.getAuthToken(account,
"goanna_mobile", null, activity, null, null);
try {
@ -206,9 +207,10 @@ public class GTaskClient {
return authToken;
}
// 尝试登录 GTask 的私有方法
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);
@ -224,10 +226,11 @@ public class GTaskClient {
}
return true;
}
// 登录 GTask 的私有方法,获取客户端版本号和设置 HTTP 客户端相关参数
private boolean loginGtask(String authToken) {
int timeoutConnection = 10000;
int timeoutSocket = 15000;
// 设置 HTTP 请求参数
HttpParams httpParameters = new BasicHttpParams();
HttpConnectionParams.setConnectionTimeout(httpParameters, timeoutConnection);
HttpConnectionParams.setSoTimeout(httpParameters, timeoutSocket);
@ -236,14 +239,14 @@ public class GTaskClient {
mHttpClient.setCookieStore(localBasicCookieStore);
HttpProtocolParams.setUseExpectContinue(mHttpClient.getParams(), false);
// login gtask
// 登录 GTask
try {
String loginUrl = mGetUrl + "?auth=" + authToken;
HttpGet httpGet = new HttpGet(loginUrl);
HttpResponse response = null;
response = mHttpClient.execute(httpGet);
// get the cookie now
// 获取登录后的 cookie
List<Cookie> cookies = mHttpClient.getCookieStore().getCookies();
boolean hasAuthCookie = false;
for (Cookie cookie : cookies) {
@ -255,7 +258,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 = ")}</script>";
@ -279,18 +282,18 @@ public class GTaskClient {
return true;
}
// 获取操作 ID 的方法,每次调用后自增
private int getActionId() {
return mActionId++;
}
// 创建用于提交任务操作的 HttpPost 对象的方法
private HttpPost createHttpPost() {
HttpPost httpPost = new HttpPost(mPostUrl);
httpPost.setHeader("Content-Type", "application/x-www-form-urlencoded;charset=utf-8");
httpPost.setHeader("AT", "1");
return httpPost;
}
// 从 HTTP 响应实体中获取响应内容的方法,处理不同的编码格式
private String getResponseContent(HttpEntity entity) throws IOException {
String contentEncoding = null;
if (entity.getContentEncoding() != null) {
@ -322,7 +325,7 @@ public class GTaskClient {
input.close();
}
}
// 提交 POST 请求的方法,将 JSON 数据发送到 GTask 服务器并处理响应
private JSONObject postRequest(JSONObject js) throws NetworkFailureException {
if (!mLoggedin) {
Log.e(TAG, "please login first");
@ -336,7 +339,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);
@ -359,21 +362,21 @@ public class GTaskClient {
throw new ActionFailureException("error occurs when posting request");
}
}
// 创建任务的方法,将任务创建操作提交到 GTask 服务器
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
// 提交请求并处理响应,设置任务的全局 ID
JSONObject jsResponse = postRequest(jsPost);
JSONObject jsResult = (JSONObject) jsResponse.getJSONArray(
GTaskStringUtils.GTASK_JSON_RESULTS).get(0);
@ -385,21 +388,21 @@ public class GTaskClient {
throw new ActionFailureException("create task: handing jsonobject failed");
}
}
// 创建任务列表的方法,将任务列表创建操作提交到 GTask 服务器
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
// 提交请求并处理响应,设置任务列表的全局 ID
JSONObject jsResponse = postRequest(jsPost);
JSONObject jsResult = (JSONObject) jsResponse.getJSONArray(
GTaskStringUtils.GTASK_JSON_RESULTS).get(0);
@ -411,16 +414,16 @@ public class GTaskClient {
throw new ActionFailureException("create tasklist: handing jsonobject failed");
}
}
// 提交更新操作的方法,将存储的更新操作数组提交到 GTask 服务器
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);
@ -432,11 +435,10 @@ public class GTaskClient {
}
}
}
// 添加更新节点操作的方法,将节点更新操作添加到更新操作数组
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();
}
@ -446,81 +448,98 @@ public class GTaskClient {
mUpdateArray.put(node.getUpdateAction(getActionId()));
}
}
// 移动任务的方法,将任务移动操作提交到 GTask 服务器
public void moveTask(Task task, TaskList preParent, TaskList curParent)
throws NetworkFailureException {
// 先提交之前可能存在的更新操作
commitUpdate();
try {
JSONObject jsPost = new JSONObject();
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) {
// 设置操作 ID
action.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, getActionId());
// 设置要移动的任务的 ID
action.put(GTaskStringUtils.GTASK_JSON_ID, task.getGid());
// 如果源任务列表和目标任务列表相同且任务有前驱兄弟节点,则设置前驱兄弟节点 ID
if (preParent == curParent && task.getPriorSibling() != null) {
// put prioring_sibing_id only if moving within the tasklist and
// it is not the first one
action.put(GTaskStringUtils.GTASK_JSON_PRIOR_SIBLING_ID, task.getPriorSibling());
}
// 设置源任务列表 ID
action.put(GTaskStringUtils.GTASK_JSON_SOURCE_LIST, preParent.getGid());
// 设置目标父任务列表 ID
action.put(GTaskStringUtils.GTASK_JSON_DEST_PARENT, curParent.getGid());
// 如果源任务列表和目标任务列表不同,则设置目标任务列表 ID
if (preParent != curParent) {
// put the dest_list only if moving between tasklists
action.put(GTaskStringUtils.GTASK_JSON_DEST_LIST, curParent.getGid());
}
// 将操作添加到操作列表
actionList.put(action);
// 将操作列表添加到提交的 JSON 对象中
jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, actionList);
// client_version
// 设置客户端版本号
jsPost.put(GTaskStringUtils.GTASK_JSON_CLIENT_VERSION, mClientVersion);
// 提交请求
postRequest(jsPost);
} catch (JSONException e) {
Log.e(TAG, e.toString());
e.printStackTrace();
// 如果 JSON 处理出现问题,抛出操作失败异常
throw new ActionFailureException("move task: handing jsonobject failed");
}
}
// 删除节点的方法,接受要删除的节点作为参数,并可能抛出网络异常
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()));
// 将操作列表添加到提交的 JSON 对象中
jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, actionList);
// client_version
// 设置客户端版本号
jsPost.put(GTaskStringUtils.GTASK_JSON_CLIENT_VERSION, mClientVersion);
// 提交请求并删除后将更新数组置空
postRequest(jsPost);
mUpdateArray = null;
} catch (JSONException e) {
Log.e(TAG, e.toString());
e.printStackTrace();
// 如果 JSON 处理出现问题,抛出操作失败异常
throw new ActionFailureException("delete node: handing jsonobject failed");
}
}
// 获取所有任务列表的方法,可能抛出网络异常
public JSONArray getTaskLists() throws NetworkFailureException {
// 检查是否已登录,未登录则抛出异常
if (!mLoggedin) {
Log.e(TAG, "please login first");
throw new ActionFailureException("not logged in");
}
try {
// 创建 HTTP GET 请求
HttpGet httpGet = new HttpGet(mGetUrl);
HttpResponse response = null;
// 执行请求
response = mHttpClient.execute(httpGet);
// get the task list
// 获取响应内容并解析出任务列表的 JSON 数组
String resString = getResponseContent(response.getEntity());
String jsBegin = "_setup(";
String jsEnd = ")}</script>";
@ -535,50 +554,60 @@ public class GTaskClient {
} catch (ClientProtocolException e) {
Log.e(TAG, e.toString());
e.printStackTrace();
// 如果 HTTP 协议出现问题,抛出网络异常
throw new NetworkFailureException("gettasklists: httpget failed");
} catch (IOException e) {
Log.e(TAG, e.toString());
e.printStackTrace();
// 如果 I/O 出现问题,抛出网络异常
throw new NetworkFailureException("gettasklists: httpget failed");
} catch (JSONException e) {
Log.e(TAG, e.toString());
e.printStackTrace();
// 如果 JSON 解析出现问题,抛出操作失败异常
throw new ActionFailureException("get task lists: handing jasonobject failed");
}
}
// 根据任务列表 ID 获取任务列表的方法,可能抛出网络异常
public JSONArray getTaskList(String listGid) throws NetworkFailureException {
// 先提交之前可能存在的更新操作
commitUpdate();
try {
JSONObject jsPost = new JSONObject();
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());
action.put(GTaskStringUtils.GTASK_JSON_LIST_ID, listGid);
action.put(GTaskStringUtils.GTASK_JSON_GET_DELETED, false);
actionList.put(action);
jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, actionList);
// client_version
// 设置操作 ID
action.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, getActionId());
// 设置任务列表 ID
action.put(GTaskStringUtils.GTASK_JSON_LIST_ID, listGid);
// 设置不获取已删除任务
action.put(GTaskStringUtils.GTASK_JSON_GET_DELETED, false);
// 将操作添加到操作列表
actionList.put(action);
// 将操作列表添加到提交的 JSON 对象中
jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, actionList);
// 设置客户端版本号
jsPost.put(GTaskStringUtils.GTASK_JSON_CLIENT_VERSION, mClientVersion);
// 提交请求并获取响应中的任务列表 JSON 数组
JSONObject jsResponse = postRequest(jsPost);
return jsResponse.getJSONArray(GTaskStringUtils.GTASK_JSON_TASKS);
} catch (JSONException e) {
Log.e(TAG, e.toString());
e.printStackTrace();
// 如果 JSON 处理出现问题,抛出操作失败异常
throw new ActionFailureException("get task list: handing jsonobject failed");
}
}
// 获取同步账户的方法
public Account getSyncAccount() {
return mAccount;
}
// 重置更新数组的方法,将更新数组置空
public void resetUpdateArray() {
mUpdateArray = null;
}

@ -47,10 +47,10 @@ import java.util.HashSet;
import java.util.Iterator;
import java.util.Map;
// GTaskManager类用于管理与Google Task的同步操作以及本地数据和远程数据的交互
public class GTaskManager {
private static final String TAG = GTaskManager.class.getSimpleName();
// 定义同步操作的各种状态码
public static final int STATE_SUCCESS = 0;
public static final int STATE_NETWORK_ERROR = 1;
@ -60,33 +60,33 @@ public class GTaskManager {
public static final int STATE_SYNC_IN_PROGRESS = 3;
public static final int STATE_SYNC_CANCELLED = 4;
// 单例模式确保只有一个GTaskManager实例
private static GTaskManager mInstance = null;
// 用于获取认证令牌等操作的Activity
private Activity mActivity;
// 应用上下文
private Context mContext;
// 用于访问内容提供者的ContentResolver
private ContentResolver mContentResolver;
// 表示是否正在同步
private boolean mSyncing;
// 表示同步是否已取消
private boolean mCancelled;
// 存储Google Task列表的哈希表键为任务列表的全局唯一标识符gid值为TaskList对象
private HashMap<String, TaskList> mGTaskListHashMap;
// 存储Google Task节点任务或任务列表的哈希表键为节点的gid值为Node对象
private HashMap<String, Node> mGTaskHashMap;
// 存储元数据的哈希表键为相关的gid值为MetaData对象
private HashMap<String, MetaData> mMetaHashMap;
// 元数据列表
private TaskList mMetaList;
// 存储本地已删除笔记的ID集合
private HashSet<Long> mLocalDeleteIdMap;
// 用于将Google Task的gid映射到本地笔记的ID
private HashMap<String, Long> mGidToNid;
// 用于将本地笔记的ID映射到Google Task的gid
private HashMap<Long, String> mNidToGid;
// 私有构造函数,用于初始化各种数据结构和变量
private GTaskManager() {
mSyncing = false;
mCancelled = false;
@ -98,21 +98,22 @@ public class GTaskManager {
mGidToNid = new HashMap<String, Long>();
mNidToGid = new HashMap<Long, String>();
}
// 获取GTaskManager的单例实例
public static synchronized GTaskManager getInstance() {
if (mInstance == null) {
mInstance = new GTaskManager();
}
return mInstance;
}
// 设置Activity上下文主要用于获取认证令牌
public synchronized void setActivityContext(Activity activity) {
// used for getting authtoken
mActivity = activity;
}
// 执行同步操作的主要方法
public int sync(Context context, GTaskASyncTask asyncTask) {
if (mSyncing) {
// 如果同步已经在进行中,记录日志并返回相应状态码
Log.d(TAG, "Sync is in progress");
return STATE_SYNC_IN_PROGRESS;
}
@ -120,6 +121,7 @@ public class GTaskManager {
mContentResolver = mContext.getContentResolver();
mSyncing = true;
mCancelled = false;
// 清除之前同步过程中存储的数据
mGTaskListHashMap.clear();
mGTaskHashMap.clear();
mMetaHashMap.clear();
@ -131,24 +133,26 @@ public class GTaskManager {
GTaskClient client = GTaskClient.getInstance();
client.resetUpdateArray();
// login google task
// 登录Google Task
if (!mCancelled) {
if (!client.login(mActivity)) {
throw new NetworkFailureException("login google task failed");
}
}
// get the task list from google
// 获取Google Task列表并进行初始化
asyncTask.publishProgess(mContext.getString(R.string.sync_progress_init_list));
initGTaskList();
// do content sync work
// 执行内容同步操作
asyncTask.publishProgess(mContext.getString(R.string.sync_progress_syncing));
syncContent();
} catch (NetworkFailureException e) {
// 处理网络故障异常,记录日志并返回相应状态码
Log.e(TAG, e.toString());
return STATE_NETWORK_ERROR;
} catch (ActionFailureException e) {
// 处理操作失败异常,记录日志并返回相应状态码
Log.e(TAG, e.toString());
return STATE_INTERNAL_ERROR;
} catch (Exception e) {
@ -156,6 +160,7 @@ public class GTaskManager {
e.printStackTrace();
return STATE_INTERNAL_ERROR;
} finally {
// 无论同步是否成功,都清除相关数据并重置同步状态
mGTaskListHashMap.clear();
mGTaskHashMap.clear();
mMetaHashMap.clear();
@ -164,7 +169,7 @@ public class GTaskManager {
mNidToGid.clear();
mSyncing = false;
}
// 初始化Google Task列表的方法
return mCancelled ? STATE_SYNC_CANCELLED : STATE_SUCCESS;
}
@ -173,21 +178,22 @@ public class GTaskManager {
return;
GTaskClient client = GTaskClient.getInstance();
try {
// 从Google获取任务列表的JSON数组
JSONArray jsTaskLists = client.getTaskLists();
// init meta list first
// 初始化元数据列表
mMetaList = null;
for (int i = 0; i < jsTaskLists.length(); i++) {
JSONObject object = jsTaskLists.getJSONObject(i);
String gid = object.getString(GTaskStringUtils.GTASK_JSON_ID);
String name = object.getString(GTaskStringUtils.GTASK_JSON_NAME);
// 查找元数据文件夹
if (name
.equals(GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_META)) {
mMetaList = new TaskList();
mMetaList.setContentByRemoteJSON(object);
// load meta data
// 加载元数据
JSONArray jsMetas = client.getTaskList(gid);
for (int j = 0; j < jsMetas.length(); j++) {
object = (JSONObject) jsMetas.getJSONObject(j);
@ -203,7 +209,7 @@ public class GTaskManager {
}
}
// create meta list if not existed
// 如果元数据列表不存在,则创建一个新的元数据列表
if (mMetaList == null) {
mMetaList = new TaskList();
mMetaList.setName(GTaskStringUtils.MIUI_FOLDER_PREFFIX
@ -211,12 +217,12 @@ public class GTaskManager {
GTaskClient.getInstance().createTaskList(mMetaList);
}
// init task list
// 初始化任务列表和任务
for (int i = 0; i < jsTaskLists.length(); i++) {
JSONObject object = jsTaskLists.getJSONObject(i);
String gid = object.getString(GTaskStringUtils.GTASK_JSON_ID);
String name = object.getString(GTaskStringUtils.GTASK_JSON_NAME);
// 处理以特定前缀开头且不是元数据文件夹的任务列表
if (name.startsWith(GTaskStringUtils.MIUI_FOLDER_PREFFIX)
&& !name.equals(GTaskStringUtils.MIUI_FOLDER_PREFFIX
+ GTaskStringUtils.FOLDER_META)) {
@ -225,7 +231,7 @@ public class GTaskManager {
mGTaskListHashMap.put(gid, tasklist);
mGTaskHashMap.put(gid, tasklist);
// load tasks
// 加载任务列表中的任务
JSONArray jsTasks = client.getTaskList(gid);
for (int j = 0; j < jsTasks.length(); j++) {
object = (JSONObject) jsTasks.getJSONObject(j);
@ -241,12 +247,13 @@ public class GTaskManager {
}
}
} catch (JSONException e) {
// 处理JSON解析异常记录日志、打印堆栈信息并抛出操作失败异常
Log.e(TAG, e.toString());
e.printStackTrace();
throw new ActionFailureException("initGTaskList: handing JSONObject failed");
}
}
// 执行内容同步的方法
private void syncContent() throws NetworkFailureException {
int syncType;
Cursor c = null;
@ -259,7 +266,7 @@ public class GTaskManager {
return;
}
// for local deleted note
// 处理本地已删除的笔记
try {
c = mContentResolver.query(Notes.CONTENT_NOTE_URI, SqlNote.PROJECTION_NOTE,
"(type<>? AND parent_id=?)", new String[] {
@ -286,10 +293,10 @@ public class GTaskManager {
}
}
// sync folder first
// 同步文件夹
syncFolder();
// for note existing in database
// 处理数据库中存在的笔记
try {
c = mContentResolver.query(Notes.CONTENT_NOTE_URI, SqlNote.PROJECTION_NOTE,
"(type=? AND parent_id<>?)", new String[] {
@ -306,10 +313,10 @@ public class GTaskManager {
syncType = node.getSyncAction(c);
} else {
if (c.getString(SqlNote.GTASK_ID_COLUMN).trim().length() == 0) {
// local add
// 本地新增
syncType = Node.SYNC_ACTION_ADD_REMOTE;
} else {
// remote delete
// 远程删除
syncType = Node.SYNC_ACTION_DEL_LOCAL;
}
}
@ -326,14 +333,14 @@ public class GTaskManager {
}
}
// go through remaining items
// 处理剩余的未同步节点
Iterator<Map.Entry<String, Node>> iter = mGTaskHashMap.entrySet().iterator();
while (iter.hasNext()) {
Map.Entry<String, Node> entry = iter.next();
node = entry.getValue();
doContentSync(Node.SYNC_ACTION_ADD_LOCAL, node, null);
}
// 检查同步是否取消,如果未取消则执行本地删除操作和提交更新操作
// mCancelled can be set by another thread, so we neet to check one by
// one
// clear local delete table
@ -342,15 +349,14 @@ public class GTaskManager {
throw new ActionFailureException("failed to batch-delete local deleted notes");
}
}
// refresh local sync id
// 检查同步是否取消如果未取消则提交更新并刷新本地同步ID
if (!mCancelled) {
GTaskClient.getInstance().commitUpdate();
refreshLocalSyncId();
}
}
// 同步文件夹的方法
private void syncFolder() throws NetworkFailureException {
Cursor c = null;
String gid;
@ -361,7 +367,7 @@ public class GTaskManager {
return;
}
// for root folder
// 处理根文件夹
try {
c = mContentResolver.query(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI,
Notes.ID_ROOT_FOLDER), SqlNote.PROJECTION_NOTE, null, null, null);
@ -373,7 +379,7 @@ public class GTaskManager {
mGTaskHashMap.remove(gid);
mGidToNid.put(gid, (long) Notes.ID_ROOT_FOLDER);
mNidToGid.put((long) Notes.ID_ROOT_FOLDER, gid);
// for system folder, only update remote name if necessary
// 对于系统文件夹,仅在必要时更新远程名称
if (!node.getName().equals(
GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_DEFAULT))
doContentSync(Node.SYNC_ACTION_UPDATE_REMOTE, node, c);
@ -390,7 +396,7 @@ public class GTaskManager {
}
}
// for call-note folder
// 处理通话记录文件夹
try {
c = mContentResolver.query(Notes.CONTENT_NOTE_URI, SqlNote.PROJECTION_NOTE, "(_id=?)",
new String[] {
@ -404,8 +410,7 @@ public class GTaskManager {
mGTaskHashMap.remove(gid);
mGidToNid.put(gid, (long) Notes.ID_CALL_RECORD_FOLDER);
mNidToGid.put((long) Notes.ID_CALL_RECORD_FOLDER, gid);
// for system folder, only update remote name if
// necessary
// 对于系统文件夹,仅在必要时更新远程名称
if (!node.getName().equals(
GTaskStringUtils.MIUI_FOLDER_PREFFIX
+ GTaskStringUtils.FOLDER_CALL_NOTE))
@ -424,7 +429,7 @@ public class GTaskManager {
}
}
// for local existing folders
// 处理本地现有文件夹
try {
c = mContentResolver.query(Notes.CONTENT_NOTE_URI, SqlNote.PROJECTION_NOTE,
"(type=? AND parent_id<>?)", new String[] {
@ -441,10 +446,10 @@ public class GTaskManager {
syncType = node.getSyncAction(c);
} else {
if (c.getString(SqlNote.GTASK_ID_COLUMN).trim().length() == 0) {
// local add
// 本地新增文件夹
syncType = Node.SYNC_ACTION_ADD_REMOTE;
} else {
// remote delete
// 远程删除文件夹
syncType = Node.SYNC_ACTION_DEL_LOCAL;
}
}
@ -460,7 +465,7 @@ public class GTaskManager {
}
}
// for remote add folders
// 处理远程新增文件夹
Iterator<Map.Entry<String, TaskList>> iter = mGTaskListHashMap.entrySet().iterator();
while (iter.hasNext()) {
Map.Entry<String, TaskList> entry = iter.next();
@ -475,7 +480,7 @@ public class GTaskManager {
if (!mCancelled)
GTaskClient.getInstance().commitUpdate();
}
// 根据同步类型执行具体同步操作的方法
private void doContentSync(int syncType, Node node, Cursor c) throws NetworkFailureException {
if (mCancelled) {
return;
@ -484,12 +489,15 @@ public class GTaskManager {
MetaData meta;
switch (syncType) {
case Node.SYNC_ACTION_ADD_LOCAL:
// 本地新增节点操作
addLocalNode(node);
break;
case Node.SYNC_ACTION_ADD_REMOTE:
// 远程新增节点操作
addRemoteNode(node, c);
break;
case Node.SYNC_ACTION_DEL_LOCAL:
// 本地删除节点操作
meta = mMetaHashMap.get(c.getString(SqlNote.GTASK_ID_COLUMN));
if (meta != null) {
GTaskClient.getInstance().deleteNode(meta);
@ -497,6 +505,7 @@ public class GTaskManager {
mLocalDeleteIdMap.add(c.getLong(SqlNote.ID_COLUMN));
break;
case Node.SYNC_ACTION_DEL_REMOTE:
// 远程删除节点操作
meta = mMetaHashMap.get(node.getGid());
if (meta != null) {
GTaskClient.getInstance().deleteNode(meta);
@ -504,24 +513,28 @@ public class GTaskManager {
GTaskClient.getInstance().deleteNode(node);
break;
case Node.SYNC_ACTION_UPDATE_LOCAL:
// 本地更新节点操作
updateLocalNode(node, c);
break;
case Node.SYNC_ACTION_UPDATE_REMOTE:
// 远程更新节点操作
updateRemoteNode(node, c);
break;
case Node.SYNC_ACTION_UPDATE_CONFLICT:
// merging both modifications maybe a good idea
// right now just use local update simply
// 处理更新冲突,目前简单地使用本地更新
// 可能合并双方修改会是更好的做法,但目前仅做简单处理
updateRemoteNode(node, c);
break;
case Node.SYNC_ACTION_NONE:
// 无需同步操作
break;
case Node.SYNC_ACTION_ERROR:
default:
// 未知同步操作类型,抛出异常
throw new ActionFailureException("unkown sync action type");
}
}
// 本地新增节点的具体实现方法
private void addLocalNode(Node node) throws NetworkFailureException {
if (mCancelled) {
return;
@ -549,7 +562,7 @@ public class GTaskManager {
if (note.has(NoteColumns.ID)) {
long id = note.getLong(NoteColumns.ID);
if (DataUtils.existInNoteDatabase(mContentResolver, id)) {
// the id is not available, have to create a new one
// 如果本地数据库中已存在该笔记ID则移除该ID重新生成新的笔记
note.remove(NoteColumns.ID);
}
}
@ -562,8 +575,7 @@ public class GTaskManager {
if (data.has(DataColumns.ID)) {
long dataId = data.getLong(DataColumns.ID);
if (DataUtils.existInDataDatabase(mContentResolver, dataId)) {
// the data id is not available, have to create
// a new one
// 如果本地数据库中已存在该数据ID则移除该ID重新生成新的数据
data.remove(DataColumns.ID);
}
}
@ -584,25 +596,25 @@ public class GTaskManager {
sqlNote.setParentId(parentId.longValue());
}
// create the local node
// 创建本地节点
sqlNote.setGtaskId(node.getGid());
sqlNote.commit(false);
// update gid-nid mapping
// 更新gid - nid映射
mGidToNid.put(node.getGid(), sqlNote.getId());
mNidToGid.put(sqlNote.getId(), node.getGid());
// update meta
// 更新远程元数据
updateRemoteMeta(node.getGid(), sqlNote);
}
// 本地更新节点的具体实现方法
private void updateLocalNode(Node node, Cursor c) throws NetworkFailureException {
if (mCancelled) {
return;
}
SqlNote sqlNote;
// update the note locally
// 更新本地笔记
sqlNote = new SqlNote(mContext, c);
sqlNote.setContent(node.getLocalJSONFromContent());
@ -615,10 +627,10 @@ public class GTaskManager {
sqlNote.setParentId(parentId.longValue());
sqlNote.commit(true);
// update meta info
// 更新远程元数据
updateRemoteMeta(node.getGid(), sqlNote);
}
// 远程新增节点的具体实现方法
private void addRemoteNode(Node node, Cursor c) throws NetworkFailureException {
if (mCancelled) {
return;
@ -627,7 +639,7 @@ public class GTaskManager {
SqlNote sqlNote = new SqlNote(mContext, c);
Node n;
// update remotely
// 远程更新操作
if (sqlNote.isNoteType()) {
Task task = new Task();
task.setContentByLocalJSON(sqlNote.getContent());
@ -642,12 +654,12 @@ public class GTaskManager {
GTaskClient.getInstance().createTask(task);
n = (Node) task;
// add meta
// 添加元数据
updateRemoteMeta(task.getGid(), sqlNote);
} else {
TaskList tasklist = null;
// we need to skip folder if it has already existed
// 检查文件夹是否已存在如果存在则获取对应的TaskList对象
String folderName = GTaskStringUtils.MIUI_FOLDER_PREFFIX;
if (sqlNote.getId() == Notes.ID_ROOT_FOLDER)
folderName += GTaskStringUtils.FOLDER_DEFAULT;
@ -671,7 +683,7 @@ public class GTaskManager {
}
}
// no match we can add now
// 如果未找到匹配的文件夹则创建新的TaskList对象
if (tasklist == null) {
tasklist = new TaskList();
tasklist.setContentByLocalJSON(sqlNote.getContent());
@ -681,17 +693,17 @@ public class GTaskManager {
n = (Node) tasklist;
}
// update local note
// 更新本地笔记
sqlNote.setGtaskId(n.getGid());
sqlNote.commit(false);
sqlNote.resetLocalModified();
sqlNote.commit(true);
// gid-id mapping
// 更新gid - id映射
mGidToNid.put(n.getGid(), sqlNote.getId());
mNidToGid.put(sqlNote.getId(), n.getGid());
}
// 远程更新节点的具体实现方法
private void updateRemoteNode(Node node, Cursor c) throws NetworkFailureException {
if (mCancelled) {
return;
@ -699,11 +711,11 @@ public class GTaskManager {
SqlNote sqlNote = new SqlNote(mContext, c);
// update remotely
// 远程更新节点内容
node.setContentByLocalJSON(sqlNote.getContent());
GTaskClient.getInstance().addUpdateNode(node);
// update meta
// 更新远程元数据
updateRemoteMeta(node.getGid(), sqlNote);
// move task if necessary
@ -725,11 +737,11 @@ public class GTaskManager {
}
}
// clear local modified flag
// 清除本地修改标志
sqlNote.resetLocalModified();
sqlNote.commit(true);
}
// 更新远程元数据的方法
private void updateRemoteMeta(String gid, SqlNote sqlNote) throws NetworkFailureException {
if (sqlNote != null && sqlNote.isNoteType()) {
MetaData metaData = mMetaHashMap.get(gid);
@ -745,13 +757,13 @@ public class GTaskManager {
}
}
}
// 刷新本地同步ID的方法
private void refreshLocalSyncId() throws NetworkFailureException {
if (mCancelled) {
return;
}
// get the latest gtask list
// 重新获取最新的Google Task列表清除之前的数据缓存
mGTaskHashMap.clear();
mGTaskListHashMap.clear();
mMetaHashMap.clear();
@ -789,11 +801,11 @@ public class GTaskManager {
}
}
}
// 获取同步账户名称的方法
public String getSyncAccount() {
return GTaskClient.getInstance().getSyncAccount().name;
}
// 取消同步操作的方法
public void cancelSync() {
mCancelled = true;
}

@ -22,70 +22,89 @@ import android.content.Context;
import android.content.Intent;
import android.os.Bundle;
import android.os.IBinder;
// GTaskSyncService类是一个Android服务用于管理Google Task的同步任务
public class GTaskSyncService extends Service {
// 定义用于表示同步操作类型的字符串常量
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";
// 存储当前正在执行的同步任务实例初始化为null
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() {
// 将当前同步任务实例设置为null表示任务已完成
mSyncTask = null;
// 发送一个空消息的广播
sendBroadcast("");
// 停止当前服务
stopSelf();
}
});
// 发送一个空消息的广播,可能用于通知相关组件同步任务即将开始
sendBroadcast("");
// 执行同步任务
mSyncTask.execute();
}
}
// 取消同步任务的方法
private void cancelSync() {
// 如果当前有正在执行的同步任务
if (mSyncTask != null) {
// 调用同步任务的取消同步方法
mSyncTask.cancelSync();
}
}
// 服务创建时调用的方法将同步任务实例设置为null
@Override
public void onCreate() {
mSyncTask = null;
}
// 服务接收到启动命令时调用的方法
@Override
public int onStartCommand(Intent intent, int flags, int startId) {
// 获取启动意图中的额外数据
Bundle bundle = intent.getExtras();
// 如果额外数据不为空且包含同步操作类型键
if (bundle != null && bundle.containsKey(ACTION_STRING_NAME)) {
// 根据操作类型值执行相应操作
switch (bundle.getInt(ACTION_STRING_NAME, ACTION_INVALID)) {
case ACTION_START_SYNC:
// 启动同步任务
startSync();
break;
case ACTION_CANCEL_SYNC:
// 取消同步任务
cancelSync();
break;
default:
break;
}
// 返回粘性服务标志,表示服务在被异常终止后会尝试重新启动
return START_STICKY;
}
// 如果不满足上述条件则调用父类的onStartCommand方法
return super.onStartCommand(intent, flags, startId);
}
// 系统内存不足时调用的方法,如果有正在执行的同步任务则取消它
@Override
public void onLowMemory() {
if (mSyncTask != null) {
@ -93,35 +112,47 @@ public class GTaskSyncService extends Service {
}
}
// 服务绑定方法返回null表示不支持绑定操作
public IBinder onBind(Intent intent) {
return null;
}
// 发送广播的方法,用于向感兴趣的组件发送同步服务的相关信息
public void sendBroadcast(String msg) {
// 更新同步进度消息
mSyncProgress = msg;
// 创建一个意图,指定广播动作名称
Intent intent = new Intent(GTASK_SERVICE_BROADCAST_NAME);
// 将是否正在同步的状态添加到意图的额外数据中
intent.putExtra(GTASK_SERVICE_BROADCAST_IS_SYNCING, mSyncTask != null);
// 将同步进度消息添加到意图的额外数据中
intent.putExtra(GTASK_SERVICE_BROADCAST_PROGRESS_MSG, msg);
// 发送广播
sendBroadcast(intent);
}
// 静态方法用于启动同步任务在Activity中调用
public static void startSync(Activity activity) {
// 设置同步任务的Activity上下文
GTaskManager.getInstance().setActivityContext(activity);
// 创建一个启动当前服务的意图,并指定操作类型为开始同步
Intent intent = new Intent(activity, GTaskSyncService.class);
intent.putExtra(GTaskSyncService.ACTION_STRING_NAME, GTaskSyncService.ACTION_START_SYNC);
// 启动服务
activity.startService(intent);
}
// 静态方法用于取消同步任务在Context中调用
public static void cancelSync(Context context) {
// 创建一个启动当前服务的意图,并指定操作类型为取消同步
Intent intent = new Intent(context, GTaskSyncService.class);
intent.putExtra(GTaskSyncService.ACTION_STRING_NAME, GTaskSyncService.ACTION_CANCEL_SYNC);
// 启动服务
context.startService(intent);
}
// 静态方法,用于检查是否正在进行同步任务
public static boolean isSyncing() {
return mSyncTask != null;
}
// 静态方法,用于获取同步进度消息
public static String getProgressString() {
return mSyncProgress;
}

Loading…
Cancel
Save