diff --git a/src/Notes-master/data/Contact.java b/src/Notes-master/data/Contact.java new file mode 100644 index 0000000..149cd8d --- /dev/null +++ b/src/Notes-master/data/Contact.java @@ -0,0 +1,83 @@ +// 版权声明和许可信息,表明该代码由 "The MiCode Open Source Community" 提供,并且使用了Apache License 2.0。 +/* + * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net) + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * ... + */ + +package net.micode.notes.data; // 指定包名 + +// 导入所需的类 +import android.content.Context; +import android.database.Cursor; +import android.provider.ContactsContract.CommonDataKinds.Phone; +import android.provider.ContactsContract.Data; +import android.telephony.PhoneNumberUtils; +import android.util.Log; + +import java.util.HashMap; // 导入HashMap类,用于创建缓存 + +// 定义了Contact类,用于从系统联系人获取信息 +public class Contact { + // 类级别的缓存变量,存储电话号码和对应的联系人名称 + private static HashMap sContactCache; + // 用于日志输出的标签 + private static final String TAG = "Contact"; + + // 编写SQL查询语句的一部分,用于查询电话号码 + private static final String CALLER_ID_SELECTION = "PHONE_NUMBERS_EQUAL(" + Phone.NUMBER + + ",?) AND " + Data.MIMETYPE + "='" + Phone.CONTENT_ITEM_TYPE + "'" + + " AND " + Data.RAW_CONTACT_ID + " IN " + + "(SELECT raw_contact_id " + + " FROM phone_lookup" + + " WHERE min_match = '+')"; + + // 获取联系人名称的静态方法 + public static String getContact(Context context, String phoneNumber) { + // 如果缓存为空,则初始化它 + if(sContactCache == null) { + sContactCache = new HashMap(); + } + + // 检查缓存是否已有该号码的联系人名称 + if(sContactCache.containsKey(phoneNumber)) { + // 如果有,直接返回该名称 + return sContactCache.get(phoneNumber); + } + + // 替换查询中的占位符以构造完整的查询语句 + String selection = CALLER_ID_SELECTION.replace("+", + PhoneNumberUtils.toCallerIDMinMatch(phoneNumber)); + // 对联系人数据提供者进行查询,尝试获取匹配电话号码的联系人名称 + Cursor cursor = context.getContentResolver().query( + Data.CONTENT_URI, + new String [] { Phone.DISPLAY_NAME }, + selection, + new String[] { phoneNumber }, + null); + + // 如果查询返回了结果 + if (cursor != null && cursor.moveToFirst()) { + try { + // 从游标中获取联系人名称 + String name = cursor.getString(0); + // 将结果存放到缓存中 + sContactCache.put(phoneNumber, name); + // 返回获取到的联系人名称 + return name; + } catch (IndexOutOfBoundsException e) { + // 如果发生异常,输出错误日志 + Log.e(TAG, " Cursor get string error " + e.toString()); + return null; + } finally { + // 最后确保游标被关闭,避免内存泄露 + cursor.close(); + } + } else { + // 如果没有匹配结果,输出调试日志 + Log.d(TAG, "No contact matched with number:" + phoneNumber); + return null; + } + } +} \ No newline at end of file diff --git a/src/Notes-master/data/Notes.java b/src/Notes-master/data/Notes.java new file mode 100644 index 0000000..f651677 --- /dev/null +++ b/src/Notes-master/data/Notes.java @@ -0,0 +1,291 @@ +/* + * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net) + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package net.micode.notes.data; + +import android.net.Uri; + +/** + * 笔记相关的常量和数据字段 + */ +// 定义一个名为Notes的公共类 +public class Notes { + // 定义一些静态常量,如授权信息、标签和类型 + // 内容提供者的权限 + public static final String AUTHORITY = "micode_notes"; + + // 日志标签 + public static final String TAG = "Notes"; + + // 笔记类型常量 + public static final int TYPE_NOTE = 0; // 普通笔记 + public static final int TYPE_FOLDER = 1; // 文件夹 + public static final int TYPE_SYSTEM = 2; // 系统类型 + + // 系统文件夹的标识符 + public static final int ID_ROOT_FOLDER = 0; // 默认文件夹 + public static final int ID_TEMPARAY_FOLDER = -1; // 临时文件夹,存放无文件夹归属的笔记 + public static final int ID_CALL_RECORD_FOLDER = -2; // 存放通话记录的文件夹 + public static final int ID_TRASH_FOLER = -3; // 垃圾箱文件夹 + + // 传递给Intent的额外数据的键 + public static final String INTENT_EXTRA_ALERT_DATE = "net.micode.notes.alert_date"; // 提醒日期 + public static final String INTENT_EXTRA_BACKGROUND_ID = "net.micode.notes.background_color_id"; // 背景颜色ID + public static final String INTENT_EXTRA_WIDGET_ID = "net.micode.notes.widget_id"; // Widget的ID + public static final String INTENT_EXTRA_WIDGET_TYPE = "net.micode.notes.widget_type"; // Widget类型 + public static final String INTENT_EXTRA_FOLDER_ID = "net.micode.notes.folder_id"; // 文件夹ID + public static final String INTENT_EXTRA_CALL_DATE = "net.micode.notes.call_date"; // 通话日期 + + // Widget类型常量 + public static final int TYPE_WIDGET_INVALIDE = -1; // 无效的Widget类型 + public static final int TYPE_WIDGET_2X = 0; // 2x大小的Widget + public static final int TYPE_WIDGET_4X = 1; // 4x大小的Widget + + // 笔记数据常量类 + public static class DataConstants { + public static final String NOTE = TextNote.CONTENT_ITEM_TYPE; // 文本笔记的内容类型 + public static final String CALL_NOTE = CallNote.CONTENT_ITEM_TYPE; // 通话记录的内容类型 + } + + + /** + * 用于查询所有笔记和文件夹的 Uri + */ + public static final Uri CONTENT_NOTE_URI = Uri.parse("content://" + AUTHORITY + "/note"); + + /** + * 用于查询数据的 Uri + */ + public static final Uri CONTENT_DATA_URI = Uri.parse("content://" + AUTHORITY + "/data"); + + public interface NoteColumns { + /** + * 行的唯一标识符 + *

类型: 整数 (长整型)

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

类型: 整数 (长整型)

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

类型: 整数 (长整型)

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

类型: 整数 (长整型)

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

类型: 整数 (长整型)

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

类型: 文本

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

类型: 整数 (长整型)

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

类型: 整数 (长整型)

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

类型: 整数 (长整型)

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

类型: 整数

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

类型: 整数 (长整型)

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

类型: 整数

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

类型: 整数 (长整型)

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

类型: 整数

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

类型: 整数

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

类型: 文本

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

类型: 整数 (长整型)

