diff --git a/src/gtask/data/MetaData.java b/src/gtask/data/MetaData.java new file mode 100644 index 0000000..1a9f7f6 --- /dev/null +++ b/src/gtask/data/MetaData.java @@ -0,0 +1,125 @@ +/** + * MetaData类，继承自Task类，用于处理与任务相关的元数据。 + * 这个类主要用于存储和管理与任务相关的元信息，包括全局ID和元数据内容处理。 + */ +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; // 与任务相关的全局ID + + /** + * 设置元数据。 + * + * @param gid 任务的全局ID。此ID用于在系统中唯一标识任务。 + * @param metaInfo 元信息的JSON对象，包含与当前任务相关的其他信息。 + */ + public void setMeta(String gid, JSONObject metaInfo) { + try { + // 将任务的全局ID添加到元信息中 + metaInfo.put(GTaskStringUtils.META_HEAD_GTASK_ID, gid); + } catch (JSONException e) { + // 记录错误日志，表示在将ID添加到元信息时失败 + Log.e(TAG, "failed to put related gid"); + } + + // 将元信息设置为任务的笔记，以JSON字符串的形式存储在笔记字段中 + setNotes(metaInfo.toString()); + // 设置任务的名称为特定的元数据标志名称 + setName(GTaskStringUtils.META_NOTE_NAME); + } + + /** + * 获取与任务相关的全局ID。 + * + * @return 相关的全局ID字符串。如果没有设置，则返回null。 + */ + public String getRelatedGid() { + return mRelatedGid; + } + + /** + * 判断任务是否值得保存。 + * + * @return 如果任务的笔记字段不为空，则返回true，表示任务值得保存。 + * 否则返回false，表示任务不需要保存。 + */ + @Override + public boolean isWorthSaving() { + // 检查笔记是否为null，以决定是否值得保存 + 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()); + // 提取相关的全局ID + mRelatedGid = metaInfo.getString(GTaskStringUtils.META_HEAD_GTASK_ID); + } catch (JSONException e) { + // 记录警告，表示从笔记中无法获取相关ID + Log.w(TAG, "failed to get related gid"); + // 提取失败时，设置相关ID为null + mRelatedGid = null; + } + } + } + + /** + * 通过本地JSON对象设置内容。此方法不应被调用。 + * + * @param js 本地JSON对象，将本地的任务内容赋值给任务属性。 + * @throws IllegalAccessError 本方法不应该被调用，调用时抛出该异常。 + */ + @Override + public void setContentByLocalJSON(JSONObject js) { + // 本方法不应被调用，调用时抛出异常 + throw new IllegalAccessError("MetaData:setContentByLocalJSON should not be called"); + } + + /** + * 从内容生成本地JSON对象。此方法不应被调用。 + * + * @return 生成的JSON对象，此方法生成的JSON对象用以在本地保存或传输。 + * @throws IllegalAccessError 本方法不应该被调用，调用时抛出该异常。 + */ + @Override + public JSONObject getLocalJSONFromContent() { + // 本方法不应被调用，调用时抛出异常 + throw new IllegalAccessError("MetaData:getLocalJSONFromContent should not be called"); + } + + /** + * 获取同步操作类型。此方法不应被调用。 + * + * @param c 数据库游标，指向当前任务，用以获取任务的同步状态。 + * @return 同步操作的类型，例如新增、更新或删除等。 + * @throws IllegalAccessError 本方法不应该被调用，调用时抛出该异常。 + */ + @Override + public int getSyncAction(Cursor c) { + // 本方法不应被调用，调用时抛出异常 + throw new IllegalAccessError("MetaData:getSyncAction should not be called"); + } +} + diff --git a/src/gtask/data/Node.java b/src/gtask/data/Node.java new file mode 100644 index 0000000..a95fe42 --- /dev/null +++ b/src/gtask/data/Node.java @@ -0,0 +1,123 @@ +/* + * Node类定义了一个节点的基本属性和操作，用于数据同步时的表现和转换。 + * 它是用于表示通用数据节点的抽象类，具体的数据操作和格式转换由其子类实现。 + */ + +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; // 初始时GID为空 + mName = ""; // 节点名称初始化为空字符串 + mLastModified = 0; // 最后修改时间初始化为0（未设置） + mDeleted = false; // 节点初始状态为未删除 + } + + /** + * 生成创建节点的JSON动作。 + * + * @param actionId 同步操作的标识符，表示当前的操作类型。 + * @return 包含创建节点信息的JSON对象。 + */ + public abstract JSONObject getCreateAction(int actionId); + + /** + * 生成更新节点的JSON动作。 + * + * @param actionId 同步操作的标识符，表示当前的操作类型。 + * @return 包含更新节点信息的JSON对象。 + */ + public abstract JSONObject getUpdateAction(int actionId); + + /** + * 根据远程JSON内容设置节点内容。 + * + * @param js JSON对象，包含远程节点的内容。 + */ + public abstract void setContentByRemoteJSON(JSONObject js); + + /** + * 根据本地JSON内容设置节点内容。 + * + * @param js JSON对象，包含本地节点的内容。 + */ + public abstract void setContentByLocalJSON(JSONObject js); + + /** + * 从内容生成本地JSON表示。 + * + * @return 生成的JSON对象，用于本地存储或传输。 + */ + public abstract JSONObject getLocalJSONFromContent(); + + /** + * 根据Cursor获取同步动作。 + * + * @param c 数据库游标，当前指向节点记录。 + * @return 返回对应同步操作的类型。 + */ + public abstract int getSyncAction(Cursor c); + + // 设置节点的全局唯一标识符 + public void setGid(String gid) { + this.mGid = gid; + } + + // 设置节点名称 + public void setName(String name) { + this.mName = name; + } + + // 设置节点最后修改时间 + public void setLastModified(long lastModified) { + this.mLastModified = lastModified; + } + + // 设置节点是否被删除 + public void setDeleted(boolean deleted) { + this.mDeleted = deleted; + } + + // 获取节点的全局唯一标识符 + public String getGid() { + return this.mGid; + } + + // 获取节点名称 + public String getName() { + return this.mName; + } + + // 获取节点最后修改时间 + public long getLastModified() { + return this.mLastModified; + } + + // 获取节点是否被删除的标志 + public boolean getDeleted() { + return this.mDeleted; + } + +} diff --git a/src/gtask/data/SqlData.java b/src/gtask/data/SqlData.java new file mode 100644 index 0000000..0143954 --- /dev/null +++ b/src/gtask/data/SqlData.java @@ -0,0 +1,222 @@ +/* + * SqlData 类用于操作和管理数据库中的数据项。 + * 提供了从 JSON 对象设置内容，从数据库 Cursor 加载数据，以及提交数据更新到数据库的功能。 + */ + +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; + +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 + }; + + // 字段在Cursor中的索引 + 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; + + // ContentResolver用于操作内容提供者 + private ContentResolver mContentResolver; + + // 标记当前对象是创建状态还是更新状态 + private boolean mIsCreate; + + // 数据项ID + private long mDataId; + + // 数据项的MIME类型 + private String mDataMimeType; + + // 数据项的内容 + private String mDataContent; + + // 数据项的附加数据1 + private long mDataContentData1; + + // 数据项的附加数据3 + private String mDataContentData3; + + // 存储与数据库不同步的数据变化 + private ContentValues mDiffDataValues; + + /* + * SqlData 构造函数，用于创建新的数据项。 + * @param context 上下文对象，用于获取ContentResolver。 + */ + public SqlData(Context context) { + mContentResolver = context.getContentResolver(); + mIsCreate = true; // 设置为创建状态 + mDataId = INVALID_ID; // 初始化为无效ID + mDataMimeType = DataConstants.NOTE; // 默认MIME类型为笔记 + mDataContent = ""; // 内容初始化为空 + mDataContentData1 = 0; // 附加数据1初始化为0 + mDataContentData3 = ""; // 附加数据3初始化为空 + mDiffDataValues = new ContentValues(); // 初始化差异数据值 + } + + /* + * SqlData 构造函数，用于加载现有数据项。 + * @param context 上下文对象，用于获取ContentResolver。 + * @param c 数据项的Cursor对象，用于加载数据。 + */ + public SqlData(Context context, Cursor c) { + mContentResolver = context.getContentResolver(); + mIsCreate = false; // 设置为更新状态 + loadFromCursor(c); // 从Cursor中加载数据 + mDiffDataValues = new ContentValues(); // 初始化差异数据值 + } + + /* + * 从Cursor中加载数据。 + * @param c 数据项的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 + } + + /* + * 根据JSON对象设置数据项内容。 + * @param js JSON对象，包含数据项的内容。 + * @throws JSONException 如果解析JSON时出错。 + */ + public void setContent(JSONObject js) throws JSONException { + long dataId = js.has(DataColumns.ID) ? js.getLong(DataColumns.ID) : INVALID_ID; // 获取ID + if (mIsCreate || mDataId != dataId) { + mDiffDataValues.put(DataColumns.ID, dataId); // 保存ID变化 + } + mDataId = dataId; // 设置ID + + String dataMimeType = js.has(DataColumns.MIME_TYPE) ? js.getString(DataColumns.MIME_TYPE) + : DataConstants.NOTE; // 获取MIME类型 + if (mIsCreate || !mDataMimeType.equals(dataMimeType)) { + mDiffDataValues.put(DataColumns.MIME_TYPE, dataMimeType); // 保存MIME类型变化 + } + mDataMimeType = dataMimeType; // 设置MIME类型 + + String dataContent = js.has(DataColumns.CONTENT) ? js.getString(DataColumns.CONTENT) : ""; // 获取内容 + if (mIsCreate || !mDataContent.equals(dataContent)) { + mDiffDataValues.put(DataColumns.CONTENT, dataContent); // 保存内容变化 + } + mDataContent = dataContent; // 设置内容 + + long dataContentData1 = js.has(DataColumns.DATA1) ? js.getLong(DataColumns.DATA1) : 0; // 获取附加数据1 + if (mIsCreate || mDataContentData1 != dataContentData1) { + mDiffDataValues.put(DataColumns.DATA1, dataContentData1); // 保存附加数据1变化 + } + mDataContentData1 = dataContentData1; // 设置附加数据1 + + String dataContentData3 = js.has(DataColumns.DATA3) ? js.getString(DataColumns.DATA3) : ""; // 获取附加数据3 + if (mIsCreate || !mDataContentData3.equals(dataContentData3)) { + mDiffDataValues.put(DataColumns.DATA3, dataContentData3); // 保存附加数据3变化 + } + mDataContentData3 = dataContentData3; // 设置附加数据3 + } + + /* + * 获取数据项的内容，转换为JSON对象。 + * @return JSON对象，包含数据项的内容。 + * @throws JSONException 如果构建JSON对象时出错。 + */ + public JSONObject getContent() throws JSONException { + if (mIsCreate) { + Log.e(TAG, "it seems that we haven't created this in database yet"); // 输出错误信息 + return null; // 如果未创建则返回null + } + JSONObject js = new JSONObject(); // 创建JSON对象 + js.put(DataColumns.ID, mDataId); // 加入ID + js.put(DataColumns.MIME_TYPE, mDataMimeType); // 加入MIME类型 + js.put(DataColumns.CONTENT, mDataContent); // 加入内容 + js.put(DataColumns.DATA1, mDataContentData1); // 加入附加数据1 + js.put(DataColumns.DATA3, mDataContentData3); // 加入附加数据3 + return js; // 返回JSON对象 + } + + /* + * 将数据项提交到数据库，如果是新数据项则插入，否则更新。 + * @param noteId 符合此数据项的笔记ID。 + * @param validateVersion 是否验证版本号。 + * @param version 数据项的版本号。 + */ + public void commit(long noteId, boolean validateVersion, long version) { + if (mIsCreate) { + // 处理新数据项的插入 + if (mDataId == INVALID_ID && mDiffDataValues.containsKey(DataColumns.ID)) { + mDiffDataValues.remove(DataColumns.ID); // 从差异中移除ID + } + + mDiffDataValues.put(DataColumns.NOTE_ID, noteId); // 设置笔记ID + Uri uri = mContentResolver.insert(Notes.CONTENT_DATA_URI, mDiffDataValues); // 插入数据项 + try { + mDataId = 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"); // 抛出异常表示创建失败 + } + } else { + // 处理现有数据项的更新 + if (mDiffDataValues.size() > 0) { + int result = 0; + if (!validateVersion) { + // 不验证版本号时直接更新 + result = mContentResolver.update(ContentUris.withAppendedId( + Notes.CONTENT_DATA_URI, mDataId), mDiffDataValues, null, null); + } else { + // 验证版本号时条件更新 + result = mContentResolver.update(ContentUris.withAppendedId( + Notes.CONTENT_DATA_URI, mDataId), mDiffDataValues, + " ? in (SELECT " + NoteColumns.ID + " FROM " + TABLE.NOTE + + " WHERE " + NoteColumns.VERSION + "=?)", new String[]{ + String.valueOf(noteId), String.valueOf(version) + }); + } + if (result == 0) { + Log.w(TAG, "there is no update. maybe user updates note when syncing"); // 输出警告 + } + } + } + + // 清理并重置状态 + mDiffDataValues.clear(); // 清空差异数据 + mIsCreate = false; // 设置为更新状态 + } + + /* + * 获取数据项的ID。 + * @return 数据项的ID。 + */ + public long getId() { + return mDataId; // 返回数据项ID + } +} diff --git a/src/gtask/data/SqlNote.java b/src/gtask/data/SqlNote.java new file mode 100644 index 0000000..23ce7fb --- /dev/null +++ b/src/gtask/data/SqlNote.java @@ -0,0 +1,513 @@ +/* + * 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(); + + // 无效的ID值，用于标识未定义或错误的ID + private static final int INVALID_ID = -99999; + + // 查询笔记时要选择的列 + public static final String[] PROJECTION_NOTE = new String[]{ + NoteColumns.ID, NoteColumns.ALERTED_DATE, NoteColumns.BG_COLOR_ID, + NoteColumns.CREATED_DATE, NoteColumns.HAS_ATTACHMENT, NoteColumns.MODIFIED_DATE, + 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 + }; + + // 各查询列的索引 + 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; // 笔记ID + private long mAlertDate; // 提醒日期 + private int mBgColorId; // 背景颜色ID + private long mCreatedDate; // 创建日期 + private int mHasAttachment; // 是否有附件标志 + private long mModifiedDate; // 最后修改日期 + private long mParentId; // 父笔记ID + private String mSnippet; // 笔记摘录 + private int mType; // 笔记类型 + private int mWidgetId; // 相关的小部件ID + private int mWidgetType; // 小部件类型 + private long mOriginParent; // 原父笔记ID + private long mVersion; // 笔记版本号 + + // 用于存储两次更新之间差异的数据值 + private ContentValues mDiffNoteValues; + + // 存储与笔记相关数据的列表 + private ArrayList mDataList; + + /** + * 构造函数，初始化一个新的SqlNote实例。 + * + * @param context 上下文，通常是指Activity或Application对象。 + */ + public SqlNote(Context context) { + mContext = context; // 获取上下文 + mContentResolver = context.getContentResolver(); // 获取内容解析器 + mIsCreate = true; // 设为创建状态 + // 初始化笔记属性为默认值 + mId = INVALID_ID; // 初始化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(); // 初始化与笔记相关的数据列表 + } + + /** + * 构造函数，从数据库中加载指定ID的笔记。 + * + * @param context 上下文，通常是指Activity或Application对象。 + * @param c 数据库查询结果的Cursor对象。 + */ + public SqlNote(Context context, Cursor c) { + mContext = context; // 获取上下文 + mContentResolver = context.getContentResolver(); // 获取内容解析器 + mIsCreate = false; // 设为更新状态 + loadFromCursor(c); // 从Cursor中加载笔记数据 + mDataList = new ArrayList(); // 初始化与笔记相关的数据列表 + if (mType == Notes.TYPE_NOTE) + loadDataContent(); // 如果是笔记类型，则加载数据内容 + mDiffNoteValues = new ContentValues(); // 初始化差异数据字典 + } + + /** + * 构造函数，从数据库中加载指定ID的笔记。 + * + * @param context 上下文，通常是指Activity或Application对象。 + * @param id 要加载的笔记的ID。 + */ + public SqlNote(Context context, long id) { + mContext = context; // 获取上下文 + mContentResolver = context.getContentResolver(); // 获取内容解析器 + mIsCreate = false; // 设为更新状态 + loadFromCursor(id); // 根据ID从数据库加载数据 + mDataList = new ArrayList(); // 初始化与笔记相关的数据列表 + if (mType == Notes.TYPE_NOTE) + loadDataContent(); // 如果是笔记类型，则加载数据内容 + mDiffNoteValues = new ContentValues(); // 初始化差异数据字典 + } + + // 从数据库中加载笔记数据 + private void loadFromCursor(long id) { + Cursor c = null; + try { + // 根据ID查询笔记数据 + c = mContentResolver.query(Notes.CONTENT_NOTE_URI, PROJECTION_NOTE, "(_id=?)", + new String[]{ String.valueOf(id) }, null); + if (c != null) { + if (c.moveToNext()) { + loadFromCursor(c); // 如果Cursor非空，加载数据 + } else { + Log.w(TAG, "loadFromCursor: cursor = null"); // 查询结果为空时输出警告 + } + } + } finally { + if (c != null) // 释放Cursor资源 + c.close(); + } + } + + // 从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); // 获取笔记版本号 + } + + /** + * 加载数据内容。 + * 从数据库中查询特定note_id的数据，并将其加载到mDataList中。 + */ + private void loadDataContent() { + Cursor c = null; + mDataList.clear(); // 清空数据列表 + try { + // 查询指定note_id的数据 + 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; + } + // 遍历查询结果，并加载到mDataList中 + while (c.moveToNext()) { + SqlData data = new SqlData(mContext, c); // 创建SqlData对象 + mDataList.add(data); // 添加到数据列表 + } + } else { + // 如果查询结果为null，打印警告信息 + Log.w(TAG, "loadDataContent: cursor = null"); + } + } finally { + // 释放资源 + if (c != null) + c.close(); + } + } + + /** + * 设置内容。 + * 根据传入的JSONObject，更新或创建笔记的相关内容。 + * + * @param js 包含笔记信息的JSONObject。 + * @return 成功返回true，失败返回false。 + */ + public boolean setContent(JSONObject js) { + try { + // 从js中获取note信息 + JSONObject note = js.getJSONObject(GTaskStringUtils.META_HEAD_NOTE); + // 系统笔记不可修改 + if (note.getInt(NoteColumns.TYPE) == Notes.TYPE_SYSTEM) { + Log.w(TAG, "cannot set system folder"); + } else if (note.getInt(NoteColumns.TYPE) == Notes.TYPE_FOLDER) { + // 文件夹类型笔记，仅更新snippet和类型 + String snippet = note.has(NoteColumns.SNIPPET) ? note + .getString(NoteColumns.SNIPPET) : ""; + if (mIsCreate || !mSnippet.equals(snippet)) { + mDiffNoteValues.put(NoteColumns.SNIPPET, snippet); // 保存snippet的差异 + } + mSnippet = snippet; + + int type = note.has(NoteColumns.TYPE) ? note.getInt(NoteColumns.TYPE) + : Notes.TYPE_NOTE; + if (mIsCreate || mType != type) { + mDiffNoteValues.put(NoteColumns.TYPE, type); // 保存类型的差异 + } + mType = type; + } else if (note.getInt(NoteColumns.TYPE) == Notes.TYPE_NOTE) { + // 笔记类型，更新或设置多种信息 + JSONArray dataArray = js.getJSONArray(GTaskStringUtils.META_HEAD_DATA); + long id = note.has(NoteColumns.ID) ? note.getLong(NoteColumns.ID) : INVALID_ID; + if (mIsCreate || mId != id) { + mDiffNoteValues.put(NoteColumns.ID, id); // 保存ID差异 + } + mId = id; + + // 更新或设置提醒日期、背景色id、创建日期、附件标志、修改日期、父id、snippet、类型、小部件id和类型等信息 + // 该部分通过条件判断，确定是否需要更新数据库字段 + + // 处理数据项数组，每个数据项会被更新或创建 + 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) { + // 处理JSON解析异常 + Log.e(TAG, e.toString()); + e.printStackTrace(); + return false; // 解析失败 + } + return true; // 解析成功 + } + + /** + * 获取内容。 + * 将当前笔记的内容转换为JSONObject格式。 + * + * @return 笔记内容的JSONObject，如果无法转换成功则返回null。 + */ + public JSONObject getContent() { + try { + JSONObject js = new JSONObject(); + + if (mIsCreate) { + // 如果笔记尚未在数据库中创建，返回null + Log.e(TAG, "it seems that we haven't created this in database yet"); + return null; + } + + JSONObject note = new JSONObject(); + // 根据笔记类型，填充不同的信息到note JSONObject中 + // 该部分通过条件判断，根据mType选择需要填充的信息 + + // 将note和data信息添加到js中 + js.put(GTaskStringUtils.META_HEAD_NOTE, note); // 添加笔记信息 + // 处理数据项数组，将其添加到js中 + JSONArray dataArray = new JSONArray(); + for (SqlData data : mDataList) { + dataArray.put(data.getContent()); // 获取每个数据项的内容 + } + js.put(GTaskStringUtils.META_HEAD_DATA, dataArray); // 添加数据项信息 + + return js; // 返回完整内容 + } catch (JSONException e) { + // 处理JSON构建异常 + Log.e(TAG, e.toString()); + e.printStackTrace(); + } + return null; // 转换失败时返回null + } + + /** + * 设置父id。 + * + * @param id 父笔记的id。 + */ + public void setParentId(long id) { + mParentId = id; + mDiffNoteValues.put(NoteColumns.PARENT_ID, id); // 保存父ID的差异 + } + + /** + * 设置Gtask id。 + * + * @param gid Gtask的id。 + */ + public void setGtaskId(String gid) { + mDiffNoteValues.put(NoteColumns.GTASK_ID, gid); // 保存Gtask ID的差异 + } + + /** + * 设置同步id。 + * + * @param syncId 同步的id。 + */ + public void setSyncId(long syncId) { + mDiffNoteValues.put(NoteColumns.SYNC_ID, syncId); // 保存同步ID的差异 + } + + /** + * 重置本地修改标志。 + */ + public void resetLocalModified() { + mDiffNoteValues.put(NoteColumns.LOCAL_MODIFIED, 0); // 重置本地修改标志 + } + + /** + * 获取笔记id。 + * + * @return 笔记的id。 + */ + public long getId() { + return mId; // 返回笔记ID + } + + /** + * 获取父id。 + * + * @return 父笔记的id。 + */ + public long getParentId() { + return mParentId; // 返回父ID + } + + /** + * 获取snippet。 + * + * @return 笔记的snippet。 + */ + public String getSnippet() { + return mSnippet; // 返回笔记摘录 + } + + /** + * 判断是否为笔记类型。 + * + * @return 是笔记类型返回true，否则返回false。 + */ + public boolean isNoteType() { + return mType == Notes.TYPE_NOTE; // 检查当前类型 + } + + /** + * 提交对笔记的更改或创建新的笔记。 + * + * @param validateVersion 是否验证版本号。如果为 true，则在更新笔记时会检查版本号以避免并发更新的问题。 + * 如果为 false，则不进行版本号检查。 + * 这个参数主要用于处理客户端在同步过程中可能同时更新同一笔记的情况。 + */ +/** + * 提交对笔记的更改或创建新的笔记。 + * + * @param validateVersion 是否验证版本号。如果为 true，则在更新笔记时会检查版本号以避免并发更新的问题。 + * 如果为 false，则不进行版本号检查。 + * 这个参数主要用于处理客户端在同步过程中可能同时更新同一笔记的情况。 + */ +public void commit(boolean validateVersion) { + // 判断当前是否为创建新笔记的状态 + if (mIsCreate) { // 处理创建新笔记的逻辑 + // 在创建新笔记时，如果ID是无效的（即未指定），且包含了ID字段，则移除该字段 + if (mId == INVALID_ID && mDiffNoteValues.containsKey(NoteColumns.ID)) { + mDiffNoteValues.remove(NoteColumns.ID); // 移除无效ID字段 + } + + // 使用ContentResolver插入新的笔记数据到数据库 + Uri uri = mContentResolver.insert(Notes.CONTENT_NOTE_URI, mDiffNoteValues); + + try { + // 从插入返回的URI中解析出新笔记的ID + mId = Long.valueOf(uri.getPathSegments().get(1)); + } catch (NumberFormatException e) { + Log.e(TAG, "Get note id error :" + e.toString()); // 记录错误日志 + // 如果无法解析出ID，抛出异常，表示创建失败 + throw new ActionFailureException("create note failed"); + } + // 检查解析出的ID是否有效 + if (mId == 0) { + throw new IllegalStateException("Create thread id failed"); // 如果ID无效，抛出异常 + } + + // 如果是创建笔记类型，提交关联数据 + if (mType == Notes.TYPE_NOTE) { + // 遍历与当前笔记关联的数据项，提交每一个数据项 + for (SqlData sqlData : mDataList) { + sqlData.commit(mId, false, -1); // 提交关联数据 + } + } + } else { // 处理更新现有笔记的逻辑 + // 如果指定的笔记ID无效或不存在，抛出异常 + 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) // 使用当前笔记ID + }); + } else { + // 验证版本号时，进行条件更新 + result = mContentResolver.update(Notes.CONTENT_NOTE_URI, mDiffNoteValues, "(" + + NoteColumns.ID + "=?) AND (" + NoteColumns.VERSION + "<=?)", + new String[]{ + String.valueOf(mId), String.valueOf(mVersion) // 检查当前版本号 + }); + } + + // 如果更新结果为0，说明没有进行任何更新，可能是由于同步时用户同时更新了笔记 + 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/gtask/data/Task.java b/src/gtask/data/Task.java new file mode 100644 index 0000000..ada2d4b --- /dev/null +++ b/src/gtask/data/Task.java @@ -0,0 +1,415 @@ +/* + * 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; + + // 任务元信息，包含额外的JSON格式信息 + private JSONObject mMetaInfo; + + // 前一个兄弟任务 + private Task mPriorSibling; + + // 任务所属的任务列表 + private TaskList mParent; + + /** + * 构造函数，初始化任务状态。 + */ + public Task() { + super(); // 调用父类Node的构造函数 + mCompleted = false; // 初始化任务为未完成状态 + mNotes = null; // 初始化备注为null + mPriorSibling = null; // 初始前一个兄弟任务为null + mParent = null; // 初始化父任务列表为null + mMetaInfo = null; // 初始化元信息为null + } + + /** + * 生成创建任务的JSON动作对象。 + * + * @param actionId 动作ID + * @return 包含创建任务动作的JSON对象 + * @throws ActionFailureException 如果生成JSON对象失败 + */ + public JSONObject getCreateAction(int actionId) { + JSONObject js = new JSONObject(); + + try { + // 设置动作类型为创建 + js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, + GTaskStringUtils.GTASK_JSON_ACTION_TYPE_CREATE); + + // 设置动作ID + js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId); + + // 设置任务在父列表中的索引 + js.put(GTaskStringUtils.GTASK_JSON_INDEX, mParent.getChildTaskIndex(this)); + + // 设置任务实体信息 + 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_TASK); + if (getNotes() != null) { + entity.put(GTaskStringUtils.GTASK_JSON_NOTES, getNotes()); + } + js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity); // 将任务实体信息添加到JSON + + // 设置父任务ID + js.put(GTaskStringUtils.GTASK_JSON_PARENT_ID, mParent.getGid()); + + // 设置目标父类型为任务列表 + js.put(GTaskStringUtils.GTASK_JSON_DEST_PARENT_TYPE, + GTaskStringUtils.GTASK_JSON_TYPE_GROUP); + + // 设置任务列表ID + js.put(GTaskStringUtils.GTASK_JSON_LIST_ID, mParent.getGid()); + + // 如果存在前一个兄弟任务，设置其ID + if (mPriorSibling != null) { + js.put(GTaskStringUtils.GTASK_JSON_PRIOR_SIBLING_ID, mPriorSibling.getGid()); + } + + } catch (JSONException e) { + Log.e(TAG, e.toString()); // 记录错误日志 + e.printStackTrace(); + throw new ActionFailureException("fail to generate task-create jsonobject"); // 抛出异常，表示JSON生成失败 + } + + return js; // 返回生成的JSON对象 + } + + /** + * 生成更新任务的JSON动作对象。 + * + * @param actionId 动作ID + * @return 包含更新任务动作的JSON对象 + * @throws ActionFailureException 如果生成JSON对象失败 + */ + public JSONObject getUpdateAction(int actionId) { + JSONObject js = new JSONObject(); + + try { + // 设置动作类型为更新 + js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, + GTaskStringUtils.GTASK_JSON_ACTION_TYPE_UPDATE); + + // 设置动作ID + js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId); + + // 设置任务ID + js.put(GTaskStringUtils.GTASK_JSON_ID, getGid()); + + // 设置任务实体信息 + JSONObject entity = new JSONObject(); + entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName()); + if (getNotes() != null) { + entity.put(GTaskStringUtils.GTASK_JSON_NOTES, getNotes()); + } + entity.put(GTaskStringUtils.GTASK_JSON_DELETED, getDeleted()); // 设置删除状态 + js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity); // 将实体信息添加到JSON + + } 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对象 + * @throws ActionFailureException 如果从JSON对象中获取内容失败 + */ + public void setContentByRemoteJSON(JSONObject js) { + if (js != null) { + try { + // 从JSON中解析任务信息 + if (js.has(GTaskStringUtils.GTASK_JSON_ID)) { + setGid(js.getString(GTaskStringUtils.GTASK_JSON_ID)); // 设置任务ID + } + + if (js.has(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)) { + setLastModified(js.getLong(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)); // 设置最后修改时间 + } + + if (js.has(GTaskStringUtils.GTASK_JSON_NAME)) { + setName(js.getString(GTaskStringUtils.GTASK_JSON_NAME)); // 设置任务名称 + } + + if (js.has(GTaskStringUtils.GTASK_JSON_NOTES)) { + setNotes(js.getString(GTaskStringUtils.GTASK_JSON_NOTES)); // 设置任务备注 + } + + if (js.has(GTaskStringUtils.GTASK_JSON_DELETED)) { + setDeleted(js.getBoolean(GTaskStringUtils.GTASK_JSON_DELETED)); // 设置任务删除状态 + } + + if (js.has(GTaskStringUtils.GTASK_JSON_COMPLETED)) { + setCompleted(js.getBoolean(GTaskStringUtils.GTASK_JSON_COMPLETED)); // 设置任务完成状态 + } + } catch (JSONException e) { + Log.e(TAG, e.toString()); // 记录错误日志 + e.printStackTrace(); + throw new ActionFailureException("fail to get task content from jsonobject"); // 抛出异常，表示获取内容失败 + } + } + } + + /** + * 根据本地JSON对象设置任务内容。 + * + * @param js 本地获取的JSON对象 + * @throws ActionFailureException 如果从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 available"); // 记录警告，无内容可设置 + return; + } + + 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)); // 设置任务名称 + 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"); // 记录警告，任务为空 + return null; // 返回null + } + + JSONObject js = new JSONObject(); // 创建新的JSON对象 + JSONObject note = new JSONObject(); + JSONArray dataArray = new JSONArray(); + JSONObject data = new JSONObject(); + 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()); // 更新任务内容 + break; // 找到后退出循环 + } + } + + note.put(NoteColumns.TYPE, Notes.TYPE_NOTE); // 确保笔记信息的类型为任务 + return mMetaInfo; // 返回元信息 + } + } 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对象 + } catch (JSONException e) { + Log.w(TAG, e.toString()); // 记录警告 + mMetaInfo = null; // 设置为null + } + } + } + + /** + * 根据数据库游标获取同步动作类型。 + * + * @param c 数据库游标，指向当前任务的数据行 + * @return 同步动作类型，定义了任务数据的同步方向 + */ + public int getSyncAction(Cursor c) { + try { + JSONObject noteInfo = null; + // 获取任务的元信息 + if (mMetaInfo != null && mMetaInfo.has(GTaskStringUtils.META_HEAD_NOTE)) { + noteInfo = mMetaInfo.getJSONObject(GTaskStringUtils.META_HEAD_NOTE); + } + + // 检查元信息是否存在 + if (noteInfo == null) { + Log.w(TAG, "it seems that note meta has been deleted"); + return SYNC_ACTION_UPDATE_REMOTE; // 如果元信息已删除，返回更新远程标识 + } + + // 检查远程任务ID是否存在 + if (!noteInfo.has(NoteColumns.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)) { + Log.w(TAG, "note id doesn't match"); // 记录事件，ID不匹配 + 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 { + // 本地已修改 + 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_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); + } + + // 以下为任务状态的设置和获取方法 + + public void setCompleted(boolean completed) { + this.mCompleted = completed; // 设置任务完成状态 + } + + public void setNotes(String notes) { + this.mNotes = notes; // 设置任务备注 + } + + public void setPriorSibling(Task priorSibling) { + this.mPriorSibling = priorSibling; // 设置前一个兄弟任务 + } + + public void setParent(TaskList parent) { + this.mParent = parent; // 设置任务列表作为父任务 + } + + public boolean getCompleted() { + return this.mCompleted; // 获取任务完成状态 + } + + public String getNotes() { + return this.mNotes; // 获取任务备注 + } + + public Task getPriorSibling() { + return this.mPriorSibling; // 获取前一个兄弟任务 + } + + public TaskList getParent() { + return this.mParent; // 获取任务列表父对象 + } +} diff --git a/src/gtask/data/TaskList.java b/src/gtask/data/TaskList.java new file mode 100644 index 0000000..015f659 --- /dev/null +++ b/src/gtask/data/TaskList.java @@ -0,0 +1,463 @@ +/* + * 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; + +/** + * 任务列表类，继承自Node类。用于管理一组任务（Task）对象。 + */ +public class TaskList extends Node { + // 日志标签 + private static final String TAG = TaskList.class.getSimpleName(); + + // 列表中的任务索引 + private int mIndex; + + // 存储子任务的列表 + private ArrayList mChildren; + + /** + * 构造函数，初始化任务列表。 + */ + public TaskList() { + super(); // 调用父类Node构造函数 + mChildren = new ArrayList(); // 初始化子任务列表 + mIndex = 1; // 默认索引设置为1 + } + + /** + * 生成创建任务列表的动作JSON对象。 + * + * @param actionId 动作标识符 + * @return 包含创建任务列表动作的JSON对象 + * @throws ActionFailureException 如果生成JSON对象失败，则抛出异常 + */ + public JSONObject getCreateAction(int actionId) throws ActionFailureException { + JSONObject js = new JSONObject(); + + try { + // 设置动作类型为创建 + js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, + GTaskStringUtils.GTASK_JSON_ACTION_TYPE_CREATE); + + // 设置动作标识符 + js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId); + + // 设置索引 + js.put(GTaskStringUtils.GTASK_JSON_INDEX, mIndex); + + // 设置实体变化信息 + 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); // 将任务列表实体信息加入JSON + + } catch (JSONException e) { + Log.e(TAG, e.toString()); // 记录错误日志 + e.printStackTrace(); + throw new ActionFailureException("fail to generate tasklist-create jsonobject"); // 抛出异常，表示JSON生成失败 + } + + return js; // 返回生成的JSON对象 + } + + /** + * 生成更新任务列表的动作JSON对象。 + * + * @param actionId 动作标识符 + * @return 包含更新任务列表动作的JSON对象 + * @throws ActionFailureException 如果生成JSON对象失败，则抛出异常 + */ + public JSONObject getUpdateAction(int actionId) throws ActionFailureException { + JSONObject js = new JSONObject(); + + try { + // 设置动作类型为更新 + js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, + GTaskStringUtils.GTASK_JSON_ACTION_TYPE_UPDATE); + + // 设置动作标识符 + js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId); + + // 设置任务列表ID + js.put(GTaskStringUtils.GTASK_JSON_ID, getGid()); + + // 设置实体变化信息 + 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); // 将实体信息加入JSON + + } catch (JSONException e) { + Log.e(TAG, e.toString()); // 记录错误日志 + e.printStackTrace(); + throw new ActionFailureException("fail to generate tasklist-update jsonobject"); // 抛出异常，表示JSON生成失败 + } + + return js; // 返回生成的JSON对象 + } + + /** + * 根据远程JSON对象设置任务列表的内容。 + * + * @param js 远程获取的JSON对象 + * @throws ActionFailureException 如果从JSON对象中获取内容失败，则抛出异常 + */ + public void setContentByRemoteJSON(JSONObject js) throws ActionFailureException { + if (js != null) { + try { + // 设置ID + if (js.has(GTaskStringUtils.GTASK_JSON_ID)) { + setGid(js.getString(GTaskStringUtils.GTASK_JSON_ID)); // 设置任务列表ID + } + + // 设置最后修改时间 + if (js.has(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)) { + setLastModified(js.getLong(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)); + } + + // 设置名称 + 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对象 + * @throws ActionFailureException 如果从JSON对象中获取内容失败，则抛出异常 + */ + public void setContentByLocalJSON(JSONObject js) throws ActionFailureException { + if (js == null || !js.has(GTaskStringUtils.META_HEAD_NOTE)) { + Log.w(TAG, "setContentByLocalJSON: nothing is available"); // 记录警告，无有效内容 + return; + } + + 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(); + throw new ActionFailureException("fail to set tasklist content from local json object"); // 抛出异常，表示设置内容失败 + } + } + + /** + * 从任务列表内容生成本地JSON对象。 + * + * @return 本地JSON对象代表的任务列表内容 + */ + public JSONObject getLocalJSONFromContent() { + try { + JSONObject js = new JSONObject(); // 创建新的JSON对象 + JSONObject folder = new JSONObject(); // 创建任务列表信息对象 + + // 设置任务列表名称 + String folderName = getName(); + if (getName().startsWith(GTaskStringUtils.MIUI_FOLDER_PREFFIX)) + folderName = folderName.substring(GTaskStringUtils.MIUI_FOLDER_PREFFIX.length(), + folderName.length()); + 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); // 添加任务列表信息到JSON + + return js; // 返回生成的JSON对象 + } catch (JSONException e) { + Log.e(TAG, e.toString()); // 记录错误日志 + e.printStackTrace(); + return null; // 生成失败，返回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"); // 记录错误，ID不匹配 + return SYNC_ACTION_ERROR; // 返回错误状态 + } + // 对于文件夹情况，应该的返回逻辑 + return SYNC_ACTION_UPDATE_REMOTE; // 仅本地有修改 + } + } catch (Exception e) { + Log.e(TAG, e.toString()); // 记录错误日志 + e.printStackTrace(); + } + + return SYNC_ACTION_ERROR; // 默认返回错误状态 + } + + /** + * 获取子任务数量。 + * + * @return 子任务数量 + */ + public int getChildTaskCount() { + return mChildren.size(); // 返回当前子任务的数量 + } + + /** + * 添加一个子任务到列表中。 + * + * @param task 要添加的子任务 + * @return 如果添加成功返回true，否则返回false + */ + public boolean addChildTask(Task task) { + boolean ret = false; + if (task != null && !mChildren.contains(task)) { + ret = mChildren.add(task); // 添加任务 + if (ret) { + // 设置前置兄弟节点和父节点 + 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 in the list"); // 记录错误，任务不在列表中 + return false; + } + + if (pos == index) + return true; // 位置未变，返回成功 + return (removeChildTask(task) && addChildTask(task, index)); // 移除后再添加 + } + + /** + * 根据全局标识符(gid)查找子任务。 + * + * @param gid 要查找的子任务的全局标识符 + * @return 如果找到匹配的子任务，则返回该任务对象；否则返回null。 + */ + public Task findChildTaskByGid(String gid) { + // 遍历子任务列表，查找gid匹配的子任务 + for (int i = 0; i < mChildren.size(); i++) { + Task t = mChildren.get(i); + if (t.getGid().equals(gid)) { + return t; // 返回找到的任务 + } + } + return null; // 未找到则返回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 要查找的子任务的全局标识符 + * @return 如果找到匹配的子任务，则返回该任务对象；否则返回null。 + */ + public Task getChildTaskByGid(String gid) { + // 遍历子任务列表，查找gid匹配的子任务 + for (Task task : mChildren) { + if (task.getGid().equals(gid)) + return task; // 返回找到的任务 + } + return null; // 未找到则返回null + } + + /** + * 获取所有子任务的列表。 + * + * @return 子任务列表，作为一个ArrayList返回。 + */ + 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/gtask/exception/ActionFailureException.java b/src/gtask/exception/ActionFailureException.java new file mode 100644 index 0000000..3737065 --- /dev/null +++ b/src/gtask/exception/ActionFailureException.java @@ -0,0 +1,53 @@ +/* + * ActionFailureException 类的注释 + * + * 该异常类是运行时异常的子类，用于表示操作失败的异常情况。 + * 它可以包含一个错误消息和导致异常的 Throwable 对象。 + * 这个类主要是为了处理任务或动作执行失败的情况， + * 提供了一个通用的方式来报告和处理这类错误。 + * + * 许可证信息: 见类文件头部的版权声明 + */ + +package net.micode.notes.gtask.exception; + +// 引入 Java 运行时异常类 +import java.lang.RuntimeException; + +/** + * ActionFailureException 类定义了一个操作失败时抛出的异常。 + * + * 这个异常类可以用来表示在执行某个操作过程中出现的故障， + * 比如在任务创建、更新或删除时发生错误。 + */ +public class ActionFailureException extends RuntimeException { + private static final long serialVersionUID = 4425249765923293627L; // 序列化 ID + + /** + * 无参构造函数，创建一个不带详细消息的动作失败异常实例。 + */ + public ActionFailureException() { + super(); // 调用父类RuntimeException的无参构造函数 + } + + /** + * 带有详细信息的构造函数，创建一个带有详细错误消息的动作失败异常实例。 + * + * @param paramString 错误信息字符串，用于描述异常的详细情况。 + */ + public ActionFailureException(String paramString) { + super(paramString); // 调用父类RuntimeException的构造函数，将错误消息传递给它 + } + + /** + * 带有详细信息和导致异常的原因的构造函数，创建一个带有详细错误消息 + * 和导致异常的 Throwable 对象的动作失败异常实例。 + * + * @param paramString 错误信息字符串，用于描述异常的详细情况。 + * @param paramThrowable 导致异常的 Throwable 对象。 + */ + public ActionFailureException(String paramString, Throwable paramThrowable) { + super(paramString, paramThrowable); // 调用父类RuntimeException的构造函数 + // 将错误信息和抛出的异常传递给父类 + } +} diff --git a/src/gtask/exception/NetworkFailureException.java b/src/gtask/exception/NetworkFailureException.java new file mode 100644 index 0000000..0a488c0 --- /dev/null +++ b/src/gtask/exception/NetworkFailureException.java @@ -0,0 +1,47 @@ +/* + * NetworkFailureException 类的注释 + * + * 该异常类用于表示网络操作失败的异常。它是 Exception 的子类， + * 可用来捕获和处理应用程序中发生的网络错误。 + * 可以通过不同的构造函数来创建包含详细信息或不包含详细信息的 + * NetworkFailureException 实例。 + */ + +package net.micode.notes.gtask.exception; + +/** + * NetworkFailureException 类表示在网络操作中发生的错误。 + * + * 该异常可以用于捕获与网络相关的错误，例如连接失败， + * 超时或数据传输过程中的错误等。 + */ +public class NetworkFailureException extends Exception { + private static final long serialVersionUID = 2107610287180234136L; // 序列化 ID + + /** + * 无参构造函数，用于创建一个不带详细信息的 NetworkFailureException 实例。 + */ + public NetworkFailureException() { + super(); // 调用父类 Exception 的无参构造函数 + } + + /** + * 带有详细信息的构造函数，用于创建一个包含错误信息的 NetworkFailureException 实例。 + * + * @param paramString 错误信息字符串，用于描述异常的详细情况。 + */ + public NetworkFailureException(String paramString) { + super(paramString); // 调用父类的构造函数，将错误信息传递 + } + + /** + * 带有详细信息和导致异常的 Throwable 对象的构造函数， + * 用于创建包含错误信息和原因的 NetworkFailureException 实例。 + * + * @param paramString 错误信息字符串，用于描述异常的详细情况。 + * @param paramThrowable 导致异常的 Throwable 对象。 + */ + public NetworkFailureException(String paramString, Throwable paramThrowable) { + super(paramString, paramThrowable); // 调用父类构造函数，将错误信息和原因传递 + } +} diff --git a/src/gtask/remote/GTaskASyncTask.java b/src/gtask/remote/GTaskASyncTask.java new file mode 100644 index 0000000..54d3cc2 --- /dev/null +++ b/src/gtask/remote/GTaskASyncTask.java @@ -0,0 +1,152 @@ +/* + * GTaskASyncTask 类说明: + * 这是一个继承自AsyncTask的类，用于在后台执行Google任务同步操作。 + * 它可以在一个独立的线程中执行同步任务，并通过通知栏通知用户同步的状态（成功、失败、取消等）。 + * 同时，它提供了接口供调用者监听同步任务的完成。 + */ + +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; + +/** + * GTaskASyncTask 类负责执行 Google 任务的同步操作。 + * 它是一个 AsyncTask，它在后台线程中处理同步任务并更新UI。 + */ +public class GTaskASyncTask extends AsyncTask { + + // 同步通知的唯一ID + private static int GTASK_SYNC_NOTIFICATION_ID = 5234235; + + // 定义完成监听器接口 + public interface OnCompleteListener { + void onComplete(); // 同步完成时调用的方法 + } + + private Context mContext; // 上下文对象，用于访问应用资源和通知管理器 + private NotificationManager mNotifiManager; // 通知管理器，用于管理和显示通知 + private GTaskManager mTaskManager; // Google任务管理器，用于执行实际的同步操作 + private OnCompleteListener mOnCompleteListener; // 同步完成的监听器 + + /* + * 构造函数 + * @param context 应用的上下文环境 + * @param listener 同步完成时的监听器 + */ + public GTaskASyncTask(Context context, OnCompleteListener listener) { + mContext = context; // 保存上下文 + mOnCompleteListener = listener; // 设置监听器 + mNotifiManager = (NotificationManager) mContext + .getSystemService(Context.NOTIFICATION_SERVICE); // 获取通知管理器 + mTaskManager = GTaskManager.getInstance(); // 获取 Google 任务管理器实例 + } + + // 取消同步操作的方法 + public void cancelSync() { + mTaskManager.cancelSync(); // 调用 Google 任务管理器的取消同步方法 + } + + // 发布进度更新的方法 + public void publishProgess(String message) { + publishProgress(new String[]{ message }); // 调用AsyncTask的publishProgress方法 + } + + /* + * 显示通知的方法 + * @param tickerId 通知的Ticker文本资源ID + * @param content 通知的内容文本 + */ + private void showNotification(int tickerId, String content) { + PendingIntent pendingIntent; + + // 根据不同的通知状态设置不同的Intent + if (tickerId != R.string.ticker_success) { + // 如果不是成功状态，跳转到设置界面 + pendingIntent = PendingIntent.getActivity(mContext, 0, new Intent(mContext, + NotesPreferenceActivity.class), 0); + } else { + // 如果是成功状态，跳转到任务列表界面 + pendingIntent = PendingIntent.getActivity(mContext, 0, new Intent(mContext, + NotesListActivity.class), 0); + } + + // 构建通知并显示 + Notification.Builder builder = new Notification.Builder(mContext) + .setAutoCancel(true) // 点击后自动消失 + .setContentTitle(mContext.getString(R.string.app_name)) // 通知标题 + .setContentText(content) // 通知内容 + .setContentIntent(pendingIntent) // 点击按钮处理 + .setWhen(System.currentTimeMillis()) // 通知时间 + .setOngoing(true); // 设定为进行中的通知 + Notification notification = builder.getNotification(); // 构建通知对象 + mNotifiManager.notify(GTASK_SYNC_NOTIFICATION_ID, notification); // 显示通知 + } + + /* + * 在后台执行同步操作的方法 + * @return 同步操作的状态码 + */ + @Override + protected Integer doInBackground(Void... unused) { + // 开始同步时的进度更新 + publishProgess(mContext.getString(R.string.sync_progress_login, NotesPreferenceActivity + .getSyncAccountName(mContext))); // 发布同步中的消息 + return mTaskManager.sync(mContext, this); // 执行同步操作，并返回状态码 + } + + /* + * 更新进度的方法，会在调用publishProgress后被调用 + * @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)); + } + // 如果设置了完成监听器，则在一个新线程中调用其onComplete方法 + if (mOnCompleteListener != null) { + new Thread(new Runnable() { + public void run() { + mOnCompleteListener.onComplete(); // 调用监听器的完成方法 + } + }).start(); + } + } +} diff --git a/src/gtask/remote/GTaskClient.java b/src/gtask/remote/GTaskClient.java new file mode 100644 index 0000000..e83cbfc --- /dev/null +++ b/src/gtask/remote/GTaskClient.java @@ -0,0 +1,1234 @@ +/* + * 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/"; + + // 用于获取任务信息的URL + private static final String GTASK_GET_URL = "https://mail.google.com/tasks/ig"; + + // 用于提交任务信息的URL + private static final String GTASK_POST_URL = "https://mail.google.com/tasks/r/ig"; + + // 单例模式实例 + private static GTaskClient mInstance = null; + + // HTTP客户端 + private DefaultHttpClient mHttpClient; + + // GET请求URL + private String mGetUrl; + + // POST请求URL + private String mPostUrl; + + // 客户端版本号 + private long mClientVersion; + + // 是否已登录 + private boolean mLoggedin; + + // 最后登录时间 + private long mLastLoginTime; + + // 操作ID，用于标识一次操作 + private int mActionId; + + // 用户账户信息 + private Account mAccount; + + // 用于存储更新数据的JSON数组 + private JSONArray mUpdateArray; + + /** + * GTaskClient的私有构造方法，初始化各种属性。 + */ + private GTaskClient() { + // 初始化客户端 + mHttpClient = null; + mGetUrl = GTASK_GET_URL; + mPostUrl = GTASK_POST_URL; + mClientVersion = -1; + mLoggedin = false; + mLastLoginTime = 0; + mActionId = 1; + mAccount = null; + mUpdateArray = null; + } + + /** + * 获取GTaskClient的单例实例。 + * + * @return GTaskClient的单例实例。 + */ + public static synchronized GTaskClient getInstance() { + // 确保仅创建一个实例 + if (mInstance == null) { + mInstance = new GTaskClient(); + } + return mInstance; + } + + /** + * 用户登录函数。 + * + * @param activity 当前活动，用于获取账户信息和上下文。 + * @return 登录成功返回true，失败返回false。 + */ + public boolean login(Activity activity) { + // 检查登录是否过期 + final long interval = 1000 * 60 * 5; // 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(); + // 尝试登录Google账户 + 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"))) { + // 构造自定义域名的登录URL + 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; + } + } + + // 如果使用自定义域名登录失败，则尝试使用官方URL登录 + if (!mLoggedin) { + mGetUrl = GTASK_GET_URL; + mPostUrl = GTASK_POST_URL; + if (!tryToLoginGtask(activity, authToken)) { + return false; + } + } + + // 登录成功 + mLoggedin = true; + return true; + } + + + /** + * 使用Google账户登录，获取授权令牌。 + * + * @param activity 当前活动，用于获取账户管理器。 + * @param invalidateToken 是否吊销之前的令牌并重新获取。 + * @return 返回获取到的授权令牌，如果失败或没有可用账户返回null。 + */ + private String loginGoogleAccount(Activity activity, boolean invalidateToken) { + String authToken; + // 获取账户管理器和所有Google账户 + AccountManager accountManager = AccountManager.get(activity); + Account[] accounts = accountManager.getAccountsByType("com.google"); + + // 检查是否有可用的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; + } + + // 获取授权令牌 + 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); + loginGoogleAccount(activity, false); + } + } catch (Exception e) { + Log.e(TAG, "get auth token failed"); + authToken = null; + } + + return authToken; + } + + /** + * 尝试使用授权令牌登录Gtask。 + * + * @param activity 当前活动，用于登录过程中的UI交互。 + * @param authToken 授权令牌。 + * @return 如果登录成功返回true，否则返回false。 + */ + private boolean tryToLoginGtask(Activity activity, String authToken) { + // 首次尝试登录Gtask + if (!loginGtask(authToken)) { + // 如果失败，尝试吊销令牌并重新获取后再次登录 + authToken = loginGoogleAccount(activity, true); + if (authToken == null) { + Log.e(TAG, "login google account failed"); + return false; + } + + // 使用新令牌再次尝试登录Gtask + if (!loginGtask(authToken)) { + Log.e(TAG, "login gtask failed"); + return false; + } + } + return true; + } + + /** + * 执行Gtask登录操作。 + * + * @param authToken 授权令牌。 + * @return 登录成功返回true，失败返回false。 + */ + private boolean loginGtask(String authToken) { + // 设置HTTP连接参数 + int timeoutConnection = 10000; + int timeoutSocket = 15000; + HttpParams httpParameters = new BasicHttpParams(); + HttpConnectionParams.setConnectionTimeout(httpParameters, timeoutConnection); + HttpConnectionParams.setSoTimeout(httpParameters, timeoutSocket); + 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; + } + + + /** + * 获取一个唯一的动作ID + * + * @return 返回当前动作的ID，每次调用自增 + */ + private int getActionId() { + return mActionId++; + } + + /** + * 创建一个HttpPost请求 + * + * @return 配置好的HttpPost对象 + */ + private HttpPost createHttpPost() { + HttpPost httpPost = new HttpPost(mPostUrl); + httpPost.setHeader("Content-Type", "application/x-www-form-urlencoded;charset=utf-8"); + httpPost.setHeader("AT", "1"); + return httpPost; + } + + /** + * 从HttpEntity中获取响应内容 + * + * @param entity Http响应实体 + * @return 响应内容的字符串 + * @throws IOException 当读取响应内容失败时抛出 + */ + 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请求，并返回解析后的JSONObject + * + * @param js 要发送的JSON对象 + * @return 请求响应的JSONObject + * @throws NetworkFailureException 当网络请求或处理失败时抛出 + */ + private JSONObject postRequest(JSONObject js) throws NetworkFailureException { + if (!mLoggedin) { + Log.e(TAG, "please login first"); + throw new ActionFailureException("not logged in"); + } + + HttpPost httpPost = createHttpPost(); + try { + 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); + String jsString = getResponseContent(response.getEntity()); + return new JSONObject(jsString); + + } catch (ClientProtocolException e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new NetworkFailureException("postRequest failed"); + } catch (IOException e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new NetworkFailureException("postRequest failed"); + } catch (JSONException e) { + 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 { + JSONObject jsPost = new JSONObject(); + JSONArray actionList = new JSONArray(); + + // 构建动作列表 + actionList.put(task.getCreateAction(getActionId())); + jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, actionList); + + // 添加客户端版本信息 + jsPost.put(GTaskStringUtils.GTASK_JSON_CLIENT_VERSION, mClientVersion); + + // 发送请求并处理响应 + 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) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new ActionFailureException("create task: handling jsonobject failed"); + } + } + + + /** + * 创建任务列表。 + * + * @param tasklist 任务列表对象，包含创建任务所需的信息。 + * @throws NetworkFailureException 网络请求失败时抛出。 + */ + /* + * 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/"; + + // 获取任务信息的 URL + private static final String GTASK_GET_URL = "https://mail.google.com/tasks/ig"; + + // 提交任务信息的 URL + private static final String GTASK_POST_URL = "https://mail.google.com/tasks/r/ig"; + + // 单例模式实例 + private static GTaskClient mInstance = null; + + // HTTP 客户端 + private DefaultHttpClient mHttpClient; + + // GET 请求 URL + private String mGetUrl; + + // POST 请求 URL + private String mPostUrl; + + // 客户端版本号 + private long mClientVersion; + + // 是否已登录 + private boolean mLoggedin; + + // 最后登录时间 + private long mLastLoginTime; + + // 操作 ID，用于标识一次操作 + private int mActionId; + + // 用户账户信息 + private Account mAccount; + + // 用于存储更新数据的 JSON 数组 + private JSONArray mUpdateArray; + + /** + * GTaskClient 的私有构造方法，初始化各种属性。 + */ + private GTaskClient() { + // 初始化客户端 + mHttpClient = null; + mGetUrl = GTASK_GET_URL; + mPostUrl = GTASK_POST_URL; + mClientVersion = -1; + mLoggedin = false; + mLastLoginTime = 0; + mActionId = 1; + mAccount = null; + mUpdateArray = null; + } + + /** + * 获取 GTaskClient 的单例实例。 + * + * @return GTaskClient 的单例实例。 + */ + public static synchronized GTaskClient getInstance() { + // 确保仅创建一个实例 + if (mInstance == null) { + mInstance = new GTaskClient(); + } + return mInstance; + } + + /** + * 用户登录函数。 + * + * @param activity 当前活动，用于获取账户信息和上下文。 + * @return 登录成功返回 true，失败返回 false。 + */ + public boolean login(Activity activity) { + // 检查登录是否过期 + final long interval = 1000 * 60 * 5; // 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(); + + // 尝试登录 Google 账户 + 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"))) { + // 构造自定义域名的登录 URL + 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; // 登录成功 + } + } + + // 如果使用自定义域名登录失败，则尝试使用官方 URL 登录 + if (!mLoggedin) { + mGetUrl = GTASK_GET_URL; + mPostUrl = GTASK_POST_URL; + if (!tryToLoginGtask(activity, authToken)) { + return false; // 登录失败 + } + } + + // 登录成功 + mLoggedin = true; + return true; + } + + /** + * 使用 Google 账户登录，获取授权令牌。 + * + * @param activity 当前活动，用于获取账户管理器。 + * @param invalidateToken 是否吊销之前的令牌并重新获取。 + * @return 返回获取到的授权令牌，如果失败或没有可用账户返回null。 + */ + private String loginGoogleAccount(Activity activity, boolean invalidateToken) { + String authToken; + // 获取账户管理器和所有 Google 账户 + AccountManager accountManager = AccountManager.get(activity); + Account[] accounts = accountManager.getAccountsByType("com.google"); + + // 检查是否有可用的 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; // 找不到账户 + } + + // 获取授权令牌 + 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); + loginGoogleAccount(activity, false); // 重新登录 + } + } catch (Exception e) { + Log.e(TAG, "get auth token failed"); + authToken = null; // 获取令牌失败 + } + + return authToken; // 返回授权令牌 + } + + /** + * 尝试使用授权令牌登录 Gtask。 + * + * @param activity 当前活动，用于登录过程中的 UI 交互。 + * @param authToken 授权令牌。 + * @return 如果登录成功返回 true，否则返回 false。 + */ + private boolean tryToLoginGtask(Activity activity, String authToken) { + // 首次尝试登录 Gtask + if (!loginGtask(authToken)) { + // 如果失败，尝试吊销令牌并重新获取后再次登录 + authToken = loginGoogleAccount(activity, true); + if (authToken == null) { + Log.e(TAG, "login google account failed"); + return false; // 登录失败 + } + + // 使用新令牌再次尝试登录 Gtask + if (!loginGtask(authToken)) { + Log.e(TAG, "login gtask failed"); + return false; // 登录失败 + } + } + return true; // 登录成功 + } + + /** + * 执行 Gtask 登录操作。 + * + * @param authToken 授权令牌。 + * @return 登录成功返回 true，失败返回 false。 + */ + private boolean loginGtask(String authToken) { + // 设置 HTTP 连接参数 + int timeoutConnection = 10000; // 连接超时 + int timeoutSocket = 15000; // 套接字超时 + HttpParams httpParameters = new BasicHttpParams(); + HttpConnectionParams.setConnectionTimeout(httpParameters, timeoutConnection); + HttpConnectionParams.setSoTimeout(httpParameters, timeoutSocket); + mHttpClient = new DefaultHttpClient(httpParameters); // 初始化 HTTP 客户端 + BasicCookieStore localBasicCookieStore = new BasicCookieStore(); + mHttpClient.setCookieStore(localBasicCookieStore); + HttpProtocolParams.setUseExpectContinue(mHttpClient.getParams(), false); + + // 使用授权令牌登录 Gtask + try { + String loginUrl = mGetUrl + "?auth=" + authToken; // 构造登录 URL + HttpGet httpGet = new HttpGet(loginUrl); + HttpResponse response = mHttpClient.execute(httpGet); // 执行 GET 请求 + + // 检查是否获取到授权 Cookie + List cookies = mHttpClient.getCookieStore().getCookies(); + boolean hasAuthCookie = false; + for (Cookie cookie : cookies) { + if (cookie.getName().contains("GTL")) { + hasAuthCookie = true; // 找到授权 Cookie + } + } + if (!hasAuthCookie) { + Log.w(TAG, "it seems that there is no auth cookie"); // 没有找到授权 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; // 解析 JSON 失败 + } catch (Exception e) { + Log.e(TAG, "httpget gtask_url failed"); + return false; // HTTP 请求失败 + } + + return true; // 登录成功 + } + + /** + * 获取一个唯一的动作 ID + * + * @return 返回当前动作的 ID，每次调用自增 + */ + private int getActionId() { + return mActionId++; + } + + /** + * 创建一个 HttpPost 请求 + * + * @return 配置好的 HttpPost 对象 + */ + private HttpPost createHttpPost() { + HttpPost httpPost = new HttpPost(mPostUrl); // 创建 POST 请求 + httpPost.setHeader("Content-Type", "application/x-www-form-urlencoded;charset=utf-8"); // 设置请求头 + httpPost.setHeader("AT", "1"); // 设置其他请求头 + return httpPost; + } + + /** + * 从 HttpEntity 中获取响应内容 + * + * @param entity Http 响应实体 + * @return 响应内容的字符串 + * @throws IOException 当读取响应内容失败时抛出 + */ + private String getResponseContent(HttpEntity entity) throws IOException { + String contentEncoding = null; // 内容编码 + if (entity.getContentEncoding() != null) { + contentEncoding = entity.getContentEncoding().getValue(); // 获取 encoding + 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.append(buff); // 添加每一行 + } + } finally { + input.close(); // 关闭输入流 + } + } + + /** + * 发送 POST 请求，并返回解析后的 JSONObject + * + * @param js 要发送的 JSON 对象 + * @return 请求响应的 JSONObject + * @throws NetworkFailureException 当网络请求或处理失败时抛出 + */ + private JSONObject postRequest(JSONObject js) throws NetworkFailureException { + if (!mLoggedin) { + Log.e(TAG, "please login first"); + throw new ActionFailureException("not logged in"); // 确保已登录 + } + + HttpPost httpPost = createHttpPost(); // 创建 POST 请求 + try { + 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); + String jsString = getResponseContent(response.getEntity()); // 读取响应内容 + return new JSONObject(jsString); // 返回 JSON 对象回复 + + } catch (ClientProtocolException e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new NetworkFailureException("postRequest failed"); // 网络请求失败 + } catch (IOException e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new NetworkFailureException("postRequest failed"); // 网络请求失败 + } catch (JSONException e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new ActionFailureException("unable to convert response content to jsonobject"); // JSON 解析失败 + } 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 { + JSONObject jsPost = new JSONObject(); // 创建 POST 请求的 JSON 对象 + JSONArray actionList = new JSONArray(); // 动作列表 + + // 构建动作列表 + actionList.put(task.getCreateAction(getActionId())); // 添加创建任务的动作 + jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, actionList); + + // 添加客户端版本信息 + jsPost.put(GTaskStringUtils.GTASK_JSON_CLIENT_VERSION, mClientVersion); + + // 发送请求并处理响应 + JSONObject jsResponse = postRequest(jsPost); + JSONObject jsResult = (JSONObject) jsResponse.getJSONArray( + GTaskStringUtils.GTASK_JSON_RESULTS).get(0); + task.setGid(jsResult.getString(GTaskStringUtils.GTASK_JSON_NEW_ID)); // 设置新任务的 ID + + } catch (JSONException e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new ActionFailureException("create task: handling jsonobject failed"); // JSON 处理失败 + } + } + + /** + * 创建任务列表。 + * + * @param tasklist 任务列表对象，包含创建任务所需的信息。 + * @throws NetworkFailureException 网络请求失败时抛出。 + */ +public void createTaskList(TaskList tasklist) throws NetworkFailureException { + commitUpdate(); // 提交更新，确保当前更新已处理 + + try { + JSONObject jsPost = new JSONObject(); // 创建POST请求的JSON对象 + JSONArray actionList = new JSONArray(); // 动作列表 + + // 添加创建任务的动作到动作列表 + actionList.put(tasklist.getCreateAction(getActionId())); // 获取任务列表创建的动作并添加 + jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, actionList); // 将动作列表放入JSON对象 + + // 添加客户端版本信息 + 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)); // 设置任务列表的全局唯一ID + + } catch (JSONException e) { + Log.e(TAG, e.toString()); // 记录异常 + e.printStackTrace(); + throw new ActionFailureException("create tasklist: handling JSON object failed"); // 处理JSON时失败 + } +} + +/** + * 提交待更新的任务信息。 + * + * 将存储在更新数组中的所有待处理变更发送到服务器。 + * + * @throws NetworkFailureException 网络请求失败时抛出。 + */ +public void commitUpdate() throws NetworkFailureException { + if (mUpdateArray != null) { // 检查更新数组是否为空 + try { + JSONObject jsPost = new JSONObject(); // 创建POST请求的JSON对象 + + // 添加更新的动作列表 + jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, mUpdateArray); + + // 添加客户端版本信息 + jsPost.put(GTaskStringUtils.GTASK_JSON_CLIENT_VERSION, mClientVersion); + + postRequest(jsPost); // 发送POST请求 + mUpdateArray = null; // 清空更新数组 + + } catch (JSONException e) { + Log.e(TAG, e.toString()); // 记录异常 + e.printStackTrace(); + throw new ActionFailureException("commit update: handling JSON object failed"); // 处理JSON时失败 + } + } +} + +/** + * 添加一个待更新的任务节点。 + * + * 将提供的任务节点信息添加到待更新的任务列表中。 + * + * @param node 待添加的节点信息。 + * @throws NetworkFailureException 网络请求失败时抛出。 + */ +public void addUpdateNode(Node node) throws NetworkFailureException { + if (node != null) { // 检查节点是否为空 + // 若更新节点过多，则提交当前更新 + 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(); // 创建POST请求的JSON对象 + 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()); // 设置动作ID + action.put(GTaskStringUtils.GTASK_JSON_ID, task.getGid()); // 设置要移动任务的ID + + if (preParent == curParent && task.getPriorSibling() != null) { + // 如果在同一任务列表内移动且不是第一个任务，则添加前置兄弟节点ID + action.put(GTaskStringUtils.GTASK_JSON_PRIOR_SIBLING_ID, task.getPriorSibling()); + } + + action.put(GTaskStringUtils.GTASK_JSON_SOURCE_LIST, preParent.getGid()); // 设置原任务列表ID + action.put(GTaskStringUtils.GTASK_JSON_DEST_PARENT, curParent.getGid()); // 设置新父任务列表ID + + if (preParent != curParent) { + // 如果跨任务列表移动，添加目标任务列表ID + action.put(GTaskStringUtils.GTASK_JSON_DEST_LIST, curParent.getGid()); + } + + actionList.put(action); // 将动作添加到列表 + jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, actionList); // 添加动作列表到JSON对象 + + // 添加客户端版本信息 + jsPost.put(GTaskStringUtils.GTASK_JSON_CLIENT_VERSION, mClientVersion); + + postRequest(jsPost); // 发送POST请求 + } catch (JSONException e) { + Log.e(TAG, e.toString()); // 记录异常 + e.printStackTrace(); + throw new ActionFailureException("move task: handling JSON object failed"); // 处理JSON时失败 + } +} + +/** + * 删除指定的任务节点。 + * + * @param node 要删除的节点。 + * @throws NetworkFailureException 网络请求失败时抛出。 + */ +public void deleteNode(Node node) throws NetworkFailureException { + commitUpdate(); // 提交当前更新 + + try { + JSONObject jsPost = new JSONObject(); // 创建POST请求的JSON对象 + 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); + + postRequest(jsPost); // 发送POST请求 + mUpdateArray = null; // 清空更新数组 + + } catch (JSONException e) { + Log.e(TAG, e.toString()); // 记录异常 + e.printStackTrace(); + throw new ActionFailureException("delete node: handling JSON object failed"); // 处理JSON时失败 + } +} + +/** + * 获取任务列表的网络请求。 + * 注意：调用此方法前需要确保用户已经登录。 + * + * @return JSONArray 返回一个包含任务列表的JSON数组。 + * @throws NetworkFailureException 如果网络请求失败则抛出此异常。 + */ +public JSONArray getTaskLists() throws NetworkFailureException { + if (!mLoggedin) { + Log.e(TAG, "please login first"); // 登录前的检查 + throw new ActionFailureException("not logged in"); // 确保已登录 + } + + try { + HttpGet httpGet = new HttpGet(mGetUrl); // 创建GET请求 + 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); // 提取JSON字符串 + } + JSONObject js = new JSONObject(jsString); + return js.getJSONObject("t").getJSONArray(GTaskStringUtils.GTASK_JSON_LISTS); // 返回任务列表的JSON数组 + } 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: handling JSON object failed"); // JSON处理失败 + } +} + +/** + * 根据列表ID获取特定任务列表的网络请求。 + * + * @param listGid 列表的全局唯一标识符。 + * @return JSONArray 返回一个包含特定任务列表的JSON数组。 + * @throws NetworkFailureException 如果网络请求失败则抛出此异常。 + */ +public JSONArray getTaskList(String listGid) throws NetworkFailureException { + commitUpdate(); // 提交当前更新 + try { + JSONObject jsPost = new JSONObject(); // 创建POST请求的JSON对象 + JSONArray actionList = new JSONArray(); // 动作列表 + JSONObject action = new JSONObject(); // 单个动作 + + // 构建请求参数 + action.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, + GTaskStringUtils.GTASK_JSON_ACTION_TYPE_GETALL); // 设置获取所有动作类型 + action.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, getActionId()); // 设置动作ID + action.put(GTaskStringUtils.GTASK_JSON_LIST_ID, listGid); // 设置列表ID + 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); // 返回任务的JSON数组 + } catch (JSONException e) { + Log.e(TAG, e.toString()); // 记录异常 + e.printStackTrace(); + throw new ActionFailureException("get task list: handling JSON object failed"); // JSON处理失败 + } +} + +/** + * 获取同步账户信息。 + * + * @return Account 返回当前的同步账户。 + */ +public Account getSyncAccount() { + return mAccount; // 返回同步账户信息 +} + +/** + * 重置更新数组。 + * 用于在进行新的同步之前清空或重置更新的数据数组。 + */ +public void resetUpdateArray() { + mUpdateArray = null; // 清空更新数组 +} + + diff --git a/src/gtask/remote/GTaskManager.java b/src/gtask/remote/GTaskManager.java new file mode 100644 index 0000000..82b7992 --- /dev/null +++ b/src/gtask/remote/GTaskManager.java @@ -0,0 +1,948 @@ +/* + * 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 { + // 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; + + // GTaskManager的单例实例。 + private static GTaskManager mInstance = null; + + // 关联的Activity对象。 + private Activity mActivity; + + // 上下文对象。 + private Context mContext; + + // 内容解析器。 + private ContentResolver mContentResolver; + + // 标记是否正在同步。 + private boolean mSyncing; + + // 标记是否已取消同步。 + private boolean mCancelled; + + // 保存任务列表的HashMap，键为列表ID，值为任务列表对象。 + private HashMap mGTaskListHashMap; + + // 保存任务的HashMap，键为任务ID，值为任务对象。 + private HashMap mGTaskHashMap; + + // 保存元数据的HashMap，键为元数据ID，值为元数据对象。 + private HashMap mMetaHashMap; + + // 元数据列表。 + private TaskList mMetaList; + + // 本地删除任务ID的集合。 + private HashSet mLocalDeleteIdMap; + + // 保存任务全局ID到本地ID的映射的HashMap。 + private HashMap mGidToNid; + + // 保存本地ID到任务全局ID的映射的HashMap。 + private HashMap mNidToGid; + + // GTaskManager的私有构造函数，初始化各种状态和映射。 + 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 的单例对象。 + * 采用单例模式确保全局仅有一个 GTaskManager 实例。 + * + * @return GTaskManager 的单例对象。 + */ + public static synchronized GTaskManager getInstance() { + if (mInstance == null) { + mInstance = new GTaskManager(); + } + return mInstance; + } + + /** + * 设置活动上下文。 + * 用于获取授权令牌。 + * + * @param activity 当前活动对象。 + */ + public synchronized void setActivityContext(Activity activity) { + mActivity = activity; + } + + /** + * 同步任务数据。 + * 会尝试与Google任务进行登录和数据同步，如果过程中发生错误或取消，则返回对应的状态码。 + * + * @param context 上下文对象，用于执行同步操作。 + * @param asyncTask 异步任务对象，用于在同步过程中更新进度。 + * @return 同步操作的状态码，可以是正在同步、网络错误、内部错误或同步取消。 + */ + 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; + mCancelled = false; + // 清理同步相关的数据结构 + mGTaskListHashMap.clear(); + mGTaskHashMap.clear(); + mMetaHashMap.clear(); + mLocalDeleteIdMap.clear(); + mGidToNid.clear(); + mNidToGid.clear(); + + 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(); + mSyncing = false; + } + + return mCancelled ? STATE_SYNC_CANCELLED : STATE_SUCCESS; + } + + /** + * 初始化 GTask 列表。 + * 该方法首先检查操作是否已被取消，然后从 GTaskClient 获取任务列表信息，并初始化元数据列表和任务列表。 + * 如果过程中发生网络错误，可能会抛出 NetworkFailureException 异常。 + * + * @throws NetworkFailureException 如果网络操作失败，则抛出此异常。 + */ + private void initGTaskList() throws NetworkFailureException { + if (mCancelled) // 检查是否取消了操作 + return; + + GTaskClient client = GTaskClient.getInstance(); // 获取 GTask 客户端实例 + + try { + 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) { + // 处理 JSON 解析异常 + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new ActionFailureException("initGTaskList: handling JSONObject failed"); + } + } + + + /** + * 同步内容数据。 + * 该方法首先处理本地已删除的笔记，然后同步文件夹信息，接着处理数据库中存在的笔记， + * 最后处理剩余的项目，并更新本地同步ID。如果在过程中检测到网络失败，则抛出网络失败异常。 + * + * @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)); // 添加到本地删除映射表 + } + } 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映射 + mNidToGid.put(c.getLong(SqlNote.ID_COLUMN), gid); + syncType = node.getSyncAction(c); // 获取同步动作 + } else { + if (c.getString(SqlNote.GTASK_ID_COLUMN).trim().length() == 0) { + // 如果没有GTask ID，则视为本地新增 + syncType = Node.SYNC_ACTION_ADD_REMOTE; + } else { + // 如果有GTask ID但本地不存在，则视为远程删除 + 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); // 将剩余项目作为本地新增处理 + } + + // 检查是否取消操作，清理本地删除表，并更新本地同步ID + 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 + } + + } + + /** + * 同步文件夹数据。 + * 该方法负责同步根文件夹、通话记录文件夹以及本地和远程存在的文件夹。 + * 它会根据文件夹的当前状态（是否存在、是否已同步）采取相应的同步操作，如添加、更新或删除。 + * + * @throws NetworkFailureException 如果网络操作失败 + */ + private void syncFolder() throws NetworkFailureException { + Cursor c = null; + String gid; + Node node; + int syncType; + + if (mCancelled) { + return; + } + + // 同步根文件夹 + 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); + node = mGTaskHashMap.get(gid); + // 判断节点是否为空，不为空则更新，为空则添加 + if (node != null) { + mGTaskHashMap.remove(gid); + mGidToNid.put(gid, (long) Notes.ID_ROOT_FOLDER); + mNidToGid.put((long) Notes.ID_ROOT_FOLDER, gid); + // 仅当系统文件夹的名称需要更新时执行内容同步 + 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; + } + } + + // 同步通话记录文件夹 + 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); + node = mGTaskHashMap.get(gid); + // 判断节点是否为空，不为空则更新，为空则添加 + if (node != null) { + mGTaskHashMap.remove(gid); + mGidToNid.put(gid, (long) Notes.ID_CALL_RECORD_FOLDER); + mNidToGid.put((long) Notes.ID_CALL_RECORD_FOLDER, gid); + // 仅当系统文件夹的名称需要更新时执行内容同步 + 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; + } + } + + // 同步本地已存在的文件夹 + 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); + node = mGTaskHashMap.get(gid); + // 判断节点是否为空，不为空则更新，为空则根据情况添加或删除 + if (node != null) { + mGTaskHashMap.remove(gid); + mGidToNid.put(gid, c.getLong(SqlNote.ID_COLUMN)); + mNidToGid.put(c.getLong(SqlNote.ID_COLUMN), gid); + 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 folder"); + } + } finally { + if (c != null) { + c.close(); + c = null; + } + } + + // 同步远程添加的文件夹 + Iterator> iter = mGTaskListHashMap.entrySet().iterator(); + while (iter.hasNext()) { + Map.Entry entry = iter.next(); + gid = entry.getKey(); + node = entry.getValue(); + if (mGTaskHashMap.containsKey(gid)) { + mGTaskHashMap.remove(gid); + 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: // 删除本地节点 + meta = mMetaHashMap.get(c.getString(SqlNote.GTASK_ID_COLUMN)); + if (meta != null) { + GTaskClient.getInstance().deleteNode(meta); // 从服务器删除节点 + } + mLocalDeleteIdMap.add(c.getLong(SqlNote.ID_COLUMN)); // 记录已删除的本地节点ID + break; + case Node.SYNC_ACTION_DEL_REMOTE: // 删除远程节点 + meta = mMetaHashMap.get(node.getGid()); + if (meta != null) { + GTaskClient.getInstance().deleteNode(meta); // 从服务器删除节点 + } + 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("unkown sync action type"); // 抛出未知同步操作类型的异常 + } + } + + + /** + * 将本地节点添加到数据库中。 + * 该方法首先检查操作是否已被取消，然后根据节点类型（任务列表或任务）创建相应的 SqlNote 对象。 + * 对于任务列表节点，会根据节点名称（默认文件夹或通话记录文件夹）设置特殊的 SqlNote 属性； + * 对于任务节点，会从节点内容中创建 JSON 对象，并根据需要调整其中的 ID 字段（如果这些 ID 在数据库中已存在）。 + * 最后，该方法会将 SqlNote 对象提交到数据库，并更新相关的 ID 映射关系。 + * + * @param node 要添加的本地节点，不应为 null。 + * @throws NetworkFailureException 如果添加节点过程中检测到网络失败。 + */ + private void addLocalNode(Node node) throws NetworkFailureException { + if (mCancelled) { + return; // 如果操作已取消，则直接返回，不执行添加操作 + } + + SqlNote sqlNote; + if (node instanceof TaskList) { + // 处理任务列表节点，根据节点名称设置特殊的 SqlNote 属性 + 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 { + // 处理任务节点，从节点内容创建 JSON 对象，并根据需要调整 ID 字段 + sqlNote = new SqlNote(mContext); + JSONObject js = node.getLocalJSONFromContent(); + try { + // 检查并处理 JSON 对象中的 Note 和 Data 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 + 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 + 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()); + } + + // 提交 SqlNote 到数据库，并更新 ID 映射关系 + sqlNote.setGtaskId(node.getGid()); + sqlNote.commit(false); + + 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，任务则查找父任务ID，否则默认为根文件夹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()); + 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()); + + // 查找任务所属的任务列表ID + String parentGid = mNidToGid.get(sqlNote.getParentId()); + 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()); + GTaskClient.getInstance().createTaskList(tasklist); + mGTaskListHashMap.put(tasklist.getGid(), tasklist); + } + n = (Node) tasklist; + } + + // 更新本地数据库中的笔记信息 + sqlNote.setGtaskId(n.getGid()); + sqlNote.commit(false); + sqlNote.resetLocalModified(); + sqlNote.commit(true); + + // 更新GID和ID的映射关系 + mGidToNid.put(n.getGid(), sqlNote.getId()); + mNidToGid.put(sqlNote.getId(), n.getGid()); + } + + + /** + * 更新远程节点信息。 + * + * @param node 需要更新的节点 + * @param c 数据库游标，用于获取节点的详细信息 + * @throws NetworkFailureException 如果网络操作失败，则抛出此异常 + */ + private void updateRemoteNode(Node node, Cursor c) throws NetworkFailureException { + if (mCancelled) { // 检查是否已取消操作 + return; + } + + SqlNote sqlNote = new SqlNote(mContext, c); // 从数据库游标中创建 SqlNote 对象 + + // 使用本地 JSON 格式更新远程节点内容 + node.setContentByLocalJSON(sqlNote.getContent()); + 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()); // 获取当前父任务列表的 GID + 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 元数据的全局标识符 + * @param sqlNote 包含元数据内容的 SqlNote 对象 + * @throws NetworkFailureException 如果网络操作失败，则抛出此异常 + */ + private void updateRemoteMeta(String gid, SqlNote sqlNote) throws NetworkFailureException { + if (sqlNote != null && sqlNote.isNoteType()) { // 确保是笔记类型 + MetaData metaData = mMetaHashMap.get(gid); // 尝试获取现有的元数据对象 + 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。 + * 该方法首先获取最新的gtask列表，然后通过查询本地笔记内容来更新这些笔记的同步ID。 + * 如果在查询过程中发现有本地项目在同步后没有对应的gtask ID，则抛出ActionFailureException异常。 + * + * @throws NetworkFailureException 如果网络操作失败。 + * @throws ActionFailureException 如果在同步后发现有本地项目没有对应的gtask ID。 + */ + private void refreshLocalSyncId() throws NetworkFailureException { + if (mCancelled) { + return; + } + + // 清空现有的gtask列表和元数据，准备获取最新的数据 + mGTaskHashMap.clear(); + mGTaskListHashMap.clear(); + mMetaHashMap.clear(); + initGTaskList(); + + Cursor c = null; + try { + // 查询本地笔记内容，准备更新同步ID + 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); + Node node = mGTaskHashMap.get(gid); + if (node != null) { + mGTaskHashMap.remove(gid); + ContentValues values = new ContentValues(); + values.put(NoteColumns.SYNC_ID, node.getLastModified()); + mContentResolver.update(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, + c.getLong(SqlNote.ID_COLUMN)), values, null, null); + } else { + // 如果查询到的笔记没有对应的gtask ID，则抛出异常 + Log.e(TAG, "something is missed"); + throw new ActionFailureException( + "some local items don't have gid after sync"); + } + } + } else { + // 如果查询操作失败，记录警告信息 + Log.w(TAG, "failed to query local note to refresh sync id"); + } + } finally { + // 释放Cursor资源 + if (c != null) { + c.close(); + c = null; + } + } + } + + /** + * 获取同步账户的名称。 + * + * @return 同步账户的名称。 + */ + public String getSyncAccount() { + return GTaskClient.getInstance().getSyncAccount().name; + } + + /** + * 取消同步操作。 + * 设置取消标志，终止正在进行的同步操作。 + */ + public void cancelSync() { + mCancelled = true; + } + +} diff --git a/src/gtask/remote/GTaskSyncService.java b/src/gtask/remote/GTaskSyncService.java new file mode 100644 index 0000000..388b08e --- /dev/null +++ b/src/gtask/remote/GTaskSyncService.java @@ -0,0 +1,169 @@ +/* + * GTaskSyncService类用于处理与Google任务同步相关的服务操作。 + */ +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; + +public class GTaskSyncService extends Service { + // 同步操作的类型 + public final static String ACTION_STRING_NAME = "sync_action_type"; + + // 启动同步的操作码 + public final static int ACTION_START_SYNC = 0; + + // 取消同步的操作码 + public final static int ACTION_CANCEL_SYNC = 1; + + // 无效操作的操作码 + public final static int ACTION_INVALID = 2; + + // 服务广播的名称，注册监听该广播的其他组件可以接收到同步状态和进度信息 + public final static String GTASK_SERVICE_BROADCAST_NAME = "net.micode.notes.gtask.remote.gtask_sync_service"; + + // 广播中携带的标志，表示目前是否正在进行同步 + public final static String GTASK_SERVICE_BROADCAST_IS_SYNCING = "isSyncing"; + + // 广播中的同步进度消息，告知接收者当前的同步进度 + public final static String GTASK_SERVICE_BROADCAST_PROGRESS_MSG = "progressMsg"; + + // 静态变量用于存储当前同步任务实例 + 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(); + } + } + + /* + * 服务创建时的初始化操作。 + * 重置同步任务为null，准备服务的生命周期。 + */ + @Override + public void onCreate() { + mSyncTask = null; // 确保没有正在执行的任务 + } + + /* + * 处理服务启动时的命令。 + * 根据传入的意图参数决定是启动同步还是取消同步。 + */ + @Override + public int onStartCommand(Intent intent, int flags, int startId) { + Bundle bundle = intent.getExtras(); // 获取传入的附加数据 + if (bundle != null && bundle.containsKey(ACTION_STRING_NAME)) { + // 根据操作类型决定行为 + switch (bundle.getInt(ACTION_STRING_NAME, ACTION_INVALID)) { + case ACTION_START_SYNC: + startSync(); // 启动同步 + break; + case ACTION_CANCEL_SYNC: + cancelSync(); // 取消同步 + break; + default: + break; // 无效操作，忽略 + } + return START_STICKY; // 服务将在系统资源不足时重启 + } + return super.onStartCommand(intent, flags, startId); // 默认处理 + } + + /* + * 低内存时调用，取消同步任务。 + */ + @Override + public void onLowMemory() { + // 如果有正在执行的同步任务，则取消 + if (mSyncTask != null) { + mSyncTask.cancelSync(); + } + } + + // 服务绑定时返回null，此服务不提供绑定功能 + public IBinder onBind(Intent intent) { + return null; // 不支持绑定，返回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; // 返回进度消息 + } +}