+ */ + public static final String VERSION = "version"; + } + + /** + * 用于定义数据表的列名称和相关常量 + */ + public interface DataColumns { + /** + * 行的唯一标识符 + *

类型: 整数 (长整型)

+ */ + public static final String ID = "_id"; + + /** + * 项目表示的 MIME 类型 + *

类型: 文本

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

类型: 整数 (长整型)

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

类型: 整数 (长整型)

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

类型: 整数 (长整型)

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

类型: 文本

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

类型: 整数

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

类型: 整数

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

类型: 文本

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

类型: 文本

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

类型: 文本

+ */ + public static final String DATA5 = "data5"; + } + + /** + * 文本笔记类,实现了 DataColumns 接口 + */ + public static final class TextNote implements DataColumns { + /** + * 指示文本是否处于待办事项模式的模式 + *

类型: 整数 1:待办事项模式 0: 普通模式

+ */ + public static final String MODE = DATA1; + + public static final int MODE_CHECK_LIST = 1; + + public static final String CONTENT_TYPE = "vnd.android.cursor.dir/text_note"; + + public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/text_note"; + + public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/text_note"); + } + + /** + * 通话笔记类,实现了 DataColumns 接口 + */ + public static final class CallNote implements DataColumns { + /** + * 通话记录的日期 + *

类型: 整数 (长整型)

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

类型: 文本

+ */ + public static final String PHONE_NUMBER = DATA3; + + public static final String CONTENT_TYPE = "vnd.android.cursor.dir/call_note"; + + public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/call_note"; + + public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/call_note"); + } +} \ No newline at end of file diff --git a/src/Notes-master/data/NotesDatabaseHelper.java b/src/Notes-master/data/NotesDatabaseHelper.java new file mode 100644 index 0000000..10a7200 --- /dev/null +++ b/src/Notes-master/data/NotesDatabaseHelper.java @@ -0,0 +1,426 @@ +/* + * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net) + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +/** + * 用于处理小米便签应用的数据库操作的帮助类 + */ +package net.micode.notes.data; + +import android.content.ContentValues; +import android.content.Context; +import android.database.sqlite.SQLiteDatabase; +import android.database.sqlite.SQLiteOpenHelper; +import android.util.Log; + +import net.micode.notes.data.Notes.DataColumns; +import net.micode.notes.data.Notes.DataConstants; +import net.micode.notes.data.Notes.NoteColumns; + +/** + * 数据库帮助类,用于管理小米便签应用中的数据库 + */ +public class NotesDatabaseHelper extends SQLiteOpenHelper { + + /** + * 数据库的名称 + */ + private static final String DB_NAME = "note.db"; + + /** + * 数据库的版本号 + */ + private static final int DB_VERSION = 4; + + /** + * 内部接口,用于定义数据库中的表名 + */ + public interface TABLE { + /** + * 笔记表 + */ + public static final String NOTE = "note"; + + /** + * 数据表 + */ + public static final String DATA = "data"; + } + + // 声明数据库帮助类的标签 + private static final String TAG = "NotesDatabaseHelper"; + + // 单例模式实例 + private static NotesDatabaseHelper mInstance; + + // 创建笔记表的 SQL 语句 + private static final String CREATE_NOTE_TABLE_SQL = + "CREATE TABLE " + TABLE.NOTE + "(" + + NoteColumns.ID + " INTEGER PRIMARY KEY," + + NoteColumns.PARENT_ID + " INTEGER NOT NULL DEFAULT 0," + + NoteColumns.ALERTED_DATE + " INTEGER NOT NULL DEFAULT 0," + + NoteColumns.BG_COLOR_ID + " INTEGER NOT NULL DEFAULT 0," + + NoteColumns.CREATED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," + + NoteColumns.HAS_ATTACHMENT + " INTEGER NOT NULL DEFAULT 0," + + NoteColumns.MODIFIED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," + + NoteColumns.NOTES_COUNT + " INTEGER NOT NULL DEFAULT 0," + + NoteColumns.SNIPPET + " TEXT NOT NULL DEFAULT ''," + + NoteColumns.TYPE + " INTEGER NOT NULL DEFAULT 0," + + NoteColumns.WIDGET_ID + " INTEGER NOT NULL DEFAULT 0," + + NoteColumns.WIDGET_TYPE + " INTEGER NOT NULL DEFAULT -1," + + NoteColumns.SYNC_ID + " INTEGER NOT NULL DEFAULT 0," + + NoteColumns.LOCAL_MODIFIED + " INTEGER NOT NULL DEFAULT 0," + + NoteColumns.ORIGIN_PARENT_ID + " INTEGER NOT NULL DEFAULT 0," + + NoteColumns.GTASK_ID + " TEXT NOT NULL DEFAULT ''," + + NoteColumns.VERSION + " INTEGER NOT NULL DEFAULT 0" + + ")"; + + // 创建数据表的 SQL 语句 + private static final String CREATE_DATA_TABLE_SQL = + "CREATE TABLE " + TABLE.DATA + "(" + + DataColumns.ID + " INTEGER PRIMARY KEY," + + DataColumns.MIME_TYPE + " TEXT NOT NULL," + + DataColumns.NOTE_ID + " INTEGER NOT NULL DEFAULT 0," + + NoteColumns.CREATED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," + + NoteColumns.MODIFIED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," + + DataColumns.CONTENT + " TEXT NOT NULL DEFAULT ''," + + DataColumns.DATA1 + " INTEGER," + + DataColumns.DATA2 + " INTEGER," + + DataColumns.DATA3 + " TEXT NOT NULL DEFAULT ''," + + DataColumns.DATA4 + " TEXT NOT NULL DEFAULT ''," + + DataColumns.DATA5 + " TEXT NOT NULL DEFAULT ''" + + ")"; + + // 创建数据表中的笔记 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 + ");"; + + // 当将笔记移动到文件夹时,增加文件夹的笔记计数 + private static final String NOTE_INCREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER = + "CREATE TRIGGER increase_folder_count_on_update " + + " AFTER UPDATE OF " + NoteColumns.PARENT_ID + " ON " + TABLE.NOTE + + " BEGIN " + + " UPDATE " + TABLE.NOTE + + " SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + " + 1" + + " WHERE " + NoteColumns.ID + "=new." + NoteColumns.PARENT_ID + ";" + + " END"; + + // 当从文件夹中移除笔记时,减少文件夹的笔记计数 + private static final String NOTE_DECREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER = + "CREATE TRIGGER decrease_folder_count_on_update " + + " AFTER UPDATE OF " + NoteColumns.PARENT_ID + " ON " + TABLE.NOTE + + " BEGIN " + + " UPDATE " + TABLE.NOTE + + " SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + "-1" + + " WHERE " + NoteColumns.ID + "=old." + NoteColumns.PARENT_ID + + " AND " + NoteColumns.NOTES_COUNT + ">0" + ";" + + " END"; + + // 当向文件夹中插入新笔记时,增加文件夹的笔记计数 + private static final String NOTE_INCREASE_FOLDER_COUNT_ON_INSERT_TRIGGER = + "CREATE TRIGGER increase_folder_count_on_insert " + + " AFTER INSERT ON " + TABLE.NOTE + + " BEGIN " + + " UPDATE " + TABLE.NOTE + + " SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + " + 1" + + " WHERE " + NoteColumns.ID + "=new." + NoteColumns.PARENT_ID + ";" + + " END"; + /** + * 在删除文件夹中的笔记时减少笔记计数 + */ + private static final String NOTE_DECREASE_FOLDER_COUNT_ON_DELETE_TRIGGER = + "CREATE TRIGGER decrease_folder_count_on_delete " + + " AFTER DELETE ON " + TABLE.NOTE + + " BEGIN " + + " UPDATE " + TABLE.NOTE + + " SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + "-1" + + " WHERE " + NoteColumns.ID + "=old." + NoteColumns.PARENT_ID + + " AND " + NoteColumns.NOTES_COUNT + ">0;" + + " END"; + + /** + * 在使用类型为{@link DataConstants#NOTE}的数据插入时更新笔记内容 + */ + private static final String DATA_UPDATE_NOTE_CONTENT_ON_INSERT_TRIGGER = + "CREATE TRIGGER update_note_content_on_insert " + + " AFTER INSERT ON " + TABLE.DATA + + " WHEN new." + DataColumns.MIME_TYPE + "='" + DataConstants.NOTE + "'" + + " BEGIN" + + " UPDATE " + TABLE.NOTE + + " SET " + NoteColumns.SNIPPET + "=new." + DataColumns.CONTENT + + " WHERE " + NoteColumns.ID + "=new." + DataColumns.NOTE_ID + ";" + + " END"; + + /** + * 在使用类型为{@link DataConstants#NOTE}的数据更改时更新笔记内容 + */ + private static final String DATA_UPDATE_NOTE_CONTENT_ON_UPDATE_TRIGGER = + "CREATE TRIGGER update_note_content_on_update " + + " AFTER UPDATE ON " + TABLE.DATA + + " WHEN old." + DataColumns.MIME_TYPE + "='" + DataConstants.NOTE + "'" + + " BEGIN" + + " UPDATE " + TABLE.NOTE + + " SET " + NoteColumns.SNIPPET + "=new." + DataColumns.CONTENT + + " WHERE " + NoteColumns.ID + "=new." + DataColumns.NOTE_ID + ";" + + " END"; + + /** + * 在删除类型为{@link DataConstants#NOTE}的数据时更新笔记内容 + */ + private static final String DATA_UPDATE_NOTE_CONTENT_ON_DELETE_TRIGGER = + "CREATE TRIGGER update_note_content_on_delete " + + " AFTER delete ON " + TABLE.DATA + + " WHEN old." + DataColumns.MIME_TYPE + "='" + DataConstants.NOTE + "'" + + " BEGIN" + + " UPDATE " + TABLE.NOTE + + " SET " + NoteColumns.SNIPPET + "=''" + + " WHERE " + NoteColumns.ID + "=old." + DataColumns.NOTE_ID + ";" + + " END"; + + /** + * 删除属于已删除笔记的数据 + */ + private static final String NOTE_DELETE_DATA_ON_DELETE_TRIGGER = + "CREATE TRIGGER delete_data_on_delete " + + " AFTER DELETE ON " + TABLE.NOTE + + " BEGIN" + + " DELETE FROM " + TABLE.DATA + + " WHERE " + DataColumns.NOTE_ID + "=old." + NoteColumns.ID + ";" + + " END"; + + /** + * 删除属于已删除文件夹的笔记 + */ + private static final String FOLDER_DELETE_NOTES_ON_DELETE_TRIGGER = + "CREATE TRIGGER folder_delete_notes_on_delete " + + " AFTER DELETE ON " + TABLE.NOTE + + " BEGIN" + + " DELETE FROM " + TABLE.NOTE + + " WHERE " + NoteColumns.PARENT_ID + "=old." + NoteColumns.ID + ";" + + " END"; + + /** + * 将属于已移至垃圾箱文件夹的笔记移动 + */ + private static final String FOLDER_MOVE_NOTES_ON_TRASH_TRIGGER = + "CREATE TRIGGER folder_move_notes_on_trash " + + " AFTER UPDATE ON " + TABLE.NOTE + + " WHEN new." + NoteColumns.PARENT_ID + "=" + Notes.ID_TRASH_FOLER + + " BEGIN" + + " UPDATE " + TABLE.NOTE + + " SET " + NoteColumns.PARENT_ID + "=" + Notes.ID_TRASH_FOLER + + " WHERE " + NoteColumns.PARENT_ID + "=old." + NoteColumns.ID + ";" + + " END"; + + public NotesDatabaseHelper(Context context) { + super(context, DB_NAME, null, DB_VERSION); + } + + public void createNoteTable(SQLiteDatabase db) { + db.execSQL(CREATE_NOTE_TABLE_SQL); + reCreateNoteTableTriggers(db); + createSystemFolder(db); + Log.d(TAG, "note table has been created"); + } + + /** + * 重新创建笔记表相关的触发器 + * + * @param db SQLiteDatabase 实例 + */ + private void reCreateNoteTableTriggers(SQLiteDatabase db) { + // 删除旧的触发器 + db.execSQL("DROP TRIGGER IF EXISTS increase_folder_count_on_update"); + db.execSQL("DROP TRIGGER IF EXISTS decrease_folder_count_on_update"); + db.execSQL("DROP TRIGGER IF EXISTS decrease_folder_count_on_delete"); + db.execSQL("DROP TRIGGER IF EXISTS delete_data_on_delete"); + db.execSQL("DROP TRIGGER IF EXISTS increase_folder_count_on_insert"); + db.execSQL("DROP TRIGGER IF EXISTS folder_delete_notes_on_delete"); + db.execSQL("DROP TRIGGER IF EXISTS folder_move_notes_on_trash"); + + // 创建新的触发器 + db.execSQL(NOTE_INCREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER); + db.execSQL(NOTE_DECREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER); + db.execSQL(NOTE_DECREASE_FOLDER_COUNT_ON_DELETE_TRIGGER); + db.execSQL(NOTE_DELETE_DATA_ON_DELETE_TRIGGER); + db.execSQL(NOTE_INCREASE_FOLDER_COUNT_ON_INSERT_TRIGGER); + db.execSQL(FOLDER_DELETE_NOTES_ON_DELETE_TRIGGER); + db.execSQL(FOLDER_MOVE_NOTES_ON_TRASH_TRIGGER); + } + + /** + * 创建系统文件夹,包括通话记录文件夹、根文件夹、临时文件夹和垃圾箱文件夹 + * + * @param db SQLiteDatabase 实例 + */ + private void createSystemFolder(SQLiteDatabase db) { + ContentValues values = new ContentValues(); + + // 创建通话记录文件夹 + values.put(NoteColumns.ID, Notes.ID_CALL_RECORD_FOLDER); + values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); + db.insert(TABLE.NOTE, null, values); + + // 创建根文件夹 + values.clear(); + values.put(NoteColumns.ID, Notes.ID_ROOT_FOLDER); + values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); + db.insert(TABLE.NOTE, null, values); + + // 创建临时文件夹 + values.clear(); + values.put(NoteColumns.ID, Notes.ID_TEMPARAY_FOLDER); + values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); + db.insert(TABLE.NOTE, null, values); + + // 创建垃圾箱文件夹 + values.clear(); + values.put(NoteColumns.ID, Notes.ID_TRASH_FOLER); + values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); + db.insert(TABLE.NOTE, null, values); + } + + /** + * 创建数据表,并重新创建数据表相关的触发器 + * + * @param db SQLiteDatabase 实例 + */ + 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"); + } + + /** + * 重新创建数据表相关的触发器 + * + * @param db SQLiteDatabase 实例 + */ + private void reCreateDataTableTriggers(SQLiteDatabase db) { + // 删除旧的触发器 + db.execSQL("DROP TRIGGER IF EXISTS update_note_content_on_insert"); + db.execSQL("DROP TRIGGER IF EXISTS update_note_content_on_update"); + db.execSQL("DROP TRIGGER IF EXISTS update_note_content_on_delete"); + + // 创建新的触发器 + db.execSQL(DATA_UPDATE_NOTE_CONTENT_ON_INSERT_TRIGGER); + db.execSQL(DATA_UPDATE_NOTE_CONTENT_ON_UPDATE_TRIGGER); + db.execSQL(DATA_UPDATE_NOTE_CONTENT_ON_DELETE_TRIGGER); + } + + /** + * 获取数据库帮助类的实例,采用单例模式 + * + * @param context 上下文环境 + * @return NotesDatabaseHelper 实例 + */ + static synchronized NotesDatabaseHelper getInstance(Context context) { + if (mInstance == null) { + mInstance = new NotesDatabaseHelper(context); + } + return mInstance; + } + + @Override + public void onCreate(SQLiteDatabase db) { + // 创建笔记表和数据表 + createNoteTable(db); + createDataTable(db); + } + + @Override + /** + * 执行数据库升级操作。 + * + * @param db 数据库对象 + * @param oldVersion 旧版本号 + * @param newVersion 新版本号 + */ + public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) { + boolean reCreateTriggers = false; // 是否重新创建触发器 + boolean skipV2 = false; // 是否跳过 V2 版本 + + if (oldVersion == 1) { // 如果旧版本号为 1 + upgradeToV2(db); // 升级到 V2 版本 + // 跳过 V2 版本,直接升级到 V3 版本 + skipV2 = true; + oldVersion++; + } + + if (oldVersion == 2 && !skipV2) { // 如果旧版本号为 2 并且不跳过 V2 版本 + upgradeToV3(db); // 升级到 V3 版本 + reCreateTriggers = true; // 需要重新创建触发器 + oldVersion++; + } + + if (oldVersion == 3) { // 如果旧版本号为 3 + upgradeToV4(db); // 升级到 V4 版本 + oldVersion++; + } + + // 重新创建触发器 + if (reCreateTriggers) { + reCreateNoteTableTriggers(db); // 重新创建笔记表的触发器 + reCreateDataTableTriggers(db); // 重新创建数据表的触发器 + } + + // 版本不匹配,抛出异常 + if (oldVersion != newVersion) { + throw new IllegalStateException("Upgrade notes database to version " + newVersion + " fails"); + } + } + /** + * 数据库升级到v2版本的操作 + * + * @param db SQLiteDatabase 实例 + */ + 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); + } + + /** + * 升级数据库到 V3 版本。 + * + * @param db 数据库对象 + */ + private void upgradeToV3(SQLiteDatabase db) { + db.execSQL("DROP TRIGGER IF EXISTS update_note_modified_date_on_insert"); // 删除插入时更新修改日期的触发器 + db.execSQL("DROP TRIGGER IF EXISTS update_note_modified_date_on_delete"); // 删除删除时更新修改日期的触发器 + db.execSQL("DROP TRIGGER IF EXISTS update_note_modified_date_on_update"); // 删除更新时更新修改日期的触发器 + db.execSQL("ALTER TABLE " + TABLE.NOTE + " ADD COLUMN " + NoteColumns.GTASK_ID + " TEXT NOT NULL DEFAULT ''"); // 向 Note 表中添加 GTASK_ID 列 + ContentValues values = new ContentValues(); + values.put(NoteColumns.ID, Notes.ID_TRASH_FOLER); // 设置垃圾箱的 ID + values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); // 设置垃圾箱的类型为系统类型 + db.insert(TABLE.NOTE, null, values); // 向 Note 表中插入垃圾箱数据 + } + + /** + * 数据库升级到v4版本的操作 + * + * @param db SQLiteDatabase 实例 + */ + private void upgradeToV4(SQLiteDatabase db) { + // 增加一个版本号的字段 + db.execSQL("ALTER TABLE " + TABLE.NOTE + " ADD COLUMN " + NoteColumns.VERSION + " INTEGER NOT NULL DEFAULT 0"); + } +} \ No newline at end of file diff --git a/src/Notes-master/data/NotesProvider.java b/src/Notes-master/data/NotesProvider.java new file mode 100644 index 0000000..794755c --- /dev/null +++ b/src/Notes-master/data/NotesProvider.java @@ -0,0 +1,372 @@ +/* + * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net) + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package net.micode.notes.data; + + +import android.app.SearchManager; +import android.content.ContentProvider; +import android.content.ContentUris; +import android.content.ContentValues; +import android.content.Intent; +import android.content.UriMatcher; +import android.database.Cursor; +import android.database.sqlite.SQLiteDatabase; +import android.net.Uri; +import android.text.TextUtils; +import android.util.Log; + +import net.micode.notes.R; +import net.micode.notes.data.Notes.DataColumns; +import net.micode.notes.data.Notes.NoteColumns; +import net.micode.notes.data.NotesDatabaseHelper.TABLE; + + +public class NotesProvider extends ContentProvider { + /** + * 模块依赖注释 + * 该类对应的模块依赖了Notes和SearchManager模块 + */ + private static final UriMatcher mMatcher; + + /** + * 数据成员注释 + * 用于辅助对URI进行匹配,以便进行相应的操作 + */ + private NotesDatabaseHelper mHelper; + + /** + * 数据成员注释 + * 用于标识日志输出的tag + */ + private static final String TAG = "NotesProvider"; + + /** + * 接口注释 + * 定义了不同URI对应的编号,用于在匹配时进行标识 + */ + private static final int URI_NOTE = 1; + private static final int URI_NOTE_ITEM = 2; + private static final int URI_DATA = 3; + private static final int URI_DATA_ITEM = 4; + private static final int URI_SEARCH = 5; + private static final int URI_SEARCH_SUGGEST = 6; + + /** + * 实现注释 + * 初始化UriMatcher,并为不同的URI添加相应的匹配规则 + */ + static { + mMatcher = new UriMatcher(UriMatcher.NO_MATCH); + mMatcher.addURI(Notes.AUTHORITY, "note", URI_NOTE); + mMatcher.addURI(Notes.AUTHORITY, "note/#", URI_NOTE_ITEM); + mMatcher.addURI(Notes.AUTHORITY, "data", URI_DATA); + mMatcher.addURI(Notes.AUTHORITY, "data/#", URI_DATA_ITEM); + mMatcher.addURI(Notes.AUTHORITY, "search", URI_SEARCH); + mMatcher.addURI(Notes.AUTHORITY, SearchManager.SUGGEST_URI_PATH_QUERY, URI_SEARCH_SUGGEST); + mMatcher.addURI(Notes.AUTHORITY, SearchManager.SUGGEST_URI_PATH_QUERY + "/*", URI_SEARCH_SUGGEST); + } + + /** + * 实现注释 + * 定义了用于搜索结果的投影,包括需要显示的字段 + */ + private static final String NOTES_SEARCH_PROJECTION = NoteColumns.ID + "," + + NoteColumns.ID + " AS " + SearchManager.SUGGEST_COLUMN_INTENT_EXTRA_DATA + "," + + "TRIM(REPLACE(" + NoteColumns.SNIPPET + ", x'0A','')) AS " + SearchManager.SUGGEST_COLUMN_TEXT_1 + "," + + "TRIM(REPLACE(" + NoteColumns.SNIPPET + ", x'0A','')) AS " + SearchManager.SUGGEST_COLUMN_TEXT_2 + "," + + R.drawable.search_result + " AS " + SearchManager.SUGGEST_COLUMN_ICON_1 + "," + + "'" + Intent.ACTION_VIEW + "' AS " + SearchManager.SUGGEST_COLUMN_INTENT_ACTION + "," + + "'" + Notes.TextNote.CONTENT_TYPE + "' AS " + SearchManager.SUGGEST_COLUMN_INTENT_DATA; + + /** + * 实现注释 + * 查询的SQL语句,用于搜索匹配的笔记 + */ + private static String NOTES_SNIPPET_SEARCH_QUERY = "SELECT " + NOTES_SEARCH_PROJECTION + + " FROM " + TABLE.NOTE + + " WHERE " + NoteColumns.SNIPPET + " LIKE ?" + + " AND " + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER + + " AND " + NoteColumns.TYPE + "=" + Notes.TYPE_NOTE; + + /** + * 实现注释 + * 重写Provider的onCreate方法,初始化mHelper + */ + @Override + public boolean onCreate() { + mHelper = NotesDatabaseHelper.getInstance(getContext()); + return true; + } + + /** + * 执行查询操作,根据指定的条件在数据库中进行查询,并返回 Cursor 对象。 + * + * @param uri 查询的 URI + * @param projection 返回的列 + * @param selection 查询条件 + * @param selectionArgs 查询条件的参数 + * @param sortOrder 排序方式 + * @return 查询结果的 Cursor 对象 + */ + @Override + public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs, + String sortOrder) { + Cursor c = null; // 查询结果的 Cursor 对象 + SQLiteDatabase db = mHelper.getReadableDatabase(); // 获取可读的数据库对象 + String id = null; // ID 变量 + + switch (mMatcher.match(uri)) { + case URI_NOTE: + c = db.query(TABLE.NOTE, projection, selection, selectionArgs, null, null, sortOrder); + break; + case URI_NOTE_ITEM: + id = uri.getPathSegments().get(1); // 获取 URI 中的 ID + c = db.query(TABLE.NOTE, projection, NoteColumns.ID + "=" + id + + parseSelection(selection), selectionArgs, null, null, sortOrder); + break; + case URI_DATA: + c = db.query(TABLE.DATA, projection, selection, selectionArgs, null, null, sortOrder); + break; + case URI_DATA_ITEM: + id = uri.getPathSegments().get(1); // 获取 URI 中的 ID + c = db.query(TABLE.DATA, projection, DataColumns.ID + "=" + id + + parseSelection(selection), selectionArgs, null, null, sortOrder); + break; + case URI_SEARCH: + case URI_SEARCH_SUGGEST: + // 检查是否指定了排序方式、返回的列,如果指定了则抛出异常 + if (sortOrder != null || projection != null) { + throw new IllegalArgumentException( + "do not specify sortOrder, selection, selectionArgs, or projection" + "with this query"); + } + + String searchString = null; // 搜索字符串 + + if (mMatcher.match(uri) == URI_SEARCH_SUGGEST) { + if (uri.getPathSegments().size() > 1) { // 如果 URI 包含多个 segment + searchString = uri.getPathSegments().get(1); // 获取第二个 segment + } + } else { + searchString = uri.getQueryParameter("pattern"); // 获取 pattern 参数 + } + + if (TextUtils.isEmpty(searchString)) { // 如果搜索字符串为空,则返回空 + return null; + } + + try { + searchString = String.format("%%%s%%", searchString); // 格式化搜索字符串 + c = db.rawQuery(NOTES_SNIPPET_SEARCH_QUERY, + new String[] { searchString }); // 执行原始查询操作 + } catch (IllegalStateException ex) { + Log.e(TAG, "got exception: " + ex.toString()); // 捕获异常并记录日志 + } + break; + default: + throw new IllegalArgumentException("Unknown URI " + uri); // 未知的 URI,抛出异常 + } + + if (c != null) { + c.setNotificationUri(getContext().getContentResolver(), uri); // 设置查询结果的通知 URI + } + return c; // 返回查询结果的 Cursor 对象 + } + + /** + * 执行插入操作,向数据库中插入数据,并返回插入的记录的URI。 + * + * @param uri 插入的 URI + * @param values 需要插入的数据 + * @return 插入记录的 URI + */ + @Override + public Uri insert(Uri uri, ContentValues values) { + SQLiteDatabase db = mHelper.getWritableDatabase(); // 获取可写数据库引用 + long dataId = 0, noteId = 0, insertedId = 0; // 数据ID和笔记ID的初始化 + + switch (mMatcher.match(uri)) { // 根据URI匹配进行不同操作 + case URI_NOTE: // 笔记URI + insertedId = noteId = db.insert(TABLE.NOTE, null, values); // 向笔记表中插入数据并获取插入的ID + break; + case URI_DATA: // 数据URI + if (values.containsKey(DataColumns.NOTE_ID)) { + noteId = values.getAsLong(DataColumns.NOTE_ID); // 获取数据对应的笔记ID + } else { + Log.d(TAG, "Wrong data format without note id:" + values.toString()); // 记录错误日志 + } + insertedId = dataId = db.insert(TABLE.DATA, null, values); // 向数据表中插入数据并获取插入的ID + break; + default: + throw new IllegalArgumentException("Unknown URI " + uri); // 抛出未知URI异常 + } + + // 通知笔记URI发生了变化 + if (noteId > 0) { + getContext().getContentResolver().notifyChange( + ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId), null); + } + + // 通知数据URI发生了变化 + if (dataId > 0) { + getContext().getContentResolver().notifyChange( + ContentUris.withAppendedId(Notes.CONTENT_DATA_URI, dataId), null); + } + + return ContentUris.withAppendedId(uri, insertedId); // 返回插入的URI + } + + + /** + * 执行删除操作,根据指定的条件在数据库中进行删除,并返回受影响的行数。 + * + * @param uri 删除的 URI + * @param selection 删除条件 + * @param selectionArgs 删除条件的参数 + * @return 删除受影响的行数 + */ + @Override + public int delete(Uri uri, String selection, String[] selectionArgs) { + int count = 0; // 记录删除的行数 + String id = null; // ID字符串 + SQLiteDatabase db = mHelper.getWritableDatabase(); // 获取可写数据库引用 + boolean deleteData = false; // 是否删除数据的标志位 + + switch (mMatcher.match(uri)) { // 根据URI匹配执行不同操作 + case URI_NOTE: // 笔记URI + selection = "(" + selection + ") AND " + NoteColumns.ID + ">0 "; // 构建查询语句 + count = db.delete(TABLE.NOTE, selection, selectionArgs); // 删除符合条件的笔记 + break; + case URI_NOTE_ITEM: // 单个笔记URI + id = uri.getPathSegments().get(1); // 获取URI中的笔记ID + long noteId = Long.valueOf(id); // 转换成长整型 + if (noteId <= 0) { + break; // 若ID小于等于0,则跳出 + } + count = db.delete(TABLE.NOTE, NoteColumns.ID + "=" + id + parseSelection(selection), selectionArgs); // 删除指定ID的笔记 + break; + case URI_DATA: // 数据URI + count = db.delete(TABLE.DATA, selection, selectionArgs); // 删除符合条件的数据 + deleteData = true; // 设置删除数据的标志位 + break; + case URI_DATA_ITEM: // 单个数据URI + id = uri.getPathSegments().get(1); // 获取URI中的数据ID + count = db.delete(TABLE.DATA, DataColumns.ID + "=" + id + parseSelection(selection), selectionArgs); // 删除指定ID的数据 + deleteData = true; // 设置删除数据的标志位 + break; + default: + throw new IllegalArgumentException("Unknown URI " + uri); // 抛出未知URI异常 + } + + if (count > 0) { // 若删除成功 + if (deleteData) { + getContext().getContentResolver().notifyChange(Notes.CONTENT_NOTE_URI, null); // 通知笔记URI变化 + } + getContext().getContentResolver().notifyChange(uri, null); // 通知URI变化 + } + return count; // 返回删除行数 + } + + /** + * 执行更新操作,更新数据库中的数据,并返回受影响的行数。 + * + * @param uri 更新的 URI + * @param values 需要更新的数据 + * @param selection 更新的约束条件 + * @param selectionArgs 更新的约束条件参数 + * @return 受影响的行数 + */ + @Override + public int update(Uri uri, ContentValues values, String selection, String[] selectionArgs) { + int count = 0; // 记录更新行数 + String id = null; // ID字符串 + SQLiteDatabase db = mHelper.getWritableDatabase(); // 获取可写数据库引用 + boolean updateData = false; // 是否更新数据的标志位 + + switch (mMatcher.match(uri)) { // 根据URI匹配执行不同操作 + case URI_NOTE: // 笔记URI + increaseNoteVersion(-1, selection, selectionArgs); // 更新笔记版本号 + count = db.update(TABLE.NOTE, values, selection, selectionArgs); // 更新符合条件的笔记数据 + break; + case URI_NOTE_ITEM: // 单个笔记URI + id = uri.getPathSegments().get(1); // 获取URI中的笔记ID + increaseNoteVersion(Long.valueOf(id), selection, selectionArgs); // 更新笔记版本号 + count = db.update(TABLE.NOTE, values, NoteColumns.ID + "=" + id + parseSelection(selection), selectionArgs); // 更新指定ID的笔记数据 + break; + case URI_DATA: // 数据URI + count = db.update(TABLE.DATA, values, selection, selectionArgs); // 更新符合条件的数据 + updateData = true; // 设置更新数据的标志位 + break; + case URI_DATA_ITEM: // 单个数据URI + id = uri.getPathSegments().get(1); // 获取URI中的数据ID + count = db.update(TABLE.DATA, values, DataColumns.ID + "=" + id + parseSelection(selection), selectionArgs); // 更新指定ID的数据 + updateData = true; // 设置更新数据的标志位 + break; + default: + throw new IllegalArgumentException("Unknown URI " + uri); // 抛出未知URI异常 + } + + if (count > 0) { // 若更新成功 + if (updateData) { + getContext().getContentResolver().notifyChange(Notes.CONTENT_NOTE_URI, null); // 通知笔记URI变化 + } + getContext().getContentResolver().notifyChange(uri, null); // 通知URI变化 + } + return count; // 返回更新行数 + } + private String parseSelection(String selection) { + return (!TextUtils.isEmpty(selection) ? " AND (" + selection + ')' : ""); + } + + /** + * 更新笔记的版本号。 + * + * @param id 笔记ID + * @param selection 更新的约束条件 + * @param selectionArgs 更新的约束条件参数 + */ + private void increaseNoteVersion(long id, String selection, String[] selectionArgs) { + StringBuilder sql = new StringBuilder(120); + sql.append("UPDATE "); + sql.append(TABLE.NOTE); + sql.append(" SET "); + sql.append(NoteColumns.VERSION); + sql.append("=" + NoteColumns.VERSION + "+1 "); + + if (id > 0 || !TextUtils.isEmpty(selection)) { + sql.append(" WHERE "); + } + if (id > 0) { + sql.append(NoteColumns.ID + "=" + String.valueOf(id)); + } + if (!TextUtils.isEmpty(selection)) { + String selectString = id > 0 ? parseSelection(selection) : selection; + for (String args : selectionArgs) { + selectString = selectString.replaceFirst("\\?", args); + } + sql.append(selectString); + } + + mHelper.getWritableDatabase().execSQL(sql.toString()); + } + + @Override + public String getType(Uri uri) { + // TODO Auto-generated method stub + return null; + } + +} diff --git a/src/Notes-master/gtask/data/MetaData.java b/src/Notes-master/gtask/data/MetaData.java new file mode 100644 index 0000000..6e30464 --- /dev/null +++ b/src/Notes-master/gtask/data/MetaData.java @@ -0,0 +1,146 @@ +/* + * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net) + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package net.micode.notes.gtask.data; + +import android.database.Cursor; +import android.util.Log; + +import net.micode.notes.tool.GTaskStringUtils; + +import org.json.JSONException; +import org.json.JSONObject; + + +/** + * 元数据类,继承自任务类。 + */ +public class MetaData extends Task { + private final static String TAG = MetaData.class.getSimpleName(); // 类型标签 + + private String mRelatedGid = null; // 相关 GTask 的 GID + + /** + * 设置元数据信息,将关联 GTask 的 GID 存入 metaInfo 中 + * + * @param gid 关联 GTask 的 GID + * @param metaInfo 元数据信息 JSON 对象 + */ + public void setMeta(String gid, JSONObject metaInfo) { + try { + // 将关联 GTask 的 GID 存入元数据信息中 + metaInfo.put(GTaskStringUtils.META_HEAD_GTASK_ID, gid); + } catch (JSONException e) { + // 捕获异常,并记录日志 + Log.e(TAG, "failed to put related gid"); + } + + // 将元数据信息转换为字符串,并设置为笔记内容 + setNotes(metaInfo.toString()); + + // 设置笔记名称为元数据的默认名称 + setName(GTaskStringUtils.META_NOTE_NAME); + } + + /** + * 获取相关 GTask 的 GID + * + * @return 相关 GTask 的 GID + */ + public String getRelatedGid() { + return mRelatedGid; + } + + /** + * 判断是否需要保存 + * + * @return 是否需要保存 + */ + @Override + public boolean isWorthSaving() { + return getNotes() != null; // 判定是否笔记内容不为空 + } + + /** + * 从远端 JSON 对象中获取内容并设置实例属性 + * + * @param js 远端 JSON 对象 + */ + @Override + public void setContentByRemoteJSON(JSONObject js) { + // 调用父类的方法设置实例属性 + super.setContentByRemoteJSON(js); + + // 如果笔记内容不为空 + if (getNotes() != null) { + try { + // 将笔记内容转换为 JSON 对象 + JSONObject metaInfo = new JSONObject(getNotes().trim()); + // 从 JSON 对象中获取关联 GTask 的 GID,并存入实例属性 mRelatedGid + mRelatedGid = metaInfo.getString(GTaskStringUtils.META_HEAD_GTASK_ID); + } catch (JSONException e) { + // 捕获异常,并记录日志 + Log.w(TAG, "failed to get related gid"); + mRelatedGid = null; + } + } + } + + /** + * 从本地 JSON 对象中获取内容并设置实例属性 + *

+ * 注意:此方法不应该被调用 + *

+ * + * @param js 本地 JSON 对象 + * @throws IllegalAccessError 不应该调用此方法 + */ + @Override + public void setContentByLocalJSON(JSONObject js) { + // this function should not be called + throw new IllegalAccessError("MetaData:setContentByLocalJSON should not be called"); + } + + /** + * 获取内容的本地 JSON 对象表示 + *

+ * 注意:此方法不应该被调用 + *

+ * + * @return 本地 JSON 对象 + * @throws IllegalAccessError 不应该调用此方法 + */ + @Override + public JSONObject getLocalJSONFromContent() { + throw new IllegalAccessError("MetaData:getLocalJSONFromContent should not be called"); + } + + /** + * 获取同步操作 + *

+ * 注意:此方法不应该被调用 + *

+ * + * @param c Cursor 对象 + * @return 同步操作 + * @throws IllegalAccessError 不应该调用此方法 + */ + @Override + public int getSyncAction(Cursor c) { + throw new IllegalAccessError("MetaData:getSyncAction should not be called"); + } + +} \ No newline at end of file diff --git a/src/Notes-master/gtask/data/Node.java b/src/Notes-master/gtask/data/Node.java new file mode 100644 index 0000000..67c53e6 --- /dev/null +++ b/src/Notes-master/gtask/data/Node.java @@ -0,0 +1,176 @@ +/* + * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net) + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +/* + * 接口注释: + * Node 类是抽象节点类,用于表示应用程序中的节点。 + */ + +/* + * 数据成员注释: + * 1. mGid: 节点的全局唯一标识 + * 2. mName: 节点的名称 + * 3. mLastModified: 节点最后修改时间 + * 4. mDeleted: 节点是否被标记为已删除 + */ + +/* + * 实现注释: + * 1. getCreateAction(int actionId): 获取创建操作的 JSON 对象表示 + * 2. getUpdateAction(int actionId): 获取更新操作的 JSON 对象表示 + * 3. setContentByRemoteJSON(JSONObject js): 从远端 JSON 对象中获取内容并设置实例属性 + * 4. setContentByLocalJSON(JSONObject js): 从本地 JSON 对象中获取内容并设置实例属性 + * 5. getLocalJSONFromContent(): 获取内容的本地 JSON 对象表示 + * 6. getSyncAction(Cursor c): 获取同步操作 + * 7. setGid(String gid): 设置节点的全局唯一标识 + * 8. setName(String name): 设置节点的名称 + * 9. setLastModified(long lastModified): 设置节点的最后修改时间 + * 10. setDeleted(boolean deleted): 设置节点是否被标记为已删除 + * 11. getGid(): 获取节点的全局唯一标识 + * 12. getName(): 获取节点的名称 + * 13. getLastModified(): 获取节点的最后修改时间 + * 14. getDeleted(): 获取节点是否被标记为已删除 + */ + +/* + * 模块依赖注释: + * 该类依赖于 android.database.Cursor 类和 org.json.JSONObject 类 + */ +package net.micode.notes.gtask.data; + +import android.database.Cursor; + +import org.json.JSONObject; + +public abstract class Node { + // 同步操作常量 + public static final int SYNC_ACTION_NONE = 0; + public static final int SYNC_ACTION_ADD_REMOTE = 1; + public static final int SYNC_ACTION_ADD_LOCAL = 2; + public static final int SYNC_ACTION_DEL_REMOTE = 3; + public static final int SYNC_ACTION_DEL_LOCAL = 4; + public static final int SYNC_ACTION_UPDATE_REMOTE = 5; + public static final int SYNC_ACTION_UPDATE_LOCAL = 6; + public static final int SYNC_ACTION_UPDATE_CONFLICT = 7; + public static final int SYNC_ACTION_ERROR = 8; + + private String mGid; // 节点的全局唯一标识 + private String mName; // 节点的名称 + private long mLastModified; // 节点最后修改时间 + private boolean mDeleted; // 节点是否被标记为已删除 + + public Node() { + mGid = null; + mName = ""; + mLastModified = 0; + mDeleted = false; + } + + // 获取创建操作的JSON对象表示 + public abstract JSONObject getCreateAction(int actionId); + + // 获取更新操作的JSON对象表示 + 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(); + + // 获取同步操作 + /** + * 获取同步操作 + * + * @param c Cursor 对象 + * @return 同步操作 + */ + public abstract int getSyncAction(Cursor c); + + /** + * 设置 GTask 的 GID + * + * @param gid GTask 的 GID + */ + public void setGid(String gid) { + this.mGid = gid; + } + + /** + * 设置任务名称 + * + * @param name 任务名称 + */ + public void setName(String name) { + this.mName = name; + } + + /** + * 设置最后修改时间戳 + * + * @param lastModified 最后修改时间戳 + */ + public void setLastModified(long lastModified) { + this.mLastModified = lastModified; + } + + /** + * 设置删除状态 + * + * @param deleted 删除状态 + */ + public void setDeleted(boolean deleted) { + this.mDeleted = deleted; + } + + /** + * 获取 GTask 的 GID + * + * @return GTask 的 GID + */ + public String getGid() { + return this.mGid; + } + + /** + * 获取任务名称 + * + * @return 任务名称 + */ + public String getName() { + return this.mName; + } + + /** + * 获取最后修改时间戳 + * + * @return 最后修改时间戳 + */ + public long getLastModified() { + return this.mLastModified; + } + + /** + * 获取删除状态 + * + * @return 删除状态 + */ + public boolean getDeleted() { + return this.mDeleted; + } +} \ No newline at end of file diff --git a/src/Notes-master/gtask/data/SqlData.java b/src/Notes-master/gtask/data/SqlData.java new file mode 100644 index 0000000..f8f15ff --- /dev/null +++ b/src/Notes-master/gtask/data/SqlData.java @@ -0,0 +1,212 @@ +/* + * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net) + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package net.micode.notes.gtask.data; + +import android.content.ContentResolver; +import android.content.ContentUris; +import android.content.ContentValues; +import android.content.Context; +import android.database.Cursor; +import android.net.Uri; +import android.util.Log; + +import net.micode.notes.data.Notes; +import net.micode.notes.data.Notes.DataColumns; +import net.micode.notes.data.Notes.DataConstants; +import net.micode.notes.data.Notes.NoteColumns; +import net.micode.notes.data.NotesDatabaseHelper.TABLE; +import net.micode.notes.gtask.exception.ActionFailureException; + +import org.json.JSONException; +import org.json.JSONObject; + +/*定义了一个sqlData类*/ +public class SqlData { + private static final String TAG = SqlData.class.getSimpleName(); + + // 无效ID + private static final int INVALID_ID = -99999; + + // 数据列投影 + public static final String[] PROJECTION_DATA = new String[] { + DataColumns.ID, DataColumns.MIME_TYPE, DataColumns.CONTENT, DataColumns.DATA1, + DataColumns.DATA3 + }; + + // 数据列索引 + public static final int DATA_ID_COLUMN = 0; + public static final int DATA_MIME_TYPE_COLUMN = 1; + public static final int DATA_CONTENT_COLUMN = 2; + public static final int DATA_CONTENT_DATA_1_COLUMN = 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; + + // 构造函数,初始化默认值 + public SqlData(Context context) { + mContentResolver = context.getContentResolver();// 获取内容解析器 + mIsCreate = true;// 默认为创建数据 + mDataId = INVALID_ID; // 设置数据ID为无效ID + mDataMimeType = DataConstants.NOTE; // 默认数据MIME类型为DataConstants.NOTE + mDataContent = "";// 默认数据内容为空字符串 + mDataContentData1 = 0;// 默认数据内容1为0 + mDataContentData3 = "";// 默认数据内容3为空字符串 + mDiffDataValues = new ContentValues();// 创建一个差异数据值的 ContentValues 对象 + } + + // 构造函数,从Cursor加载数据 + public SqlData(Context context, Cursor c) { + mContentResolver = context.getContentResolver(); + mIsCreate = false; + loadFromCursor(c); + mDiffDataValues = new ContentValues(); + } + + // 从Cursor加载数据 + private void loadFromCursor(Cursor c) { + mDataId = c.getLong(DATA_ID_COLUMN); // 从游标获取数据 ID + mDataMimeType = c.getString(DATA_MIME_TYPE_COLUMN); // 从游标获取数据的 MIME 类型 + mDataContent = c.getString(DATA_CONTENT_COLUMN); // 从游标获取数据内容 + mDataContentData1 = c.getLong(DATA_CONTENT_DATA_1_COLUMN); // 从游标获取数据内容的数据1 + mDataContentData3 = c.getString(DATA_CONTENT_DATA_3_COLUMN); // 从游标获取数据内容的数据3 + } + + // 设置内容 + public void setContent(JSONObject js) throws JSONException { + // 提取JSON中的数据ID,若不存在则使用无效ID + long dataId = js.has(DataColumns.ID) ? js.getLong(DataColumns.ID) : INVALID_ID; + // 若是创建操作或数据ID不同,则将新数据放入差异值中 + if (mIsCreate || mDataId != dataId) { + mDiffDataValues.put(DataColumns.ID, dataId); + } + mDataId = dataId; + + // 提取JSON中的数据MIME类型,若不存在则使用默认值 + String dataMimeType = js.has(DataColumns.MIME_TYPE) ? js.getString(DataColumns.MIME_TYPE) + : DataConstants.NOTE; + // 若是创建操作或MIME类型不同,则将新数据放入差异值中 + if (mIsCreate || !mDataMimeType.equals(dataMimeType)) { + mDiffDataValues.put(DataColumns.MIME_TYPE, dataMimeType); + } + mDataMimeType = dataMimeType; + + // 提取JSON中的数据内容,若不存在则使用空字符串 + String dataContent = js.has(DataColumns.CONTENT) ? js.getString(DataColumns.CONTENT) : ""; + // 若是创建操作或内容不同,则将新数据放入差异值中 + if (mIsCreate || !mDataContent.equals(dataContent)) { + mDiffDataValues.put(DataColumns.CONTENT, dataContent); + } + mDataContent = dataContent; + + // 提取JSON中的数据内容1,若不存在则使用默认值 + long dataContentData1 = js.has(DataColumns.DATA1) ? js.getLong(DataColumns.DATA1) : 0; + // 若是创建操作或内容1不同,则将新数据放入差异值中 + if (mIsCreate || mDataContentData1 != dataContentData1) { + mDiffDataValues.put(DataColumns.DATA1, dataContentData1); + } + mDataContentData1 = dataContentData1; + + // 提取JSON中的数据内容3,若不存在则使用空字符串 + String dataContentData3 = js.has(DataColumns.DATA3) ? js.getString(DataColumns.DATA3) : ""; + // 若是创建操作或内容3不同,则将新数据放入差异值中 + if (mIsCreate || !mDataContentData3.equals(dataContentData3)) { + mDiffDataValues.put(DataColumns.DATA3, dataContentData3); + } + mDataContentData3 = dataContentData3; + } + public JSONObject getContent() throws JSONException { + // 接口注释:获取数据内容 + if (mIsCreate) { + Log.e(TAG, "it seems that we haven't created this in database yet"); + return null; + } + JSONObject js = new JSONObject(); + js.put(DataColumns.ID, mDataId);// 数据成员注释:数据Id + js.put(DataColumns.MIME_TYPE, mDataMimeType);// 数据成员注释:数据类型 + js.put(DataColumns.CONTENT, mDataContent);// 数据成员注释:数据内容 + js.put(DataColumns.DATA1, mDataContentData1);// 数据成员注释:数据ContentData1 + js.put(DataColumns.DATA3, mDataContentData3);// 数据成员注释:数据ContentData3 + return js; + } + + public void commit(long noteId, boolean validateVersion, long version) { + // 实现注释:提交数据 + if (mIsCreate) { + if (mDataId == INVALID_ID && mDiffDataValues.containsKey(DataColumns.ID)) { + mDiffDataValues.remove(DataColumns.ID); + } + + mDiffDataValues.put(DataColumns.NOTE_ID, noteId); + Uri uri = mContentResolver.insert(Notes.CONTENT_DATA_URI, mDiffDataValues); + try { + mDataId = Long.valueOf(uri.getPathSegments().get(1)); + } catch (NumberFormatException e) { + Log.e(TAG, "Get note id error :" + e.toString()); + throw new ActionFailureException("create note failed"); + } + } else { + if (mDiffDataValues.size() > 0) { + int result = 0; + if (!validateVersion) { + // 模块依赖注释:更新数据 + result = mContentResolver.update(ContentUris.withAppendedId( + Notes.CONTENT_DATA_URI, mDataId), mDiffDataValues, null, null); + } else { + result = mContentResolver.update(ContentUris.withAppendedId( + Notes.CONTENT_DATA_URI, mDataId), mDiffDataValues, + " ? in (SELECT " + NoteColumns.ID + " FROM " + TABLE.NOTE + + " WHERE " + NoteColumns.VERSION + "=?)", new String[] { + String.valueOf(noteId), String.valueOf(version) + }); + } + if (result == 0) { + Log.w(TAG, "there is no update. maybe user updates note when syncing"); + } + } + } + + mDiffDataValues.clear(); + mIsCreate = false; + } + + public long getId() { + // 接口注释:获取数据Id + return mDataId; + } +} diff --git a/src/Notes-master/gtask/data/SqlNote.java b/src/Notes-master/gtask/data/SqlNote.java new file mode 100644 index 0000000..28e4b17 --- /dev/null +++ b/src/Notes-master/gtask/data/SqlNote.java @@ -0,0 +1,502 @@ +/* + * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net) + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package net.micode.notes.gtask.data; + +import android.appwidget.AppWidgetManager; +import android.content.ContentResolver; +import android.content.ContentValues; +import android.content.Context; +import android.database.Cursor; +import android.net.Uri; +import android.util.Log; + +import net.micode.notes.data.Notes; +import net.micode.notes.data.Notes.DataColumns; +import net.micode.notes.data.Notes.NoteColumns; +import net.micode.notes.gtask.exception.ActionFailureException; +import net.micode.notes.tool.GTaskStringUtils; +import net.micode.notes.tool.ResourceParser; + +import org.json.JSONArray; +import org.json.JSONException; +import org.json.JSONObject; + +import java.util.ArrayList; + +/** + * 数据成员注释:SqlNote类负责与数据库中的笔记数据进行交互处理。 + */ +public class SqlNote { + private static final String TAG = SqlNote.class.getSimpleName(); + + private static final int INVALID_ID = -99999; + + // 定义查询笔记使用的投影列数组 + public static final String[] PROJECTION_NOTE = new String[] { + // 以下依次对应列的含义 + NoteColumns.ID, NoteColumns.ALERTED_DATE, NoteColumns.BG_COLOR_ID, + NoteColumns.CREATED_DATE, NoteColumns.HAS_ATTACHMENT, NoteColumns.MODIFIED_DATE, + NoteColumns.NOTES_COUNT, NoteColumns.PARENT_ID, NoteColumns.SNIPPET, NoteColumns.TYPE, + NoteColumns.WIDGET_ID, NoteColumns.WIDGET_TYPE, NoteColumns.SYNC_ID, + NoteColumns.LOCAL_MODIFIED, NoteColumns.ORIGIN_PARENT_ID, NoteColumns.GTASK_ID, + NoteColumns.VERSION + }; + + // 以下依次对应PROJECTION_NOTE中列的下标 + public static final int ID_COLUMN = 0; + public static final int ALERTED_DATE_COLUMN = 1; + public static final int BG_COLOR_ID_COLUMN = 2; + public static final int CREATED_DATE_COLUMN = 3; + public static final int HAS_ATTACHMENT_COLUMN = 4; + public static final int MODIFIED_DATE_COLUMN = 5; + public static final int NOTES_COUNT_COLUMN = 6; + public static final int PARENT_ID_COLUMN = 7; + public static final int SNIPPET_COLUMN = 8; + public static final int TYPE_COLUMN = 9; + public static final int WIDGET_ID_COLUMN = 10; + public static final int WIDGET_TYPE_COLUMN = 11; + public static final int SYNC_ID_COLUMN = 12; + public static final int LOCAL_MODIFIED_COLUMN = 13; + public static final int ORIGIN_PARENT_ID_COLUMN = 14; + public static final int GTASK_ID_COLUMN = 15; + public static final int VERSION_COLUMN = 16; + + private Context mContext; + + private ContentResolver mContentResolver; + + private boolean mIsCreate; + + private long mId; + private long mAlertDate; + private int mBgColorId; + private long mCreatedDate; + private int mHasAttachment; + private long mModifiedDate; + private long mParentId; + private String mSnippet; + private int mType; + private int mWidgetId; + private int mWidgetType; + private long mOriginParent; + private long mVersion; + private ContentValues mDiffNoteValues; + private ArrayList mDataList; + + /** + * 接口注释:SqlNote类用于对笔记数据进行数据库操作的封装。 + * + * @param context 上下文环境 + */ + public SqlNote(Context context) { + mContext = context; // 上下文对象 + mContentResolver = context.getContentResolver(); // 获取内容解析器 + mIsCreate = true; // 是否是创建状态 + mId = INVALID_ID; // ID 设置为无效值 + mAlertDate = 0; // 提醒日期初始化为0 + mBgColorId = ResourceParser.getDefaultBgId(context); // 背景颜色ID初始化为默认背景颜色 + mCreatedDate = System.currentTimeMillis(); // 创建日期初始化为当前时间 + mHasAttachment = 0; // 是否有附件初始化为0 - 表示没有附件 + mModifiedDate = System.currentTimeMillis(); // 修改日期初始化为当前时间 + mParentId = 0; // 父级ID初始化为0 + mSnippet = ""; // 摘录初始化为空字符串 + mType = Notes.TYPE_NOTE; // 类型为普通笔记类型 + mWidgetId = AppWidgetManager.INVALID_APPWIDGET_ID; // 小部件ID初始化为无效ID + mWidgetType = Notes.TYPE_WIDGET_INVALIDE; // 小部件类型初始化为无效类型 + mOriginParent = 0; // 原始父级ID初始化为0 + mVersion = 0; // 版本号初始化为0 + mDiffNoteValues = new ContentValues(); // 差异笔记值的容器 + mDataList = new ArrayList(); // 数据列表容器 + } + + /** + * 实现注释:通过数据库游标加载SqlNote对象。 + * + * @param context 上下文环境 + * @param c 数据库游标 + */ + public SqlNote(Context context, Cursor c) { + mContext = context; // 上下文对象 + mContentResolver = context.getContentResolver(); // 获取内容解析器 + mIsCreate = false; // 是否是创建状态设置为false + loadFromCursor(c); // 从游标加载数据 + mDataList = new ArrayList(); // 数据列表容器 + if (mType == Notes.TYPE_NOTE) // 如果类型为普通笔记类型 + loadDataContent(); // 加载数据内容 + mDiffNoteValues = new ContentValues(); // 差异笔记值的容器 + } + + /** + * 实现注释:通过笔记ID加载SqlNote对象。 + * + * @param context 上下文环境 + * @param id 笔记ID + */ + public SqlNote(Context context, long id) { + mContext = context; // 上下文对象 + mContentResolver = context.getContentResolver(); // 获取内容解析器 + mIsCreate = false; // 是否是创建状态设置为 false + loadFromCursor(id); // 根据ID从游标加载数据 + mDataList = new ArrayList(); // 数据列表容器 + if (mType == Notes.TYPE_NOTE) // 如果类型为普通笔记类型 + loadDataContent(); // 加载数据内容 + mDiffNoteValues = new ContentValues(); // 差异笔记值的容器 + } + + // ...(未完) + + /** + * 从Cursor中加载指定id的笔记数据。 + * @param id 笔记ID + */ + private void loadFromCursor(long id) { + Cursor c = null; + try { + // 通过查询URI和ID获取匹配的Cursor对象 + 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"); + } + } finally { + if (c != null) + c.close(); + } + } + + /** + * 从Cursor中加载笔记数据并赋值给相应的成员变量。 + * @param c 笔记Cursor对象 + */ + private void loadFromCursor(Cursor c) { + mId = c.getLong(ID_COLUMN); // 从游标中获取ID + mAlertDate = c.getLong(ALERTED_DATE_COLUMN); // 从游标中获取提醒日期 + mBgColorId = c.getInt(BG_COLOR_ID_COLUMN); // 从游标中获取背景颜色ID + mCreatedDate = c.getLong(CREATED_DATE_COLUMN); // 从游标中获取创建日期 + mHasAttachment = c.getInt(HAS_ATTACHMENT_COLUMN); // 从游标中获取是否有附件 + mModifiedDate = c.getLong(MODIFIED_DATE_COLUMN); // 从游标中获取修改日期 + mParentId = c.getLong(PARENT_ID_COLUMN); // 从游标中获取父级ID + mSnippet = c.getString(SNIPPET_COLUMN); // 从游标中获取摘录 + mType = c.getInt(TYPE_COLUMN); // 从游标中获取类型 + mWidgetId = c.getInt(WIDGET_ID_COLUMN); // 从游标中获取小部件ID + mWidgetType = c.getInt(WIDGET_TYPE_COLUMN); // 从游标中获取小部件类型 + mVersion = c.getLong(VERSION_COLUMN); // 从游标中获取版本号 + } + /** + * 加载笔记的附加数据。 + */ + private void loadDataContent() { + Cursor c = null; + mDataList.clear(); + try { + // 通过查询URI和笔记ID获取匹配的笔记附加数据Cursor对象 + c = mContentResolver.query(Notes.CONTENT_DATA_URI, SqlData.PROJECTION_DATA, + "(note_id=?)", new String[] { String.valueOf(mId) }, null); + if (c != null) { + if (c.getCount() == 0) { + Log.w(TAG, "it seems that the note has not data"); + return; + } + // 遍历Cursor,构造SqlData对象并添加到附加数据列表中 + while (c.moveToNext()) { + SqlData data = new SqlData(mContext, c); + mDataList.add(data); + } + } else { + Log.w(TAG, "loadDataContent: cursor = null"); + } + } finally { + if (c != null) + c.close(); + } + } + + + + /** + * 设置笔记的内容,更新笔记的类型、小部件信息、原始父文件夹 ID 和附件数据 + * + * @param js 包含笔记和数据的 JSON 对象 + * @return 设置是否成功的布尔值 + */ + // 数据成员注释: + // mIsCreate:标记是否为创建新笔记的操作 + // mType:笔记的类型 + // mWidgetId:笔记的小部件 ID + // mWidgetType:笔记的小部件类型 + // mOriginParent:笔记的原始父文件夹 ID + // mDiffNoteValues:记录与原始笔记不同的属性和值的映射关系 + // mDataList:存储附件数据的列表 + // 实现注释: + // 更新笔记属性: + // 更新笔记的类型(如果有改变) + // 更新笔记的小部件 ID(如果有改变) + // 更新笔记的小部件类型(如果有改变) + // 更新笔记的原始父文件夹 ID(如果有改变) + // 遍历附件数据,处理每一项: + // 如果附件数据已存在于 mDataList 中,则使用现有的 SqlData 对象 + // 否则,创建新的 SqlData 对象并添加到 mDataList 中 + // 设置附件数据的内容 + + // 模块依赖注释: + // 依赖的类: + // JSONObject:JSON 对象类 + // JSONArray:JSON 数组类 + // SqlData:自定义的 SQL 数据类 + // 依赖的接口和方法: + // AppWidgetManager.INVALID_APPWIDGET_ID:无效的小部件 ID 值 + // NoteColumns.TYPE:笔记类型在数据库中的列名 + // NoteColumns.WIDGET_ID:小部件 ID 在数据库中的列名 + // NoteColumns.WIDGET_TYPE:小部件类型在数据库中的列名 + // NoteColumns.ORIGIN_PARENT_ID:原始父文件夹 ID 在数据库中的列名 + // DataColumns.ID:附件数据 ID 在数据库中的列名 + // SqlData.setContent(data):设置附件数据的内容的方法 + public boolean setContent(JSONObject js) { + try { + // 提取笔记对象和数据数组 + JSONObject note = js.getJSONObject("note"); // 提取笔记对象 + JSONArray dataArray = js.getJSONArray("dataArray"); // 提取数据数组 + + // 更新笔记的类型 + int type = note.has(NoteColumns.TYPE) ? note.getInt(NoteColumns.TYPE) : Notes.TYPE_NOTE; + if (mIsCreate || mType != type) { + mDiffNoteValues.put(NoteColumns.TYPE, type); // 将类型加入差异笔记值中 + } + mType = type; + + // 更新笔记的小部件 ID + int widgetId = note.has(NoteColumns.WIDGET_ID) ? note.getInt(NoteColumns.WIDGET_ID) : AppWidgetManager.INVALID_APPWIDGET_ID; + if (mIsCreate || mWidgetId != widgetId) { + mDiffNoteValues.put(NoteColumns.WIDGET_ID, widgetId); // 将小部件 ID 加入差异笔记值中 + } + mWidgetId = widgetId; + + // 更新笔记的小部件类型 + int widgetType = note.has(NoteColumns.WIDGET_TYPE) ? note.getInt(NoteColumns.WIDGET_TYPE) : Notes.TYPE_WIDGET_INVALIDE; + if (mIsCreate || mWidgetType != widgetType) { + mDiffNoteValues.put(NoteColumns.WIDGET_TYPE, widgetType); // 将小部件类型加入差异笔记值中 + } + mWidgetType = widgetType; + + // 更新笔记的原始父文件夹 ID + long originParent = note.has(NoteColumns.ORIGIN_PARENT_ID) ? note.getLong(NoteColumns.ORIGIN_PARENT_ID) : 0; + if (mIsCreate || mOriginParent != originParent) { + mDiffNoteValues.put(NoteColumns.ORIGIN_PARENT_ID, originParent); // 将原始父文件夹 ID 加入差异笔记值中 + } + mOriginParent = originParent; + + // 更新笔记的附件数据 + for (int i = 0; i < dataArray.length(); i++) { + JSONObject data = dataArray.getJSONObject(i); + SqlData sqlData = null; + if (data.has(DataColumns.ID)) { + long dataId = data.getLong(DataColumns.ID); + for (SqlData temp : mDataList) { + if (dataId == temp.getId()) { + sqlData = temp; + } + } + } + + if (sqlData == null) { + sqlData = new SqlData(mContext); + mDataList.add(sqlData); + } + + // 设置附件数据的内容 + sqlData.setContent(data); // 设置附件数据的内容 + } + } catch (JSONException e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + return false; // 解析失败,返回 false + } + return true; // 解析成功,返回 true + } + /** + * 获取笔记内容的 JSON 对象 + * + * @return 笔记内容的 JSON 对象,或者返回 null 如果笔记未创建在数据库中 + */ + public JSONObject getContent() { + try { + JSONObject js = new JSONObject(); + + if (mIsCreate) { + Log.e(TAG, "在数据库中似乎还没有创建此笔记"); + return null; + } + + JSONObject note = new JSONObject(); + if (mType == Notes.TYPE_NOTE) { + // 数据成员注释: + // NoteColumns.ID:笔记 ID + // NoteColumns.ALERTED_DATE:提醒日期 + // NoteColumns.BG_COLOR_ID:背景颜色 ID + // NoteColumns.CREATED_DATE:创建日期 + // NoteColumns.HAS_ATTACHMENT:是否有附件 + // NoteColumns.MODIFIED_DATE:修改日期 + // NoteColumns.PARENT_ID:父文件夹 ID + // NoteColumns.SNIPPET:内容摘要 + // NoteColumns.TYPE:笔记类型 + // NoteColumns.WIDGET_ID:小部件 ID + // NoteColumns.WIDGET_TYPE:小部件类型 + // NoteColumns.ORIGIN_PARENT_ID:原始父文件夹 ID + note.put(NoteColumns.ID, mId); + note.put(NoteColumns.ALERTED_DATE, mAlertDate); + note.put(NoteColumns.BG_COLOR_ID, mBgColorId); + note.put(NoteColumns.CREATED_DATE, mCreatedDate); + note.put(NoteColumns.HAS_ATTACHMENT, mHasAttachment); + note.put(NoteColumns.MODIFIED_DATE, mModifiedDate); + note.put(NoteColumns.PARENT_ID, mParentId); + note.put(NoteColumns.SNIPPET, mSnippet); + note.put(NoteColumns.TYPE, mType); + note.put(NoteColumns.WIDGET_ID, mWidgetId); + note.put(NoteColumns.WIDGET_TYPE, mWidgetType); + note.put(NoteColumns.ORIGIN_PARENT_ID, mOriginParent); + js.put(GTaskStringUtils.META_HEAD_NOTE, note); + + JSONArray dataArray = new JSONArray(); + for (SqlData sqlData : mDataList) { + JSONObject data = sqlData.getContent(); + if (data != null) { + dataArray.put(data); + } + } + js.put(GTaskStringUtils.META_HEAD_DATA, dataArray); + } else if (mType == Notes.TYPE_FOLDER || mType == Notes.TYPE_SYSTEM) { + // 数据成员注释: + // NoteColumns.ID:笔记 ID + // NoteColumns.TYPE:笔记类型 + // NoteColumns.SNIPPET:内容摘要 + note.put(NoteColumns.ID, mId); + note.put(NoteColumns.TYPE, mType); + note.put(NoteColumns.SNIPPET, mSnippet); + js.put(GTaskStringUtils.META_HEAD_NOTE, note); + } + + return js; + } catch (JSONException e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + } + return null; + } + + public void setParentId(long id) { + mParentId = id; + mDiffNoteValues.put(NoteColumns.PARENT_ID, id); + } + + public void setGtaskId(String gid) { + mDiffNoteValues.put(NoteColumns.GTASK_ID, gid); + } + + public void setSyncId(long syncId) { + mDiffNoteValues.put(NoteColumns.SYNC_ID, syncId); + } + + public void resetLocalModified() { + mDiffNoteValues.put(NoteColumns.LOCAL_MODIFIED, 0); + } + + public long getId() { + return mId; + } + + public long getParentId() { + return mParentId; + } + + public String getSnippet() { + return mSnippet; + } + + public boolean isNoteType() { + return mType == Notes.TYPE_NOTE; + } + + /** + * 提交操作,根据不同情况执行创建或更新操作 + * + * @param validateVersion 是否验证版本 + */ + public void commit(boolean validateVersion) { + if (mIsCreate) { // 如果是创建状态 + if (mId == INVALID_ID && mDiffNoteValues.containsKey(NoteColumns.ID)) { + mDiffNoteValues.remove(NoteColumns.ID); // 移除差异笔记值中的 ID 键 + } + + Uri uri = mContentResolver.insert(Notes.CONTENT_NOTE_URI, mDiffNoteValues); // 将差异笔记值插入内容提供器 + try { + mId = Long.valueOf(uri.getPathSegments().get(1)); // 从 URI 中获取插入的笔记 ID + } catch (NumberFormatException e) { + Log.e(TAG, "Get note id error :" + e.toString()); // 打印错误日志 + throw new ActionFailureException("create note failed"); // 抛出操作失败异常 + } + if (mId == 0) { + throw new IllegalStateException("Create thread id failed"); // 抛出非法状态异常 + } + + if (mType == Notes.TYPE_NOTE) { // 如果类型为普通笔记类型 + for (SqlData sqlData : mDataList) { // 遍历数据列表 + sqlData.commit(mId, false, -1); // 提交数据 + } + } + } else { + if (mId <= 0 && mId != Notes.ID_ROOT_FOLDER && mId != Notes.ID_CALL_RECORD_FOLDER) { + Log.e(TAG, "No such note"); // 打印错误日志 + throw new IllegalStateException("Try to update note with invalid id"); // 抛出非法状态异常 + } + if (mDiffNoteValues.size() > 0) { + mVersion++; // 版本号加一 + int result = 0; + if (!validateVersion) { + result = mContentResolver.update(Notes.CONTENT_NOTE_URI, mDiffNoteValues, "(" + + NoteColumns.ID + "=?)", new String[] { + String.valueOf(mId) + }); + } else { + result = mContentResolver.update(Notes.CONTENT_NOTE_URI, mDiffNoteValues, "(" + + NoteColumns.ID + "=?) AND (" + NoteColumns.VERSION + "<=?)", + new String[] { + String.valueOf(mId), String.valueOf(mVersion) + }); + } + if (result == 0) { + Log.w(TAG, "there is no update. maybe user updates note when syncing"); + } + } + + if (mType == Notes.TYPE_NOTE) { // 如果类型为普通笔记类型 + for (SqlData sqlData : mDataList) { // 遍历数据列表 + sqlData.commit(mId, validateVersion, mVersion); // 提交数据 + } + } + } + + // 刷新本地信息 + loadFromCursor(mId); + if (mType == Notes.TYPE_NOTE) + loadDataContent(); + + mDiffNoteValues.clear(); // 清空差异笔记值 + mIsCreate = false; // 设置为非创建状态 + } +} diff --git a/src/Notes-master/gtask/data/Task.java b/src/Notes-master/gtask/data/Task.java new file mode 100644 index 0000000..37aab6a --- /dev/null +++ b/src/Notes-master/gtask/data/Task.java @@ -0,0 +1,447 @@ +/* + * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net) + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package net.micode.notes.gtask.data; + +import android.database.Cursor; +import android.text.TextUtils; +import android.util.Log; + +import net.micode.notes.data.Notes; +import net.micode.notes.data.Notes.DataColumns; +import net.micode.notes.data.Notes.DataConstants; +import net.micode.notes.data.Notes.NoteColumns; +import net.micode.notes.gtask.exception.ActionFailureException; +import net.micode.notes.tool.GTaskStringUtils; + +import org.json.JSONArray; +import org.json.JSONException; +import org.json.JSONObject; + + +/** + * 任务类,表示一个任务节点。 + */ +public class Task extends Node { + private static final String TAG = Task.class.getSimpleName(); + + private boolean mCompleted; // 标识任务是否已完成 + + private String mNotes; // 任务的备注信息 + + private JSONObject mMetaInfo; // 任务的附加元数据 + + private Task mPriorSibling; // 任务列表中该任务的前一个任务节点 + + private TaskList mParent; // 该任务的父任务列表 + + /** + * 构造函数,创建一个具有默认值的 Task 对象。 + */ + public Task() { + super(); + mCompleted = false; + mNotes = null; + mPriorSibling = null; + mParent = null; + mMetaInfo = null; + } + + /** + * 生成创建任务的 JSON 对象。 + * + * @param actionId 创建操作的 ID + * @return 创建操作的 JSON 对象 + * @throws ActionFailureException 如果生成 JSON 对象失败 + */ + /** + * 生成创建任务的 JSON 对象。 + * + * @param actionId 创建操作的 ID + * @return 创建操作的 JSON 对象 + * @throws ActionFailureException 如果生成 JSON 对象失败 + */ + public JSONObject getCreateAction(int actionId) throws ActionFailureException { + JSONObject js = new JSONObject(); // 创建一个新的 JSON 对象 + + try { + // action_type + js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, // 设置 JSON 对象中的 action_type 字段 + GTaskStringUtils.GTASK_JSON_ACTION_TYPE_CREATE); + + // action_id + js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId); // 设置 JSON 对象中的 action_id 字段 + + // index + js.put(GTaskStringUtils.GTASK_JSON_INDEX, mParent.getChildTaskIndex(this)); // 设置 JSON 对象中的 index 字段,调用 mParent 中的 getChildTaskIndex 方法获得任务的索引 + + // entity_delta + JSONObject entity = new JSONObject(); // 创建一个新的 JSON 对象 entity + entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName()); // 设置 entity 中的 name 字段为当前任务的名字 + entity.put(GTaskStringUtils.GTASK_JSON_CREATOR_ID, "null"); // 设置 entity 中的 creator_id 字段为 null + entity.put(GTaskStringUtils.GTASK_JSON_ENTITY_TYPE, // 设置 entity 中的 entity_type 字段为类型为任务 + GTaskStringUtils.GTASK_JSON_TYPE_TASK); + if (getNotes() != null) { + entity.put(GTaskStringUtils.GTASK_JSON_NOTES, getNotes()); // 如果任务有备注信息,则设置 entity 中的 notes 字段为任务的备注信息 + } + js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity); // 将 entity 对象作为 JSON 对象的 entity_delta 字段的值 + + // parent_id + js.put(GTaskStringUtils.GTASK_JSON_PARENT_ID, mParent.getGid()); // 设置 JSON 对象中的 parent_id 字段为该任务的父任务列表的 gid + + // dest_parent_type + js.put(GTaskStringUtils.GTASK_JSON_DEST_PARENT_TYPE, // 设置 JSON 对象中的 dest_parent_type 字段为组类型 + GTaskStringUtils.GTASK_JSON_TYPE_GROUP); + + // list_id + js.put(GTaskStringUtils.GTASK_JSON_LIST_ID, mParent.getGid()); // 设置 JSON 对象中的 list_id 字段为该任务的父任务列表的 gid + + // prior_sibling_id + if (mPriorSibling != null) { + js.put(GTaskStringUtils.GTASK_JSON_PRIOR_SIBLING_ID, mPriorSibling.getGid()); // 如果存在前一个任务节点,则设置 prior_sibling_id 为前一个任务节点的 gid + } + + } catch (JSONException e) { + Log.e(TAG, e.toString()); // 打印错误日志 + e.printStackTrace(); // 输出异常信息 + throw new ActionFailureException("生成任务创建 JSON 对象失败"); // 抛出生成任务创建 JSON 对象失败的异常 + } + + return js; // 返回创建的 JSON 对象 + } + + + /** + * 生成更新任务的 JSON 对象。 + * + * @param actionId 更新操作的 ID + * @return 更新操作的 JSON 对象 + */ + public JSONObject getUpdateAction(int actionId) { + JSONObject js = new JSONObject(); // 创建一个新的 JSON 对象 + + try { + // action_type + js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, // 设置 JSON 对象中的 action_type 字段为更新操作类型 + GTaskStringUtils.GTASK_JSON_ACTION_TYPE_UPDATE); + + // action_id + js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId); // 设置 JSON 对象中的 action_id 字段为指定的操作 ID + + // id + js.put(GTaskStringUtils.GTASK_JSON_ID, getGid()); // 设置 JSON 对象中的 id 字段为当前任务的 gid + + // entity_delta + JSONObject entity = new JSONObject(); // 创建一个新的 JSON 对象 entity + entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName()); // 设置 entity 中的 name 字段为当前任务的名字 + if (getNotes() != null) { + entity.put(GTaskStringUtils.GTASK_JSON_NOTES, getNotes()); // 如果任务有备注信息,则设置 entity 中的 notes 字段为任务的备注 + } + entity.put(GTaskStringUtils.GTASK_JSON_DELETED, getDeleted()); // 设置 entity 中的 deleted 字段为当前任务的删除状态 + js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity); // 将 entity 对象作为 JSON 对象的 entity_delta 字段的值 + + } catch (JSONException e) { + Log.e(TAG, e.toString()); // 打印错误日志 + e.printStackTrace(); // 输出异常信息 + throw new ActionFailureException("fail to generate task-update jsonobject"); // 抛出生成任务更新 JSON 对象失败的异常 + } + + return js; // 返回创建的 JSON 对象 + } + + /** + * 从远程 JSON 对象设置内容。 + * + * @param js 远程 JSON 对象 + */ + public void setContentByRemoteJSON(JSONObject js) { + if (js != null) { + try { + // id + if (js.has(GTaskStringUtils.GTASK_JSON_ID)) { + setGid(js.getString(GTaskStringUtils.GTASK_JSON_ID)); // 如果 JSON 对象中包含 id 字段,则设置当前对象的 gid + } + + // last_modified + if (js.has(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)) { + setLastModified(js.getLong(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)); // 如果 JSON 对象中包含 last_modified 字段,则设置当前对象的 last_modified + } + + // name + if (js.has(GTaskStringUtils.GTASK_JSON_NAME)) { + setName(js.getString(GTaskStringUtils.GTASK_JSON_NAME)); // 如果 JSON 对象中包含 name 字段,则设置当前对象的 name + } + + // notes + if (js.has(GTaskStringUtils.GTASK_JSON_NOTES)) { + setNotes(js.getString(GTaskStringUtils.GTASK_JSON_NOTES)); // 如果 JSON 对象中包含 notes 字段,则设置当前对象的 notes + } + + // deleted + if (js.has(GTaskStringUtils.GTASK_JSON_DELETED)) { + setDeleted(js.getBoolean(GTaskStringUtils.GTASK_JSON_DELETED)); // 如果 JSON 对象中包含 deleted 字段,则设置当前对象的 deleted + } + + // completed + if (js.has(GTaskStringUtils.GTASK_JSON_COMPLETED)) { + setCompleted(js.getBoolean(GTaskStringUtils.GTASK_JSON_COMPLETED)); // 如果 JSON 对象中包含 completed 字段,则设置当前对象的 completed + } + } catch (JSONException e) { + Log.e(TAG, e.toString()); // 打印错误日志 + e.printStackTrace(); // 输出异常信息 + throw new ActionFailureException("fail to get task content from jsonobject"); // 抛出从 JSON 对象获取任务内容失败的异常 + } + } + } + + /** + * 从本地 JSON 对象设置内容。 + * + * @param js 本地 JSON 对象 + */ + public void setContentByLocalJSON(JSONObject js) { + if (js == null || !js.has(GTaskStringUtils.META_HEAD_NOTE) + || !js.has(GTaskStringUtils.META_HEAD_DATA)) { + Log.w(TAG, "setContentByLocalJSON: nothing is avaiable"); // 如果本地 JSON 对象为空,或者缺少必要的元数据,记录警告日志并返回 + } + + try { + JSONObject note = js.getJSONObject(GTaskStringUtils.META_HEAD_NOTE); // 获取元数据中的笔记信息 + JSONArray dataArray = js.getJSONArray(GTaskStringUtils.META_HEAD_DATA); // 获取元数据中的数据数组 + + if (note.getInt(NoteColumns.TYPE) != Notes.TYPE_NOTE) { + Log.e(TAG, "invalid type"); // 如果笔记类型不是普通笔记,记录错误日志并返回 + return; + } + + for (int i = 0; i < dataArray.length(); i++) { + JSONObject data = dataArray.getJSONObject(i); // 获取数组中的每个数据对象 + if (TextUtils.equals(data.getString(DataColumns.MIME_TYPE), DataConstants.NOTE)) { + setName(data.getString(DataColumns.CONTENT)); // 如果数据的 MIME 类型是笔记,设置当前对象的名称为数据的内容并结束循环 + break; + } + } + + } catch (JSONException e) { + Log.e(TAG, e.toString()); // 记录异常信息 + e.printStackTrace(); // 输出异常信息 + } + } + /** + * 从内容生成本地 JSON 对象。 + * + * @return 本地 JSON 对象 + */ + public JSONObject getLocalJSONFromContent() { + String name = getName(); // 获取当前对象的名称 + + try { + if (mMetaInfo == null) { + // 从网络创建的新任务 + if (name == null) { + Log.w(TAG, "the note seems to be an empty one"); // 如果名称为空,记录警告日志并返回 null + return null; + } + + JSONObject js = new JSONObject(); // 创建新的 JSON 对象 + JSONObject note = new JSONObject(); // 创建笔记的 JSON 对象 + JSONArray dataArray = new JSONArray(); // 创建数据的 JSON 数组 + JSONObject data = new JSONObject(); // 创建数据的 JSON 对象 + data.put(DataColumns.CONTENT, name); // 设置数据的内容为名称 + dataArray.put(data); // 将数据添加到数据数组中 + js.put(GTaskStringUtils.META_HEAD_DATA, dataArray); // 将数据数组添加到 JSON 对象中的元数据中 + note.put(NoteColumns.TYPE, Notes.TYPE_NOTE); // 设置笔记类型为普通笔记 + js.put(GTaskStringUtils.META_HEAD_NOTE, note); // 将笔记添加到 JSON 对象中的元数据中 + return js; // 返回 JSON 对象 + + } else { + // 同步的任务 + JSONObject note = mMetaInfo.getJSONObject(GTaskStringUtils.META_HEAD_NOTE); // 获取元数据中的笔记信息 + JSONArray dataArray = mMetaInfo.getJSONArray(GTaskStringUtils.META_HEAD_DATA); // 获取元数据中的数据数组 + + for (int i = 0; i < dataArray.length(); i++) { + JSONObject data = dataArray.getJSONObject(i); // 获取数组中的每个数据对象 + if (TextUtils.equals(data.getString(DataColumns.MIME_TYPE), DataConstants.NOTE)) { + data.put(DataColumns.CONTENT, getName()); // 如果数据的 MIME 类型是笔记,将内容设置为当前对象的名称并结束循环 + break; + } + } + + note.put(NoteColumns.TYPE, Notes.TYPE_NOTE); // 设置笔记类型为普通笔记 + return mMetaInfo; // 返回元数据 JSON 对象 + + } + } catch (JSONException e) { + Log.e(TAG, e.toString()); // 记录异常信息 + e.printStackTrace(); // 输出异常信息 + return null; // 返回 null + } + } + + /** + * 设置元数据信息。 + * + * @param metaData 元数据对象 + */ + public void setMetaInfo(MetaData metaData) { + if (metaData != null && metaData.getNotes() != null) { // 如果元数据不为空并且包含笔记信息 + try { + mMetaInfo = new JSONObject(metaData.getNotes()); // 将笔记信息转换为 JSON 对象并赋给成员变量 mMetaInfo + } catch (JSONException e) { + Log.w(TAG, e.toString()); // 记录警告日志 + mMetaInfo = null; // 转换失败时将 mMetaInfo 设为 null + } + } + } + + /** + * 根据游标信息获取同步操作动作。 + * + * @param c 数据库游标 + * @return 同步操作动作的整型值 + */ + public int getSyncAction(Cursor c) { + try { + JSONObject noteInfo = null; + if (mMetaInfo != null && mMetaInfo.has(GTaskStringUtils.META_HEAD_NOTE)) { // 检查元数据中是否包含笔记信息 + noteInfo = mMetaInfo.getJSONObject(GTaskStringUtils.META_HEAD_NOTE); // 获取笔记信息的 JSON 对象 + } + + if (noteInfo == null) { // 如果笔记信息为 null,表示笔记元数据被删除 + Log.w(TAG, "it seems that note meta has been deleted"); // 记录警告日志 + return SYNC_ACTION_UPDATE_REMOTE; // 返回更新远程的操作动作 + } + + if (!noteInfo.has(NoteColumns.ID)) { // 如果笔记信息中不包含 ID + Log.w(TAG, "remote note id seems to be deleted"); // 记录警告日志 + return SYNC_ACTION_UPDATE_LOCAL; // 返回更新本地的操作动作 + } + + // 验证笔记的 ID + if (c.getLong(SqlNote.ID_COLUMN) != noteInfo.getLong(NoteColumns.ID)) { // 如果数据库游标中的 ID 与笔记信息中的 ID 不匹配 + Log.w(TAG, "note id doesn't match"); // 记录警告日志 + return SYNC_ACTION_UPDATE_LOCAL; // 返回更新本地的操作动作 + } + + if (c.getInt(SqlNote.LOCAL_MODIFIED_COLUMN) == 0) { // 如果本地未有更新 + if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) { // 如果数据库游标中的最后修改时间与当前对象的最后修改时间相同 + return SYNC_ACTION_NONE; // 返回无操作的操作动作 + } else { + return SYNC_ACTION_UPDATE_LOCAL; // 返回更新本地的操作动作 + } + } else { + // 验证 GTask ID + if (!c.getString(SqlNote.GTASK_ID_COLUMN).equals(getGid())) { // 如果数据库游标中的 GTask ID 与当前对象的 GTask ID 不匹配 + Log.e(TAG, "gtask id doesn't match"); // 记录错误日志 + return SYNC_ACTION_ERROR; // 返回错误的操作动作 + } + if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) { // 如果数据库游标中的最后修改时间与当前对象的最后修改时间相同 + return SYNC_ACTION_UPDATE_REMOTE; // 返回更新远程的操作动作 + } else { + return SYNC_ACTION_UPDATE_CONFLICT; // 返回更新冲突的操作动作 + } + } + } catch (Exception e) { + Log.e(TAG, e.toString()); // 记录异常日志 + e.printStackTrace(); // 打印异常堆栈信息 + } + + return SYNC_ACTION_ERROR; // 返回错误的操作动作 + } + + /** + * 检查任务是否值得保存。 + * + * @return 如果任务值得保存返回 true,否则返回 false + */ + public boolean isWorthSaving() { + return mMetaInfo != null || (getName() != null && getName().trim().length() > 0) + || (getNotes() != null && getNotes().trim().length() > 0); // 判断任务是否值得保存的条件 + } + + /** + * 设置任务完成状态。 + * + * @param completed 完成状态 + */ + public void setCompleted(boolean completed) { + this.mCompleted = completed; + } + + /** + * 设置任务的笔记信息。 + * + * @param notes 笔记信息 + */ + public void setNotes(String notes) { + this.mNotes = notes; + } + + /** + * 设置任务的前一个兄弟节点。 + * + * @param priorSibling 前一个兄弟节点 + */ + public void setPriorSibling(Task priorSibling) { + this.mPriorSibling = priorSibling; + } + + /** + * 设置任务的父任务列表。 + * + * @param parent 父任务列表 + */ + public void setParent(TaskList parent) { + this.mParent = parent; + } + + /** + * 获取任务完成状态。 + * + * @return 任务完成状态 + */ + public boolean getCompleted() { + return this.mCompleted; + } + + /** + * 获取任务的笔记信息。 + * + * @return 任务的笔记信息 + */ + public String getNotes() { + return this.mNotes; + } + + /** + * 获取任务的前一个兄弟节点。 + * + * @return 任务的前一个兄弟节点 + */ + public Task getPriorSibling() { + return this.mPriorSibling; + } + + /** + * 获取任务的父任务列表。 + * + * @return 任务的父任务列表 + */ + public TaskList getParent() { + return this.mParent; + } + +} diff --git a/src/Notes-master/gtask/data/TaskList.java b/src/Notes-master/gtask/data/TaskList.java new file mode 100644 index 0000000..b8f7df1 --- /dev/null +++ b/src/Notes-master/gtask/data/TaskList.java @@ -0,0 +1,447 @@ +/* + * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net) + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package net.micode.notes.gtask.data; + +import android.database.Cursor; +import android.util.Log; + +import net.micode.notes.data.Notes; +import net.micode.notes.data.Notes.NoteColumns; +import net.micode.notes.gtask.exception.ActionFailureException; +import net.micode.notes.tool.GTaskStringUtils; + +import org.json.JSONException; +import org.json.JSONObject; + +import java.util.ArrayList; + + +/** + * 任务列表类,继承自节点类 + */ +public class TaskList extends Node { + private static final String TAG = TaskList.class.getSimpleName(); + + private int mIndex; // 任务列表的索引值 + + private ArrayList mChildren; // 子任务列表 + + /** + * 构造函数,初始化任务列表和索引值 + */ + public TaskList() { + super(); + mChildren = new ArrayList(); + mIndex = 1; + } + + /** + * 获取创建任务列表的操作 + * + * @param actionId 操作的 ID + * @return JSON 对象,包含创建任务列表的操作信息 + * @throws ActionFailureException 当生成任务列表创建 JSON 对象失败时抛出异常 + */ + public JSONObject getCreateAction(int actionId) throws ActionFailureException { + JSONObject js = new JSONObject(); + + try { + // action_type + js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, + GTaskStringUtils.GTASK_JSON_ACTION_TYPE_CREATE); + + // action_id + js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId); + + // index + js.put(GTaskStringUtils.GTASK_JSON_INDEX, mIndex); + + // entity_delta + JSONObject entity = new JSONObject(); + entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName()); + entity.put(GTaskStringUtils.GTASK_JSON_CREATOR_ID, "null"); + entity.put(GTaskStringUtils.GTASK_JSON_ENTITY_TYPE, + GTaskStringUtils.GTASK_JSON_TYPE_GROUP); + js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity); + + } catch (JSONException e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new ActionFailureException("fail to generate tasklist-create jsonobject"); + } + + return js; + } + /** + * 获取更新任务列表的操作 + * + * @param actionId 操作的 ID + * @return JSON 对象,包含更新任务列表的操作信息 + * @throws ActionFailureException 当生成任务列表更新 JSON 对象失败时抛出异常 + */ + public JSONObject getUpdateAction(int actionId) throws ActionFailureException { + JSONObject js = new JSONObject(); + + try { + // action_type + js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, + GTaskStringUtils.GTASK_JSON_ACTION_TYPE_UPDATE); + + // action_id + js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId); + + // id + js.put(GTaskStringUtils.GTASK_JSON_ID, getGid()); + + // entity_delta + JSONObject entity = new JSONObject(); + entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName()); + entity.put(GTaskStringUtils.GTASK_JSON_DELETED, getDeleted()); + js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity); + + } catch (JSONException e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new ActionFailureException("fail to generate tasklist-update jsonobject"); + } + + return js; + } + + /** + * 通过远程JSON设置任务列表的内容 + * + * @param js 远程传入的JSON对象 + */ + public void setContentByRemoteJSON(JSONObject js) { + if (js != null) { + try { + // 从JSON对象中获取任务列表的ID并设置 + if (js.has(GTaskStringUtils.GTASK_JSON_ID)) { + setGid(js.getString(GTaskStringUtils.GTASK_JSON_ID)); + } + + // 从JSON对象中获取任务列表的最后修改时间并设置 + if (js.has(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)) { + setLastModified(js.getLong(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)); + } + + // 从JSON对象中获取任务列表的名称并设置 + if (js.has(GTaskStringUtils.GTASK_JSON_NAME)) { + setName(js.getString(GTaskStringUtils.GTASK_JSON_NAME)); + } + + } catch (JSONException e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new ActionFailureException("fail to get tasklist content from jsonobject"); + } + } + } + + /** + * 通过本地JSON设置任务列表的内容 + * + * @param js 本地传入的JSON对象 + */ + public void setContentByLocalJSON(JSONObject js) { + if (js == null || !js.has(GTaskStringUtils.META_HEAD_NOTE)) { + Log.w(TAG, "setContentByLocalJSON: nothing is available"); + } + + try { + JSONObject folder = js.getJSONObject(GTaskStringUtils.META_HEAD_NOTE); + + if (folder.getInt(NoteColumns.TYPE) == Notes.TYPE_FOLDER) { + // 如果是文件夹类型的笔记,获取名称并设置为任务列表的名称 + String name = folder.getString(NoteColumns.SNIPPET); + setName(GTaskStringUtils.MIUI_FOLDER_PREFFIX + name); + } else if (folder.getInt(NoteColumns.TYPE) == Notes.TYPE_SYSTEM) { + // 如果是系统类型的笔记 + if (folder.getLong(NoteColumns.ID) == Notes.ID_ROOT_FOLDER) + setName(GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_DEFAULT); + else if (folder.getLong(NoteColumns.ID) == Notes.ID_CALL_RECORD_FOLDER) + setName(GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_CALL_NOTE); + else + Log.e(TAG, "invalid system folder"); + } else { + Log.e(TAG, "error type"); + } + } catch (JSONException e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + } + } + + /** + * 从任务列表内容获取本地JSON对象 + * + * @return 本地JSON对象 + */ + public JSONObject getLocalJSONFromContent() { + try { + JSONObject js = new JSONObject(); + JSONObject folder = new JSONObject(); + + String folderName = getName(); + if (getName().startsWith(GTaskStringUtils.MIUI_FOLDER_PREFFIX)) + folderName = folderName.substring(GTaskStringUtils.MIUI_FOLDER_PREFFIX.length(), folderName.length()); + + // 设置文件夹名称和类型到JSON对象中 + folder.put(NoteColumns.SNIPPET, folderName); + if (folderName.equals(GTaskStringUtils.FOLDER_DEFAULT) + || folderName.equals(GTaskStringUtils.FOLDER_CALL_NOTE)) + folder.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); + else + folder.put(NoteColumns.TYPE, Notes.TYPE_FOLDER); + + js.put(GTaskStringUtils.META_HEAD_NOTE, folder); + + return js; + } catch (JSONException e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + return null; + } + } + + /** + * 获取同步操作类型 + * + * @param c 游标对象,用于获取数据库中的字段值 + * @return 同步操作类型 + */ + public int getSyncAction(Cursor c) { + try { + if (c.getInt(SqlNote.LOCAL_MODIFIED_COLUMN) == 0) { + // 没有本地更新 + if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) { + // 两边都没有更新 + return SYNC_ACTION_NONE; + } else { + // 应用远程更新到本地 + return SYNC_ACTION_UPDATE_LOCAL; + } + } else { + // 验证 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()) { + // 只有本地修改 + return SYNC_ACTION_UPDATE_REMOTE; + } else { + // 对于文件夹冲突,只应用本地修改 + return SYNC_ACTION_UPDATE_REMOTE; + } + } + } catch (Exception e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + } + + return SYNC_ACTION_ERROR; + } + + public int getChildTaskCount() { + return mChildren.size(); + } + + /** + * 添加子任务 + * + * @param task 要添加的子任务 + * @return 添加成功返回 true,否则返回 false + */ + public boolean addChildTask(Task task) { + boolean ret = false; + if (task != null && !mChildren.contains(task)) { + ret = mChildren.add(task); + if (ret) { + // 需要设置前一个兄弟和父任务 + task.setPriorSibling(mChildren.isEmpty() ? null : mChildren.get(mChildren.size() - 1)); + task.setParent(this); + } + } + return ret; + } + /** + * 添加指定位置的子任务 + * + * @param task 要添加的子任务 + * @param index 要添加的位置 + * @return 添加成功返回 true,否则返回 false + */ + public boolean addChildTask(Task task, int index) { + if (index < 0 || index > mChildren.size()) { + Log.e(TAG, "add child task: invalid index"); + return false; + } + + int pos = mChildren.indexOf(task); + if (task != null && pos == -1) { + mChildren.add(index, task); + + // 更新任务列表 + Task preTask = null; + Task afterTask = null; + if (index != 0) + preTask = mChildren.get(index - 1); + if (index != mChildren.size() - 1) + afterTask = mChildren.get(index + 1); + + task.setPriorSibling(preTask); + if (afterTask != null) + afterTask.setPriorSibling(task); + } + + return true; + } + + /** + * 移除子任务 + * + * @param task 要移除的子任务 + * @return 移除成功返回 true,否则返回 false + */ + public boolean removeChildTask(Task task) { + boolean ret = false; + int index = mChildren.indexOf(task); + if (index != -1) { + ret = mChildren.remove(task); + + if (ret) { + // 重置前一个兄弟和父任务 + task.setPriorSibling(null); + task.setParent(null); + + // 更新任务列表 + if (index != mChildren.size()) { + mChildren.get(index).setPriorSibling(index == 0 ? null : mChildren.get(index - 1)); + } + } + } + return ret; + } + + /** + * 移动子任务到指定位置 + * + * @param task 要移动的子任务 + * @param index 目标位置 + * @return 移动成功返回 true,否则返回 false + */ + public boolean moveChildTask(Task task, int index) { + + if (index < 0 || index >= mChildren.size()) { + Log.e(TAG, "move child task: invalid index"); + return false; + } + + int pos = mChildren.indexOf(task); + if (pos == -1) { + Log.e(TAG, "move child task: the task should be in the list"); + return false; + } + + if (pos == index) + return true; + return (removeChildTask(task) && addChildTask(task, index)); + } + + /** + * 根据 gid 查找子任务 + * + * @param gid 子任务的 gid + * @return 找到的子任务,如果不存在则返回 null + */ + public Task findChildTaskByGid(String gid) { + for (int i = 0; i < mChildren.size(); i++) { + Task t = mChildren.get(i); + if (t.getGid().equals(gid)) { + return t; + } + } + return null; + } + + /** + * 获取子任务在列表中的索引 + * + * @param task 子任务 + * @return 子任务在列表中的索引,如果不存在则返回 -1 + */ + public int getChildTaskIndex(Task task) { + return mChildren.indexOf(task); + } + + /** + * 根据索引获取子任务 + * + * @param index 索引 + * @return 索引对应的子任务,如果索引无效则返回 null + */ + public Task getChildTaskByIndex(int index) { + if (index < 0 || index >= mChildren.size()) { + Log.e(TAG, "getTaskByIndex: invalid index"); + return null; + } + return mChildren.get(index); + } + + /** + * 根据 gid 获取子任务 + * + * @param gid 子任务的 gid + * @return 找到的子任务,如果不存在则返回 null + */ + public Task getChildTaskByGid(String gid) { + for (Task task : mChildren) { + if (task.getGid().equals(gid)) + return task; + } + return null; + } + + /** + * 获取子任务列表 + * + * @return 子任务列表 + */ + public ArrayList getChildTaskList() { + return this.mChildren; + } + + /** + * 设置索引 + * + * @param index 索引 + */ + public void setIndex(int index) { + this.mIndex = index; + } + + /** + * 获取索引 + * + * @return 索引 + */ + public int getIndex() { + return this.mIndex; + } +} diff --git a/src/Notes-master/gtask/exception/ActionFailureException.java b/src/Notes-master/gtask/exception/ActionFailureException.java new file mode 100644 index 0000000..c6e0637 --- /dev/null +++ b/src/Notes-master/gtask/exception/ActionFailureException.java @@ -0,0 +1,53 @@ +/* + * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net) + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package net.micode.notes.gtask.exception; + +/** + * 表示操作失败的异常类 + */ +public class ActionFailureException extends RuntimeException { + /** + * 用于版本控制的序列化 ID + */ + private static final long serialVersionUID = 4425249765923293627L; + + /** + * 构造一个新的 ActionFailureException,不带详细信息 + */ + public ActionFailureException() { + super(); + } + + /** + * 构造一个新的 ActionFailureException,带详细信息 + * + * @param paramString 异常详细信息 + */ + public ActionFailureException(String paramString) { + super(paramString); + } + + /** + * 构造一个新的 ActionFailureException,带详细信息和原始异常 + * + * @param paramString 异常详细信息 + * @param paramThrowable 原始异常 + */ + public ActionFailureException(String paramString, Throwable paramThrowable) { + super(paramString, paramThrowable); + } +} \ No newline at end of file diff --git a/src/Notes-master/gtask/exception/NetworkFailureException.java b/src/Notes-master/gtask/exception/NetworkFailureException.java new file mode 100644 index 0000000..4fa2c73 --- /dev/null +++ b/src/Notes-master/gtask/exception/NetworkFailureException.java @@ -0,0 +1,53 @@ +/* + * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net) + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package net.micode.notes.gtask.exception; + +/** + * 表示网络操作失败的异常类 + */ +public class NetworkFailureException extends Exception { + /** + * 用于版本控制的序列化 ID + */ + private static final long serialVersionUID = 2107610287180234136L; + + /** + * 构造一个新的 NetworkFailureException,不带详细信息 + */ + public NetworkFailureException() { + super(); + } + + /** + * 构造一个新的 NetworkFailureException,带详细信息 + * + * @param paramString 异常详细信息 + */ + public NetworkFailureException(String paramString) { + super(paramString); + } + + /** + * 构造一个新的 NetworkFailureException,带详细信息和原始异常 + * + * @param paramString 异常详细信息 + * @param paramThrowable 原始异常 + */ + public NetworkFailureException(String paramString, Throwable paramThrowable) { + super(paramString, paramThrowable); + } +} diff --git a/src/Notes-master/gtask/remote/GTaskASyncTask.java b/src/Notes-master/gtask/remote/GTaskASyncTask.java new file mode 100644 index 0000000..c166129 --- /dev/null +++ b/src/Notes-master/gtask/remote/GTaskASyncTask.java @@ -0,0 +1,169 @@ + +/* + * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net) + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package net.micode.notes.gtask.remote; + +import android.app.Notification; +import android.app.NotificationManager; +import android.app.PendingIntent; +import android.content.Context; +import android.content.Intent; +import android.os.AsyncTask; + +import net.micode.notes.R; +import net.micode.notes.ui.NotesListActivity; +import net.micode.notes.ui.NotesPreferenceActivity; + +/** + * 用于执行GTask异步任务的类,继承自AsyncTask。 + */ +public class GTaskASyncTask extends AsyncTask { + + private static int GTASK_SYNC_NOTIFICATION_ID = 5234235; // GTask同步通知ID + + /** + * 完成监听器接口 + */ + public interface OnCompleteListener { + void onComplete(); + } + + private Context mContext;// 上下文对象 + + private NotificationManager mNotifiManager;// 通知管理器 + + private GTaskManager mTaskManager;// GTask管理器 + + private OnCompleteListener mOnCompleteListener;// 完成监听器对象 + + /** + * 构造一个新的GTaskASyncTask对象 + * + * @param context 上下文对象 + * @param listener 完成监听器 + */ + public GTaskASyncTask(Context context, OnCompleteListener listener) { + mContext = context; + mOnCompleteListener = listener; + mNotifiManager = (NotificationManager) mContext.getSystemService(Context.NOTIFICATION_SERVICE); + mTaskManager = GTaskManager.getInstance(); + } + + public void cancelSync() { + mTaskManager.cancelSync(); + } + + public void publishProgess(String message) { + publishProgress(new String[] { + message + }); + } + + /** + * 显示通知 + * + * @param tickerId 通知ID + * @param content 通知内容 + */ + 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; + // 如果通知ID不是成功通知的ID + if (tickerId != R.string.ticker_success) { + // 创建一个启动设置偏好活动的PendingIntent + pendingIntent = PendingIntent.getActivity(mContext, 0, + new Intent(mContext, NotesPreferenceActivity.class), 0); + } else { + // 创建一个启动笔记列表活动的PendingIntent + 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); + } + + /** + * 执行后台任务 + * + * @param unused 未使用的参数 + * @return 任务执行结果 + */ + @Override + protected Integer doInBackground(Void... unused) { + // 发布登录同步进度消息 + publishProgess(mContext.getString(R.string.sync_progress_login, + NotesPreferenceActivity.getSyncAccountName(mContext))); + // 执行同步任务并返回结果 + return mTaskManager.sync(mContext, this); + } + + /** + * 更新进度时的处理 + * + * @param progress 进度消息 + */ + @Override + protected void onProgressUpdate(String... progress) { + // 显示同步中通知 + showNotification(R.string.ticker_syncing, progress[0]); + // 如果上下文是GTaskSyncService的实例,发送广播 + if (mContext instanceof GTaskSyncService) { + ((GTaskSyncService) mContext).sendBroadcast(progress[0]); + } + } + + /** + * 后台任务执行完成时的处理 + * + * @param result 执行结果 + */ + @Override + protected void onPostExecute(Integer result) { + if (result == GTaskManager.STATE_SUCCESS) { + // 显示成功通知 + showNotification(R.string.ticker_success, mContext.getString( + R.string.success_sync_account, mTaskManager.getSyncAccount())); + // 设置最后同步时间 + NotesPreferenceActivity.setLastSyncTime(mContext, System.currentTimeMillis()); + } else if (result == GTaskManager.STATE_NETWORK_ERROR) { + // 显示网络错误通知 + showNotification(R.string.ticker_fail, mContext.getString(R.string.error_sync_network)); + } else if (result == GTaskManager.STATE_INTERNAL_ERROR) { + // 显示内部错误通知 + showNotification(R.string.ticker_fail, mContext.getString(R.string.error_sync_internal)); + } else if (result == GTaskManager.STATE_SYNC_CANCELLED) { + // 显示同步取消通知 + showNotification(R.string.ticker_cancel, mContext.getString(R.string.error_sync_cancelled)); + } + // 如果存在完成监听器,则在新线程中执行完成操作 + if (mOnCompleteListener != null) { + new Thread(new Runnable() { + public void run() { + mOnCompleteListener.onComplete(); + } + }).start(); + } + } +} diff --git a/src/Notes-master/gtask/remote/GTaskClient.java b/src/Notes-master/gtask/remote/GTaskClient.java new file mode 100644 index 0000000..266bf46 --- /dev/null +++ b/src/Notes-master/gtask/remote/GTaskClient.java @@ -0,0 +1,724 @@ +/* + * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net) + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package net.micode.notes.gtask.remote; + +import android.accounts.Account; +import android.accounts.AccountManager; +import android.accounts.AccountManagerFuture; +import android.app.Activity; +import android.os.Bundle; +import android.text.TextUtils; +import android.util.Log; + +import net.micode.notes.gtask.data.Node; +import net.micode.notes.gtask.data.Task; +import net.micode.notes.gtask.data.TaskList; +import net.micode.notes.gtask.exception.ActionFailureException; +import net.micode.notes.gtask.exception.NetworkFailureException; +import net.micode.notes.tool.GTaskStringUtils; +import net.micode.notes.ui.NotesPreferenceActivity; + +import org.apache.http.HttpEntity; +import org.apache.http.HttpResponse; +import org.apache.http.client.ClientProtocolException; +import org.apache.http.client.entity.UrlEncodedFormEntity; +import org.apache.http.client.methods.HttpGet; +import org.apache.http.client.methods.HttpPost; +import org.apache.http.cookie.Cookie; +import org.apache.http.impl.client.BasicCookieStore; +import org.apache.http.impl.client.DefaultHttpClient; +import org.apache.http.message.BasicNameValuePair; +import org.apache.http.params.BasicHttpParams; +import org.apache.http.params.HttpConnectionParams; +import org.apache.http.params.HttpParams; +import org.apache.http.params.HttpProtocolParams; +import org.json.JSONArray; +import org.json.JSONException; +import org.json.JSONObject; + +import java.io.BufferedReader; +import java.io.IOException; +import java.io.InputStream; +import java.io.InputStreamReader; +import java.util.LinkedList; +import java.util.List; +import java.util.zip.GZIPInputStream; +import java.util.zip.Inflater; +import java.util.zip.InflaterInputStream; + + +/** + * GTaskClient类,用于管理Google任务的客户端 + */ +public class GTaskClient { + // 日志标签 + private static final String TAG = GTaskClient.class.getSimpleName(); + + // Google任务的基础URL + private static final String GTASK_URL = "https://mail.google.com/tasks/"; + + // 获取Google任务的URL + private static final String GTASK_GET_URL = "https://mail.google.com/tasks/ig"; + + // 提交Google任务的URL + private static final String GTASK_POST_URL = "https://mail.google.com/tasks/r/ig"; + + // GTaskClient的单例实例 + private static GTaskClient mInstance = null; + + // 默认的HTTP客户端 + private DefaultHttpClient mHttpClient; + + // 获取任务的URL + private String mGetUrl; + + // 提交任务的URL + private String mPostUrl; + + // 客户端版本号 + private long mClientVersion; + + // 登录状态 + private boolean mLoggedin; + + // 上次登录时间 + private long mLastLoginTime; + + // 操作ID + private int mActionId; + + // 账户信息 + private Account mAccount; + + // 待更新的任务数组 + private JSONArray mUpdateArray; + /** + * 私有构造函数,初始化GTaskClient的实例 + */ + private GTaskClient() { + mHttpClient = null; // HTTP客户端 + mGetUrl = GTASK_GET_URL; // 获取任务的URL + mPostUrl = GTASK_POST_URL; // 提交任务的URL + mClientVersion = -1; // 客户端版本号 + mLoggedin = false; // 登录状态 + mLastLoginTime = 0; // 上次登录时间 + mActionId = 1; // 操作ID + mAccount = null; // 账户信息 + mUpdateArray = null; // 待更新的任务数组 + } + + /** + * 获取GTaskClient的单例实例 + * + * @return GTaskClient的单例实例 + */ + public static synchronized GTaskClient getInstance() { + if (mInstance == null) { + mInstance = new GTaskClient(); + } + return mInstance; + } + + /** + * 登录Google账户 + * + * @param activity 当前Activity + * @return 登录成功返回true,否则返回false + */ + public boolean login(Activity activity) { + // 假设cookie在5分钟后过期,需要重新登录 + final long interval = 1000 * 60 * 5; + if (mLastLoginTime + interval < System.currentTimeMillis()) { + mLoggedin = false; + } + + // 如果账户切换,则需要重新登录 + if (mLoggedin && !TextUtils.equals(getSyncAccount().name, NotesPreferenceActivity.getSyncAccountName(activity))) { + mLoggedin = false; + } + + if (mLoggedin) { + Log.d(TAG, "already logged in"); + return true; + } + + mLastLoginTime = System.currentTimeMillis(); + String authToken = loginGoogleAccount(activity, false); + if (authToken == null) { + Log.e(TAG, "login google account failed"); + return false; + } + + // 如果是自定义域名,则使用自定义域名登录 + if (!(mAccount.name.toLowerCase().endsWith("gmail.com") || mAccount.name.toLowerCase().endsWith("googlemail.com"))) { + StringBuilder url = new StringBuilder(GTASK_URL).append("a/"); + int index = mAccount.name.indexOf('@') + 1; + String suffix = mAccount.name.substring(index); + url.append(suffix + "/"); + mGetUrl = url.toString() + "ig"; + mPostUrl = url.toString() + "r/ig"; + + if (tryToLoginGtask(activity, authToken)) { + mLoggedin = true; + } + } + + // 尝试使用Google官方的URL进行登录 + if (!mLoggedin) { + mGetUrl = GTASK_GET_URL; + mPostUrl = GTASK_POST_URL; + if (!tryToLoginGtask(activity, authToken)) { + return false; + } + } + + mLoggedin = true; + return true; + } + + /** + * 登录Google账户 + * + * @param activity 当前Activity + * @param invalidateToken 是否使token无效 + * @return 返回登录成功后的authToken,如果失败返回null + */ + private String loginGoogleAccount(Activity activity, boolean invalidateToken) { + String authToken; + AccountManager accountManager = AccountManager.get(activity); + 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) { + if (a.name.equals(accountName)) { + account = a; + break; + } + } + if (account != null) { + mAccount = account; + } else { + Log.e(TAG, "unable to get an account with the same name in the settings"); + return null; + } + + // 获取token + AccountManagerFuture accountManagerFuture = accountManager.getAuthToken(account, "goanna_mobile", null, activity, null, null); + try { + Bundle authTokenBundle = accountManagerFuture.getResult(); + authToken = authTokenBundle.getString(AccountManager.KEY_AUTHTOKEN); + if (invalidateToken) { + accountManager.invalidateAuthToken("com.google", authToken); + // 使token无效后再次尝试登录 + loginGoogleAccount(activity, false); + } + } catch (Exception e) { + Log.e(TAG, "get auth token failed"); + authToken = null; + } + + return authToken; + } + + /** + * 尝试登录Gtask + * + * @param activity 当前Activity + * @param authToken 要使用的authToken + * @return 登录成功返回true,否则返回false + */ + private boolean tryToLoginGtask(Activity activity, String authToken) { + if (!loginGtask(authToken)) { + // 可能authToken已过期,现在让我们使token失效并重新尝试登录 + authToken = loginGoogleAccount(activity, true); + if (authToken == null) { + Log.e(TAG, "login google account failed"); + return false; + } + + if (!loginGtask(authToken)) { + Log.e(TAG, "login gtask failed"); + return false; + } + } + return true; + } + + /** + * 登录GTask + * + * @param authToken 要使用的authToken + * @return 登录成功返回true,否则返回false + */ + private boolean loginGtask(String authToken) { + int timeoutConnection = 10000; + int timeoutSocket = 15000; + + // 设置HTTP连接和等待超时参数 + HttpParams httpParameters = new BasicHttpParams(); + HttpConnectionParams.setConnectionTimeout(httpParameters, timeoutConnection); + HttpConnectionParams.setSoTimeout(httpParameters, timeoutSocket); + + // 创建HttpClient并设置Cookie存储 + mHttpClient = new DefaultHttpClient(httpParameters); + BasicCookieStore localBasicCookieStore = new BasicCookieStore(); + mHttpClient.setCookieStore(localBasicCookieStore); + HttpProtocolParams.setUseExpectContinue(mHttpClient.getParams(), false); + + // 登录GTask + try { + String loginUrl = mGetUrl + "?auth=" + authToken; + HttpGet httpGet = new HttpGet(loginUrl); + HttpResponse response = null; + response = mHttpClient.execute(httpGet); + + // 获取Cookie + List cookies = mHttpClient.getCookieStore().getCookies(); + boolean hasAuthCookie = false; + for (Cookie cookie : cookies) { + if (cookie.getName().contains("GTL")) { + hasAuthCookie = true; + } + } + if (!hasAuthCookie) { + Log.w(TAG, "it seems that there is no auth cookie"); + } + + // 获取客户端版本 + String resString = getResponseContent(response.getEntity()); + String jsBegin = "_setup("; + String jsEnd = ")}"; + int begin = resString.indexOf(jsBegin); + int end = resString.lastIndexOf(jsEnd); + String jsString = null; + if (begin != -1 && end != -1 && begin < end) { + jsString = resString.substring(begin + jsBegin.length(), end); + } + JSONObject js = new JSONObject(jsString); + mClientVersion = js.getLong("v"); + } catch (JSONException e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + return false; + } catch (Exception e) { + // 捕获所有异常 + Log.e(TAG, "httpget gtask_url failed"); + return false; + } + + return true; + } + + private int getActionId() { + return mActionId++; + } + + 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响应内容 + * + * @param entity 响应实体对象 + * @return 响应内容字符串 + * @throws IOException 当读取响应内容时出现IO异常 + */ + private String getResponseContent(HttpEntity entity) throws IOException { + // 获取内容的编码方式 + String contentEncoding = null; + if (entity.getContentEncoding() != null) { + contentEncoding = entity.getContentEncoding().getValue(); + Log.d(TAG, "encoding: " + contentEncoding); + } + + // 获取响应内容的输入流 + InputStream input = entity.getContent(); + // 根据编码方式解压缩输入流 + if (contentEncoding != null && contentEncoding.equalsIgnoreCase("gzip")) { + input = new GZIPInputStream(entity.getContent()); + } else if (contentEncoding != null && contentEncoding.equalsIgnoreCase("deflate")) { + Inflater inflater = new Inflater(true); + input = new InflaterInputStream(entity.getContent(), inflater); + } + + try { + InputStreamReader isr = new InputStreamReader(input); + BufferedReader br = new BufferedReader(isr); + StringBuilder sb = new StringBuilder(); + + // 逐行读取响应内容并拼接为字符串 + while (true) { + String buff = br.readLine(); + if (buff == null) { + return sb.toString(); + } + sb = sb.append(buff); + } + } finally { + // 关闭输入流 + input.close(); + } + } + + /** + * 发起POST请求并获取JSON格式的响应 + * + * @param js 待发送的JSON对象 + * @return 服务器响应的JSON对象 + * @throws NetworkFailureException 当网络操作失败时抛出此异常 + */ + private JSONObject postRequest(JSONObject js) throws NetworkFailureException { + // 检查是否已登录 + if (!mLoggedin) { + Log.e(TAG, "please login first"); + throw new ActionFailureException("not logged in"); + } + + // 创建HTTP POST请求 + HttpPost httpPost = createHttpPost(); + try { + // 将JSON对象添加到POST请求中的参数中 + LinkedList list = new LinkedList(); + list.add(new BasicNameValuePair("r", js.toString())); + UrlEncodedFormEntity entity = new UrlEncodedFormEntity(list, "UTF-8"); + httpPost.setEntity(entity); + + // 执行POST请求 + HttpResponse response = mHttpClient.execute(httpPost); + // 获取响应内容并转换为JSON对象 + String jsString = getResponseContent(response.getEntity()); + return new JSONObject(jsString); + + } catch (ClientProtocolException e) { + // 客户端协议异常,通常是因为无效的HTTP协议 + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new NetworkFailureException("postRequest failed"); + } catch (IOException e) { + // IO异常,包括网络连接问题等 + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new NetworkFailureException("postRequest failed"); + } catch (JSONException e) { + // JSON解析异常 + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new ActionFailureException("unable to convert response content to jsonobject"); + } catch (Exception e) { + // 其他异常 + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new ActionFailureException("error occurs when posting request"); + } + } + + /** + * 创建任务 + * + * @param task 待创建的任务对象 + * @throws NetworkFailureException 当网络操作失败时抛出此异常 + */ + public void createTask(Task task) throws NetworkFailureException { + // 提交更新 + commitUpdate(); + try { + // 创建POST请求的JSON对象 + JSONObject jsPost = new JSONObject(); + JSONArray actionList = new JSONArray(); + + // 添加任务的创建动作到action_list中 + actionList.put(task.getCreateAction(getActionId())); + jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, actionList); + + // 添加客户端版本号 + jsPost.put(GTaskStringUtils.GTASK_JSON_CLIENT_VERSION, mClientVersion); + + // 发起POST请求 + JSONObject jsResponse = postRequest(jsPost); + + // 处理响应数据 + JSONObject jsResult = (JSONObject) jsResponse.getJSONArray( + GTaskStringUtils.GTASK_JSON_RESULTS).get(0); + task.setGid(jsResult.getString(GTaskStringUtils.GTASK_JSON_NEW_ID)); + + } catch (JSONException e) { + // JSON解析异常 + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new ActionFailureException("create task: handling jsonobject failed"); + } + } + /** + * 创建任务列表 + * + * @param tasklist 待创建的任务列表对象 + * @throws NetworkFailureException 当网络操作失败时抛出此异常 + */ + public void createTaskList(TaskList tasklist) throws NetworkFailureException { + // 提交更新 + commitUpdate(); + try { + // 创建POST请求的JSON对象 + JSONObject jsPost = new JSONObject(); + JSONArray actionList = new JSONArray(); + + // 添加任务列表的创建动作到action_list中 + actionList.put(tasklist.getCreateAction(getActionId())); + jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, actionList); + + // 添加客户端版本号 + jsPost.put(GTaskStringUtils.GTASK_JSON_CLIENT_VERSION, mClientVersion); + + // 发起POST请求 + JSONObject jsResponse = postRequest(jsPost); + + // 处理响应数据 + JSONObject jsResult = (JSONObject) jsResponse.getJSONArray( + GTaskStringUtils.GTASK_JSON_RESULTS).get(0); + tasklist.setGid(jsResult.getString(GTaskStringUtils.GTASK_JSON_NEW_ID)); + + } catch (JSONException e) { + // JSON解析异常 + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new ActionFailureException("create tasklist: handling jsonobject failed"); + } + } + + /** + * 提交更新 + * @throws NetworkFailureException 当网络操作失败时抛出此异常 + */ + public void commitUpdate() throws NetworkFailureException { + if (mUpdateArray != null) { + try { + JSONObject jsPost = new JSONObject(); + + // 添加更新操作数组到action_list中 + jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, mUpdateArray); + + // 添加客户端版本号 + jsPost.put(GTaskStringUtils.GTASK_JSON_CLIENT_VERSION, mClientVersion); + + // 发起POST请求 + postRequest(jsPost); + mUpdateArray = null; + } catch (JSONException e) { + // JSON解析异常 + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new ActionFailureException("commit update: handling jsonobject failed"); + } + } + } + /** + * 添加更新节点 + * @param node 待添加的更新节点对象 + * @throws NetworkFailureException 当网络操作失败时抛出此异常 + */ + public void addUpdateNode(Node node) throws NetworkFailureException { + if (node != null) { + // 处理更新操作数组长度超过限制的情况 + // 最大限制为10个 + if (mUpdateArray != null && mUpdateArray.length() > 10) { + commitUpdate(); + } + + if (mUpdateArray == null) + mUpdateArray = new JSONArray(); + + // 添加更新操作到更新操作数组中 + mUpdateArray.put(node.getUpdateAction(getActionId())); + } + } + + /** + * 移动任务到指定的任务列表 + * @param task 待移动的任务对象 + * @param preParent 移动前的父任务列表 + * @param curParent 移动后的父任务列表 + * @throws NetworkFailureException 当网络操作失败时抛出此异常 + */ + 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.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()); + + // 判断是否在同一个任务列表内移动,并且不是第一个任务 + // 只在这种情况下添加prior_sibing_id参数 + if (preParent == curParent && task.getPriorSibling() != null) { + action.put(GTaskStringUtils.GTASK_JSON_PRIOR_SIBLING_ID, task.getPriorSibling()); + } + + action.put(GTaskStringUtils.GTASK_JSON_SOURCE_LIST, preParent.getGid()); + action.put(GTaskStringUtils.GTASK_JSON_DEST_PARENT, curParent.getGid()); + + // 判断是否在不同的任务列表之间移动 + // 只在这种情况下添加dest_list参数 + if (preParent != curParent) { + action.put(GTaskStringUtils.GTASK_JSON_DEST_LIST, curParent.getGid()); + } + actionList.put(action); + jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, actionList); + + // 添加客户端版本号 + jsPost.put(GTaskStringUtils.GTASK_JSON_CLIENT_VERSION, mClientVersion); + + // 发起POST请求 + postRequest(jsPost); + + } catch (JSONException e) { + // JSON解析异常 + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new ActionFailureException("move task: handling jsonobject failed"); + } + } + + /** + * 删除节点 + * @param node 待删除的节点对象 + * @throws NetworkFailureException 当网络操作失败时抛出此异常 + */ + public void deleteNode(Node node) throws NetworkFailureException { + commitUpdate(); // 提交已有的更新操作 + try { + JSONObject jsPost = new JSONObject(); + JSONArray actionList = new JSONArray(); + + // 设置节点删除状态并添加删除操作到操作列表中 + node.setDeleted(true); + actionList.put(node.getUpdateAction(getActionId())); + jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, actionList); // 设置操作列表 + + // 设置客户端版本号 + jsPost.put(GTaskStringUtils.GTASK_JSON_CLIENT_VERSION, mClientVersion); + + // 发起POST请求 + postRequest(jsPost); + mUpdateArray = null; // 清空更新操作数组 + } catch (JSONException e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new ActionFailureException("delete node: handing jsonobject failed"); // 处理JSON对象失败时抛出异常 + } + } + + /** + * 获取任务列表 + * @return 任务列表的JSONArray + * @throws NetworkFailureException 当网络操作失败时抛出此异常 + */ + public JSONArray getTaskLists() throws NetworkFailureException { + if (!mLoggedin) { + Log.e(TAG, "please login first"); + throw new ActionFailureException("not logged in"); + } + + // 发起HttpGet请求获取任务列表 + try { + HttpGet httpGet = new HttpGet(mGetUrl); + HttpResponse response = mHttpClient.execute(httpGet); + + // 解析响应内容并获取任务列表 + String resString = getResponseContent(response.getEntity()); + String jsBegin = "_setup("; + String jsEnd = ")}"; + int begin = resString.indexOf(jsBegin); + int end = resString.lastIndexOf(jsEnd); + String jsString = null; + if (begin != -1 && end != -1 && begin < end) { + jsString = resString.substring(begin + jsBegin.length(), end); + } + JSONObject js = new JSONObject(jsString); + return js.getJSONObject("t").getJSONArray(GTaskStringUtils.GTASK_JSON_LISTS); + } catch (ClientProtocolException e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new NetworkFailureException("gettasklists: httpget failed"); + } catch (IOException e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new NetworkFailureException("gettasklists: httpget failed"); + } catch (JSONException e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new ActionFailureException("get task lists: handing jasonobject failed"); // 处理JSON对象失败时抛出异常 + } + } + + /** + * 获取任务列表 + * + * @param listGid 列表的唯一标识符 + * @return 任务列表的JSONArray + * @throws NetworkFailureException 当网络操作失败时抛出此异常 + */ + public JSONArray getTaskList(String listGid) throws NetworkFailureException { + commitUpdate(); // 提交已有的更新操作 + try { + JSONObject jsPost = new JSONObject(); // 创建请求JSON对象 + JSONArray actionList = new JSONArray(); // 创建操作列表JSON数组 + JSONObject action = new JSONObject(); // 创建操作JSON对象 + + // 设置操作类型和其他参数,并将操作对象添加到操作列表中 + 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); // 设置操作列表到请求JSON对象中 + + jsPost.put(GTaskStringUtils.GTASK_JSON_CLIENT_VERSION, mClientVersion); // 设置客户端版本号 + + JSONObject jsResponse = postRequest(jsPost); // 发起POST请求并获取响应 + return jsResponse.getJSONArray(GTaskStringUtils.GTASK_JSON_TASKS); // 从响应中获取任务列表JSONArray + } catch (JSONException e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new ActionFailureException("get task list: handing jsonobject failed"); // 处理JSON对象失败时抛出异常 + } + } + + public Account getSyncAccount() { + return mAccount; + } + + public void resetUpdateArray() { + mUpdateArray = null; + } +} diff --git a/src/Notes-master/gtask/remote/GTaskManager.java b/src/Notes-master/gtask/remote/GTaskManager.java new file mode 100644 index 0000000..3be9cf9 --- /dev/null +++ b/src/Notes-master/gtask/remote/GTaskManager.java @@ -0,0 +1,896 @@ +/* + * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net) + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package net.micode.notes.gtask.remote; + +import android.app.Activity; +import android.content.ContentResolver; +import android.content.ContentUris; +import android.content.ContentValues; +import android.content.Context; +import android.database.Cursor; +import android.util.Log; + +import net.micode.notes.R; +import net.micode.notes.data.Notes; +import net.micode.notes.data.Notes.DataColumns; +import net.micode.notes.data.Notes.NoteColumns; +import net.micode.notes.gtask.data.MetaData; +import net.micode.notes.gtask.data.Node; +import net.micode.notes.gtask.data.SqlNote; +import net.micode.notes.gtask.data.Task; +import net.micode.notes.gtask.data.TaskList; +import net.micode.notes.gtask.exception.ActionFailureException; +import net.micode.notes.gtask.exception.NetworkFailureException; +import net.micode.notes.tool.DataUtils; +import net.micode.notes.tool.GTaskStringUtils; + +import org.json.JSONArray; +import org.json.JSONException; +import org.json.JSONObject; + +import java.util.HashMap; +import java.util.HashSet; +import java.util.Iterator; +import java.util.Map; + + +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; + public static final int STATE_INTERNAL_ERROR = 2; + public static final int STATE_SYNC_IN_PROGRESS = 3; + public static final int STATE_SYNC_CANCELLED = 4; + + // 单例实例 + private static GTaskManager mInstance = null; + + // 当前的Activity + private Activity mActivity; + + // 应用程序的上下文 + private Context mContext; + + // 用于访问应用程序的数据存储 + private ContentResolver mContentResolver; + + // 指示是否正在进行同步 + private boolean mSyncing; + + // 指示同步是否被取消 + private boolean mCancelled; + + // 已同步的任务列表的哈希映射 + private HashMap mGTaskListHashMap; + + // 已同步的任务的哈希映射 + private HashMap mGTaskHashMap; + + // 任务元数据的哈希映射 + private HashMap mMetaHashMap; + + // 元数据列表 + private TaskList mMetaList; + + // 本地已删除任务的ID集合 + private HashSet mLocalDeleteIdMap; + + // Google任务ID到本地任务ID的映射 + private HashMap mGidToNid; + + // 本地任务ID到Google任务ID的映射 + private HashMap mNidToGid; + + // 私有构造函数 + private GTaskManager() { + mSyncing = false; + mCancelled = false; + mGTaskListHashMap = new HashMap(); + mGTaskHashMap = new HashMap(); + mMetaHashMap = new HashMap(); + mMetaList = null; + mLocalDeleteIdMap = new HashSet(); + mGidToNid = new HashMap(); + mNidToGid = new HashMap(); + } + + // 获取GTaskManager的单例实例 + public static synchronized GTaskManager getInstance() { + if (mInstance == null) { + mInstance = new GTaskManager(); + } + return mInstance; + } + + public synchronized void setActivityContext(Activity activity) { + // 用于获取 auth token 的活动上下文 + mActivity = activity; + } + + // 同步方法,用于同步数据 + public int sync(Context context, GTaskASyncTask asyncTask) { + if (mSyncing) { + Log.d(TAG, "Sync is in progress"); // 打印日志,表示同步正在进行中 + return STATE_SYNC_IN_PROGRESS; // 返回同步状态为进行中 + } + mContext = context; + mContentResolver = mContext.getContentResolver(); + mSyncing = true; // 设置同步标志为 true + mCancelled = false; // 设置取消标志为 false + mGTaskListHashMap.clear(); // 清除任务列表哈希图 + mGTaskHashMap.clear(); // 清除任务哈希图 + mMetaHashMap.clear(); // 清除元数据哈希图 + mLocalDeleteIdMap.clear(); // 清除本地删除 id 映射 + mGidToNid.clear(); // 清除 gid 到 nid 的映射 + mNidToGid.clear(); // 清除 nid 到 gid 的映射 + + try { + GTaskClient client = GTaskClient.getInstance(); + client.resetUpdateArray(); // 重置更新数组 + + // 登录 Google 任务 + if (!mCancelled) { + if (!client.login(mActivity)) { // 如果登录任务失败 + throw new NetworkFailureException("login google task failed"); // 抛出网络失败异常 + } + } + + // 从 Google 获取任务列表 + asyncTask.publishProgess(mContext.getString(R.string.sync_progress_init_list)); // 发布进度,初始化任务列表 + initGTaskList(); // 初始化任务列表 + + // 执行内容同步任务 + 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) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + return STATE_INTERNAL_ERROR; // 返回内部错误状态 + } finally { + // 清除所有的哈希图和映射 + mGTaskListHashMap.clear(); + mGTaskHashMap.clear(); + mMetaHashMap.clear(); + mLocalDeleteIdMap.clear(); + mGidToNid.clear(); + mNidToGid.clear(); + // 设置同步标志为 false + mSyncing = false; + } + + return mCancelled ? STATE_SYNC_CANCELLED : STATE_SUCCESS; // 如果被取消,返回取消状态,否则返回成功状态 + } + + /** + * 初始化 Google 任务列表 + * + * @throws NetworkFailureException 网络请求失败异常 + */ + private void initGTaskList() throws NetworkFailureException { + if (mCancelled) + return; + GTaskClient client = GTaskClient.getInstance(); + try { + // 获取任务列表的 JSON 数组 + JSONArray jsTaskLists = client.getTaskLists(); + + // 初始化元数据列表 + 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); + + // 加载元数据 + JSONArray jsMetas = client.getTaskList(gid); + for (int j = 0; j < jsMetas.length(); j++) { + object = (JSONObject) jsMetas.getJSONObject(j); + MetaData metaData = new MetaData(); + metaData.setContentByRemoteJSON(object); + if (metaData.isWorthSaving()) { + mMetaList.addChildTask(metaData); + if (metaData.getGid() != null) { + mMetaHashMap.put(metaData.getRelatedGid(), metaData); + } + } + } + } + } + + // 若元数据列表不存在,则创建元数据列表 + if (mMetaList == null) { + mMetaList = new TaskList(); + mMetaList.setName(GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_META); + GTaskClient.getInstance().createTaskList(mMetaList); + } + + // 初始化任务列表 + 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)) { + TaskList tasklist = new TaskList(); + tasklist.setContentByRemoteJSON(object); + mGTaskListHashMap.put(gid, tasklist); + mGTaskHashMap.put(gid, tasklist); + + // 加载任务 + JSONArray jsTasks = client.getTaskList(gid); + for (int j = 0; j < jsTasks.length(); j++) { + object = (JSONObject) jsTasks.getJSONObject(j); + gid = object.getString(GTaskStringUtils.GTASK_JSON_ID); + Task task = new Task(); + task.setContentByRemoteJSON(object); + if (task.isWorthSaving()) { + task.setMetaInfo(mMetaHashMap.get(gid)); + tasklist.addChildTask(task); + mGTaskHashMap.put(gid, task); + } + } + } + } + } catch (JSONException e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new ActionFailureException("initGTaskList: handing JSONObject failed"); + } + } + + /** + * 同步内容方法,用于同步笔记内容到远程服务器 + * @throws NetworkFailureException 网络异常时抛出此异常 + */ + private void syncContent() throws NetworkFailureException { + int syncType; // 同步操作类型 + Cursor c = null; // 数据查询游标 + String gid; // 笔记在远程服务器的唯一标识 + Node node; // 笔记对应的节点 + + mLocalDeleteIdMap.clear(); // 清空本地已删除笔记的集合 + + if (mCancelled) { + return; // 如果取消了同步操作,直接返回 + } + + // 查询本地已删除的笔记 + try { + c = mContentResolver.query(Notes.CONTENT_NOTE_URI, SqlNote.PROJECTION_NOTE, + "(type<>? AND parent_id=?)", new String[] { + String.valueOf(Notes.TYPE_SYSTEM), String.valueOf(Notes.ID_TRASH_FOLER) + }, null); + if (c != null) { + while (c.moveToNext()) { + gid = c.getString(SqlNote.GTASK_ID_COLUMN); + node = mGTaskHashMap.get(gid); + if (node != null) { + mGTaskHashMap.remove(gid); + doContentSync(Node.SYNC_ACTION_DEL_REMOTE, node, c); // 执行内容同步方法,删除远程服务器中对应的笔记 + } + + mLocalDeleteIdMap.add(c.getLong(SqlNote.ID_COLUMN)); // 将本地已删除笔记的 ID 添加到集合中 + } + } else { + Log.w(TAG, "failed to query trash folder"); + } + } finally { + if (c != null) { + c.close(); // 关闭查询游标 + c = null; // 置空查询游标 + } + } + + // 先同步文件夹 + syncFolder(); // 同步文件夹信息 + + // 查询数据库中已存在的笔记 + try { + c = mContentResolver.query(Notes.CONTENT_NOTE_URI, SqlNote.PROJECTION_NOTE, + "(type=? AND parent_id<>?)", new String[] { + String.valueOf(Notes.TYPE_NOTE), String.valueOf(Notes.ID_TRASH_FOLER) + }, NoteColumns.TYPE + " DESC"); + if (c != null) { + while (c.moveToNext()) { + gid = c.getString(SqlNote.GTASK_ID_COLUMN); + node = mGTaskHashMap.get(gid); + if (node != null) { + mGTaskHashMap.remove(gid); + mGidToNid.put(gid, c.getLong(SqlNote.ID_COLUMN)); // 存储远程服务器 ID 到本地数据库 ID 的映射关系 + mNidToGid.put(c.getLong(SqlNote.ID_COLUMN), gid); // 存储本地数据库 ID 到远程服务器 ID 的映射关系 + syncType = node.getSyncAction(c); // 获取此笔记的同步操作类型 + } else { + if (c.getString(SqlNote.GTASK_ID_COLUMN).trim().length() == 0) { + // 本地添加 + syncType = Node.SYNC_ACTION_ADD_REMOTE; // 设置同步操作类型为向远程服务器添加笔记 + } else { + // 远程删除 + syncType = Node.SYNC_ACTION_DEL_LOCAL; // 设置同步操作类型为从本地删除笔记 + } + } + doContentSync(syncType, node, c); // 执行内容同步方法,同步笔记内容 + } + } else { + Log.w(TAG, "failed to query existing note in database"); + } + + } finally { + if (c != null) { + c.close(); // 关闭查询游标 + c = null; // 置空查询游标 + } + } + + // 遍历剩余的节点 + Iterator> iter = mGTaskHashMap.entrySet().iterator(); + while (iter.hasNext()) { + Map.Entry entry = iter.next(); + node = entry.getValue(); + doContentSync(Node.SYNC_ACTION_ADD_LOCAL, node, null); // 执行内容同步方法,向远程服务器添加本地的剩余笔记 + } + + // 逐个检查取消标志位,因为可能在另一个线程中被设置 + // 清除本地已删除笔记表 + if (!mCancelled) { // 如果没有取消同步 + if (!DataUtils.batchDeleteNotes(mContentResolver, mLocalDeleteIdMap)) { + throw new ActionFailureException("failed to batch-delete local deleted notes"); // 抛出操作失败异常,无法批量删除本地已删除笔记 + } + } + + // 刷新本地同步 ID + if (!mCancelled) { // 如果没有取消同步 + GTaskClient.getInstance().commitUpdate(); // 提交更新到远程服务器 + refreshLocalSyncId(); // 刷新本地同步 ID + } + + } + + private void syncFolder() throws NetworkFailureException { + Cursor c = null; // 数据成员注释: 创建一个游标实例 + String gid; // 数据成员注释: 定义字符串类型变量 gid + Node node; // 数据成员注释: 定义 Node 类型的变量 node + int syncType; // 数据成员注释: 定义整型变量 syncType + + if (mCancelled) { // 语句注释: 如果取消标志位为 true,则返回 + return; + } + + // for root folder + try { + c = mContentResolver.query(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, + Notes.ID_ROOT_FOLDER), SqlNote.PROJECTION_NOTE, null, null, null); // 实现注释: 查询根文件夹的内容 + if (c != null) { + c.moveToNext(); // 实现注释: 将游标移动到下一行 + gid = c.getString(SqlNote.GTASK_ID_COLUMN); // 实现注释: 获取游标列索引为 SqlNote.GTASK_ID_COLUMN 的字符串值 + node = mGTaskHashMap.get(gid); // 实现注释: 从哈希映射中获取 gid 对应的 Node 实例 + if (node != null) { // 语句注释: 如果 Node 存在 + mGTaskHashMap.remove(gid); // 实现注释: 从哈希映射中移除 gid 对应的 Node 实例 + mGidToNid.put(gid, (long) Notes.ID_ROOT_FOLDER); // 实现注释: 将 gid 映射到 Notes.ID_ROOT_FOLDER + mNidToGid.put((long) Notes.ID_ROOT_FOLDER, gid); // 实现注释: 将 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); // 实现注释: 执行内容同步操作,更新远程名称 + } else { + doContentSync(Node.SYNC_ACTION_ADD_REMOTE, node, c); // 实现注释: 执行内容同步操作,添加远程节点 + } + } else { + Log.w(TAG, "failed to query root folder"); // 实现注释: 记录日志,查询根目录失败 + } + } finally { + if (c != null) { + c.close(); + c = null; + } + } + + // for call-note folder + try { + c = mContentResolver.query(Notes.CONTENT_NOTE_URI, SqlNote.PROJECTION_NOTE, "(_id=?)", + new String[] { + String.valueOf(Notes.ID_CALL_RECORD_FOLDER) + }, null); // 实现注释: 查询通话记录文件夹的内容 + if (c != null) { + if (c.moveToNext()) { + gid = c.getString(SqlNote.GTASK_ID_COLUMN); // 实现注释: 获取游标列索引为 SqlNote.GTASK_ID_COLUMN 的字符串值 + node = mGTaskHashMap.get(gid); // 实现注释: 从哈希映射中获取 gid 对应的 Node 实例 + if (node != null) { // 实现注释: 如果 Node 存在 + mGTaskHashMap.remove(gid); // 实现注释: 从哈希映射中移除 gid 对应的 Node 实例 + mGidToNid.put(gid, (long) Notes.ID_CALL_RECORD_FOLDER); // 实现注释: 将 gid 映射到 Notes.ID_CALL_RECORD_FOLDER + mNidToGid.put((long) Notes.ID_CALL_RECORD_FOLDER, gid); // 实现注释: 将 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)) + doContentSync(Node.SYNC_ACTION_UPDATE_REMOTE, node, c); // 实现注释: 执行内容同步操作,更新远程名称 + } else { + doContentSync(Node.SYNC_ACTION_ADD_REMOTE, node, c); // 实现注释: 执行内容同步操作,添加远程节点 + } + } + } else { + Log.w(TAG, "failed to query call note folder"); // 实现注释: 记录日志,查询通话记录文件夹失败 + } + } finally { + if (c != null) { + c.close(); + c = null; + } + } + + // for local existing folders + try { + c = mContentResolver.query(Notes.CONTENT_NOTE_URI, SqlNote.PROJECTION_NOTE, + "(type=? AND parent_id<>?)", new String[] { + String.valueOf(Notes.TYPE_FOLDER), String.valueOf(Notes.ID_TRASH_FOLER) + }, NoteColumns.TYPE + " DESC"); // 实现注释: 查询本地已存在的文件夹的内容 + if (c != null) { + while (c.moveToNext()) { + gid = c.getString(SqlNote.GTASK_ID_COLUMN); // 实现注释: 获取游标列索引为 SqlNote.GTASK_ID_COLUMN 的字符串值 + node = mGTaskHashMap.get(gid); // 实现注释: 从哈希映射中获取 gid 对应的 Node 实例 + if (node != null) { // 实现注释: 如果 Node 存在 + mGTaskHashMap.remove(gid); // 实现注释: 从哈希映射中移除 gid 对应的 Node 实例 + mGidToNid.put(gid, c.getLong(SqlNote.ID_COLUMN)); // 实现注释: 将 gid 映射到游标列索引为 SqlNote.ID_COLUMN 的值 + mNidToGid.put(c.getLong(SqlNote.ID_COLUMN), gid); // 实现注释: 将游标列索引为 SqlNote.ID_COLUMN 的值映射到 gid + syncType = node.getSyncAction(c); // 实现注释: 获取 Node 的同步操作类型 + } 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; // 实现注释: 远程删除 + } + } + doContentSync(syncType, node, c); // 实现注释: 执行内容同步操作 + } + } else { + Log.w(TAG, "failed to query existing folder"); // 实现注释: 记录日志,查询已存在的文件夹失败 + } + } finally { + if (c != null) { + c.close(); + c = null; + } + } + + // for remote add folders + Iterator> iter = mGTaskListHashMap.entrySet().iterator(); // 实现注释: 获取迭代器实例 + while (iter.hasNext()) { + Map.Entry entry = iter.next(); // 实现注释: 获取迭代器下一个键值对 + gid = entry.getKey(); // 实现注释: 获取键值对的键 + node = entry.getValue(); // 实现注释: 获取键值对的值 + if (mGTaskHashMap.containsKey(gid)) { // 实现注释: 如果哈希映射中包含 gid + mGTaskHashMap.remove(gid); // 实现注释: 从哈希映射中移除 gid 对应的 Node 实例 + doContentSync(Node.SYNC_ACTION_ADD_LOCAL, node, null); // 实现注释: 执行内容同步操作,添加本地节点 + } + } + + if (!mCancelled) + GTaskClient.getInstance().commitUpdate(); // 实现注释: 提交更新操作 + } + + /** + * 方法用于执行内容同步操作,根据不同的同步类型执行相应的操作。 + * @param syncType 同步类型,用于标识执行何种同步操作 + * @param node 待同步的节点对象 + * @param c 游标对象,用于操作数据库结果集 + * @throws NetworkFailureException 网络异常时抛出该异常 + */ + private void doContentSync(int syncType, Node node, Cursor c) throws NetworkFailureException { + // 如果任务已取消,则直接返回 + if (mCancelled) { + return; + } + + 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: + // 获取与游标中的任务 ID 对应的元数据 + meta = mMetaHashMap.get(c.getString(SqlNote.GTASK_ID_COLUMN)); + // 如果元数据不为空,则通过 GTaskClient 删除节点 + if (meta != null) { + GTaskClient.getInstance().deleteNode(meta); + } + // 将本地删除的任务 ID 添加到本地删除 ID 映射表中 + mLocalDeleteIdMap.add(c.getLong(SqlNote.ID_COLUMN)); + break; + // 删除远程节点操作 + case Node.SYNC_ACTION_DEL_REMOTE: + // 获取与节点的全局唯一标识符对应的元数据 + meta = mMetaHashMap.get(node.getGid()); + // 如果元数据不为空,则通过 GTaskClient 删除节点 + if (meta != null) { + GTaskClient.getInstance().deleteNode(meta); + } + // 通过 GTaskClient 删除节点 + 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: + // 可能合并两种修改,但目前仅简单地使用本地更新 + updateRemoteNode(node, c); + break; + // 无需执行任何同步操作 + case Node.SYNC_ACTION_NONE: + break; + // 同步操作错误或未知类型时抛出异常 + case Node.SYNC_ACTION_ERROR: + default: + throw new ActionFailureException("未知的同步操作类型"); + } + } + + /** + * 方法用于将本地节点添加到数据库中,并更新相关的元数据和映射信息。 + * @param node 待添加的本地节点对象 + * @throws NetworkFailureException 网络异常时抛出该异常 + */ + private void addLocalNode(Node node) throws NetworkFailureException { + if (mCancelled) { + return; // 如果任务已取消,则直接返回 + } + + SqlNote sqlNote; // 数据库操作对象 + + // 根据节点类型进行不同的处理 + if (node instanceof TaskList) { + // 如果节点是任务列表 + if (node.getName().equals( + GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_DEFAULT)) { + // 如果节点是默认文件夹 + sqlNote = new SqlNote(mContext, Notes.ID_ROOT_FOLDER); // 创建根文件夹 + } else if (node.getName().equals( + GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_CALL_NOTE)) { + // 如果节点是通话备忘录文件夹 + sqlNote = new SqlNote(mContext, Notes.ID_CALL_RECORD_FOLDER); // 创建通话备忘录文件夹 + } else { + sqlNote = new SqlNote(mContext); // 创建一般的节点 + sqlNote.setContent(node.getLocalJSONFromContent()); // 设置节点内容数据 + sqlNote.setParentId(Notes.ID_ROOT_FOLDER); // 设置父节点为根文件夹 + } + } else { + // 如果节点是普通任务 + sqlNote = new SqlNote(mContext); // 创建一般的节点 + JSONObject js = node.getLocalJSONFromContent(); // 获取节点的本地 JSON 数据 + try { + // 处理元数据中的ID冲突问题 + if (js.has(GTaskStringUtils.META_HEAD_NOTE)) { + JSONObject note = js.getJSONObject(GTaskStringUtils.META_HEAD_NOTE); + if (note.has(NoteColumns.ID)) { + long id = note.getLong(NoteColumns.ID); + if (DataUtils.existInNoteDatabase(mContentResolver, id)) { + // 如果ID已存在于数据库中,则移除已存在的ID,在数据库中创建新的ID + note.remove(NoteColumns.ID); + } + } + } + + if (js.has(GTaskStringUtils.META_HEAD_DATA)) { + JSONArray dataArray = js.getJSONArray(GTaskStringUtils.META_HEAD_DATA); + for (int i = 0; i < dataArray.length(); i++) { + JSONObject data = dataArray.getJSONObject(i); + if (data.has(DataColumns.ID)) { + long dataId = data.getLong(DataColumns.ID); + if (DataUtils.existInDataDatabase(mContentResolver, dataId)) { + // 如果ID已存在于数据库中,则移除已存在的ID,在数据库中创建新的ID + data.remove(DataColumns.ID); + } + } + } + } + } catch (JSONException e) { + Log.w(TAG, e.toString()); + e.printStackTrace(); + } + // 设置节点内容数据 + sqlNote.setContent(js); + + // 通过全局唯一标识符获取父节点的本地ID + Long parentId = mGidToNid.get(((Task) node).getParent().getGid()); + if (parentId == null) { + Log.e(TAG, "cannot find task's parent id locally"); + throw new ActionFailureException("cannot add local node"); + } + sqlNote.setParentId(parentId.longValue()); // 设置父节点ID + } + + // 设置节点的全局唯一标识符 + sqlNote.setGtaskId(node.getGid()); + // 将节点添加到数据库中 + sqlNote.commit(false); + + // 更新全局唯一标识符到本地ID的映射关系 + mGidToNid.put(node.getGid(), sqlNote.getId()); + mNidToGid.put(sqlNote.getId(), node.getGid()); + + // 更新元数据信息 + updateRemoteMeta(node.getGid(), sqlNote); + } + + /** + * 更新本地节点信息,并将更新后的信息提交到数据库中。 + * @param node 待更新的节点对象 + * @param c 游标对象,用于更新本地节点信息 + * @throws NetworkFailureException 当网络异常时抛出该异常 + */ + private void updateLocalNode(Node node, Cursor c) throws NetworkFailureException { + if (mCancelled) { + return; // 如果任务已取消,则直接返回 + } + + SqlNote sqlNote; // 数据库操作对象 + // 更新本地节点信息 + sqlNote = new SqlNote(mContext, c); // 通过游标对象构造数据库操作对象 + sqlNote.setContent(node.getLocalJSONFromContent()); // 设置节点内容数据 + + // 获取父节点的本地ID + Long parentId = (node instanceof Task) ? mGidToNid.get(((Task) node).getParent().getGid()) + : new Long(Notes.ID_ROOT_FOLDER); + if (parentId == null) { + Log.e(TAG, "cannot find task's parent id locally"); + throw new ActionFailureException("cannot update local node"); + } + sqlNote.setParentId(parentId.longValue()); // 设置父节点ID + sqlNote.commit(true); // 提交更新后的信息到数据库 + + // 更新元数据信息 + updateRemoteMeta(node.getGid(), sqlNote); // 更新远程元数据信息 + } + /** + * 添加远程节点,并更新本地数据和远程数据。 + * @param node 待添加的节点对象 + * @param c 游标对象,用于操作数据库 + * @throws NetworkFailureException 当网络异常时抛出该异常 + */ + private void addRemoteNode(Node node, Cursor c) throws NetworkFailureException { + if (mCancelled) { + return; // 如果任务已取消,则直接返回 + } + + SqlNote sqlNote = new SqlNote(mContext, c); // 数据库操作对象 + Node n; // 节点对象 + + // 远程更新操作 + if (sqlNote.isNoteType()) { // 如果是笔记类型节点 + Task task = new Task(); // 创建任务对象 + task.setContentByLocalJSON(sqlNote.getContent()); // 通过本地JSON内容设置任务的内容 + + String parentGid = mNidToGid.get(sqlNote.getParentId()); // 获取父节点的全局ID + if (parentGid == null) { + Log.e(TAG, "cannot find task's parent tasklist"); + throw new ActionFailureException("cannot add remote task"); + } + mGTaskListHashMap.get(parentGid).addChildTask(task); // 将任务添加到对应的父任务列表中 + + GTaskClient.getInstance().createTask(task); // 在远程创建任务 + n = (Node) task; // 将任务对象转换为节点对象 + + // 添加元数据信息 + updateRemoteMeta(task.getGid(), sqlNote); + } else { // 如果是文件夹类型节点 + TaskList tasklist = null; // 任务列表对象 + + // 如果文件夹已存在,则跳过 + String folderName = GTaskStringUtils.MIUI_FOLDER_PREFFIX; + if (sqlNote.getId() == Notes.ID_ROOT_FOLDER) + folderName += GTaskStringUtils.FOLDER_DEFAULT; + else if (sqlNote.getId() == Notes.ID_CALL_RECORD_FOLDER) + folderName += GTaskStringUtils.FOLDER_CALL_NOTE; + else + folderName += sqlNote.getSnippet(); + + Iterator> iter = mGTaskListHashMap.entrySet().iterator(); + while (iter.hasNext()) { + Map.Entry entry = iter.next(); + String gid = entry.getKey(); + TaskList list = entry.getValue(); + + if (list.getName().equals(folderName)) { // 如果文件夹已存在 + tasklist = list; + if (mGTaskHashMap.containsKey(gid)) { + mGTaskHashMap.remove(gid); // 移除对应的任务映射 + } + break; + } + } + + // 如果文件夹不存在,则添加 + if (tasklist == null) { + tasklist = new TaskList(); // 创建新的任务列表对象 + tasklist.setContentByLocalJSON(sqlNote.getContent()); // 通过本地JSON内容设置任务列表的内容 + GTaskClient.getInstance().createTaskList(tasklist); // 在远程创建任务列表 + mGTaskListHashMap.put(tasklist.getGid(), tasklist); // 将任务列表添加到任务列表哈希映射中 + } + n = (Node) tasklist; // 将任务列表对象转换为节点对象 + } + + // 更新本地笔记信息 + sqlNote.setGtaskId(n.getGid()); // 设置笔记的全局ID + sqlNote.commit(false); // 提交未修改的笔记信息到数据库 + sqlNote.resetLocalModified(); // 重置本地修改标志 + sqlNote.commit(true); // 提交更新后的笔记信息到数据库 + + // 更新全局ID和本地ID的映射关系 + mGidToNid.put(n.getGid(), sqlNote.getId()); // 全局ID到本地ID的映射 + mNidToGid.put(sqlNote.getId(), n.getGid()); // 本地ID到全局ID的映射 + } + + /** + * 更新远程节点信息并同步本地数据。 + * @param node 待更新的节点对象 + * @param c 游标对象,用于操作数据库 + * @throws NetworkFailureException 当网络异常时抛出该异常 + */ + private void updateRemoteNode(Node node, Cursor c) throws NetworkFailureException { + if (mCancelled) { + return; // 如果任务已取消,则直接返回 + } + + SqlNote sqlNote = new SqlNote(mContext, c); // 创建数据库操作对象 + + // 更新远程节点 + node.setContentByLocalJSON(sqlNote.getContent()); // 通过本地JSON内容更新节点信息 + GTaskClient.getInstance().addUpdateNode(node); // 在远程更新节点信息 + + // 更新元数据信息 + updateRemoteMeta(node.getGid(), sqlNote); // 更新远程元数据信息 + + // 如果是任务类型节点,则进行移动操作 + if (sqlNote.isNoteType()) { + Task task = (Task) node; // 强制类型转换为任务对象 + TaskList preParentList = task.getParent(); // 获取任务的原父任务列表 + + String curParentGid = mNidToGid.get(sqlNote.getParentId()); // 获取当前父任务列表的全局ID + if (curParentGid == null) { + Log.e(TAG, "cannot find task's parent tasklist"); + throw new ActionFailureException("cannot update remote task"); + } + TaskList curParentList = mGTaskListHashMap.get(curParentGid); // 获取当前父任务列表对象 + + if (preParentList != curParentList) { + preParentList.removeChildTask(task); // 从原父任务列表中移除任务 + curParentList.addChildTask(task); // 将任务添加到当前父任务列表中 + GTaskClient.getInstance().moveTask(task, preParentList, curParentList); // 在远程执行任务移动操作 + } + } + + // 清除本地修改标记 + sqlNote.resetLocalModified(); // 重置本地修改标志 + sqlNote.commit(true); // 提交更新后的笔记信息到数据库 + } + + /** + * 更新远程元数据信息。 + * @param gid 全局ID + * @param sqlNote 笔记对象 + * @throws NetworkFailureException 当网络异常时抛出该异常 + */ + private void updateRemoteMeta(String gid, SqlNote sqlNote) throws NetworkFailureException { + if (sqlNote != null && sqlNote.isNoteType()) { + MetaData metaData = mMetaHashMap.get(gid); // 获取指定全局ID的元数据对象 + if (metaData != null) { + metaData.setMeta(gid, sqlNote.getContent()); // 更新元数据信息 + GTaskClient.getInstance().addUpdateNode(metaData); // 在远程更新元数据信息 + } else { + metaData = new MetaData(); // 创建新的元数据对象 + metaData.setMeta(gid, sqlNote.getContent()); // 设置元数据信息 + mMetaList.addChildTask(metaData); // 将元数据对象添加到元数据列表中 + mMetaHashMap.put(gid, metaData); // 在元数据哈希映射中添加元数据对象 + GTaskClient.getInstance().createTask(metaData); // 在远程创建元数据对象 + } + } + } + + /** + * 刷新本地同步 ID。 + * @throws NetworkFailureException 当网络异常时抛出该异常 + */ + private void refreshLocalSyncId() throws NetworkFailureException { + if (mCancelled) { + return; // 如果任务已取消,则直接返回 + } + + // 获取最新的 GTask 列表 + mGTaskHashMap.clear(); // 清空 GTask 哈希映射 + mGTaskListHashMap.clear(); // 清空 GTask 列表哈希映射 + mMetaHashMap.clear(); // 清空元数据哈希映射 + initGTaskList(); // 初始化 GTask 列表 + + Cursor c = null; + try { + // 查询本地笔记数据,排除系统类型和回收站中的笔记 + c = mContentResolver.query(Notes.CONTENT_NOTE_URI, SqlNote.PROJECTION_NOTE, + "(type<>? AND parent_id<>?)", new String[] { + String.valueOf(Notes.TYPE_SYSTEM), String.valueOf(Notes.ID_TRASH_FOLER) + }, NoteColumns.TYPE + " DESC"); + if (c != null) { + while (c.moveToNext()) { + String gid = c.getString(SqlNote.GTASK_ID_COLUMN); // 获取 GTask ID + Node node = mGTaskHashMap.get(gid); // 在 GTask 哈希映射中查找对应的节点 + if (node != null) { + mGTaskHashMap.remove(gid); // 从 GTask 哈希映射中移除对应的节点 + ContentValues values = new ContentValues(); // 创建待更新的数值对象 + values.put(NoteColumns.SYNC_ID, node.getLastModified()); // 设置更新的同步 ID + mContentResolver.update(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, + c.getLong(SqlNote.ID_COLUMN)), values, null, null); // 更新本地的同步 ID + } else { + Log.e(TAG, "something is missed"); // 输出错误日志 + throw new ActionFailureException( + "some local items don't have gid after sync"); // 抛出同步过程中丢失 GID 的异常 + } + } + } else { + Log.w(TAG, "failed to query local note to refresh sync id"); // 输出警告日志 + } + } finally { + if (c != null) { + c.close(); // 关闭游标对象 + c = null; // 将游标对象置为 null + } + } + } + + /** + * 获取同步账户信息。 + * @return 返回同步账户名称 + */ + public String getSyncAccount() { + return GTaskClient.getInstance().getSyncAccount().name; // 获取同步账户的名称 + } + + /** + * 取消同步操作。 + */ + public void cancelSync() { + mCancelled = true; // 将取消标志设置为 true + } +} diff --git a/src/Notes-master/gtask/remote/GTaskSyncService.java b/src/Notes-master/gtask/remote/GTaskSyncService.java new file mode 100644 index 0000000..c9d892f --- /dev/null +++ b/src/Notes-master/gtask/remote/GTaskSyncService.java @@ -0,0 +1,147 @@ +/* + * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net) + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * GTaskSyncService 是用于与 Google Tasks 同步任务的服务。 + */ +package net.micode.notes.gtask.remote; + +import android.app.Activity; +import android.app.Service; +import android.content.Context; +import android.content.Intent; +import android.os.Bundle; +import android.os.IBinder; + +/** + * GTaskSyncService 是用于与Google Tasks同步任务的服务。 + */ +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; + + // GTask 服务的广播名称 + 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"; + + // 用于同步的 AsyncTask + private static GTaskASyncTask mSyncTask = null; + + // 同步过程中的进度消息 + private static String mSyncProgress = ""; + + // 开始同步过程 + private void startSync() { + if (mSyncTask == null) { + mSyncTask = new GTaskASyncTask(this, new GTaskASyncTask.OnCompleteListener() { + public void onComplete() { + mSyncTask = null; + sendBroadcast(""); + stopSelf(); + } + }); + sendBroadcast(""); + mSyncTask.execute(); + } + } + + // 取消同步过程 + private void cancelSync() { + if (mSyncTask != null) { + mSyncTask.cancelSync(); + } + } + + @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; + } + return super.onStartCommand(intent, flags, startId); + } + + @Override + public void onLowMemory() { + if (mSyncTask != null) { + mSyncTask.cancelSync(); + } + } + + /** + * onBind 方法在这个服务中没有被使用 + */ + 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) { + 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; + } +} \ No newline at end of file