/* * 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; /** * 数据库笔记类（用于与Google Task同步） * 负责在SQLite数据库和JSON格式之间转换笔记数据 */ public class SqlNote { private static final String TAG = SqlNote.class.getSimpleName(); // 日志标签 private static final int INVALID_ID = -99999; // 无效ID常量 // 数据库查询的投影字段（需要查询的列） 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; // ID列索引 public static final int ALERTED_DATE_COLUMN = 1; // 提醒日期列索引 public static final int BG_COLOR_ID_COLUMN = 2; // 背景颜色ID列索引 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; // 父ID列索引 public static final int SNIPPET_COLUMN = 8; // 摘要内容列索引 public static final int TYPE_COLUMN = 9; // 类型列索引 public static final int WIDGET_ID_COLUMN = 10; // 小部件ID列索引 public static final int WIDGET_TYPE_COLUMN = 11; // 小部件类型列索引 public static final int SYNC_ID_COLUMN = 12; // 同步ID列索引 public static final int LOCAL_MODIFIED_COLUMN = 13; // 本地修改标记列索引 public static final int ORIGIN_PARENT_ID_COLUMN = 14; // 原始父ID列索引 public static final int GTASK_ID_COLUMN = 15; // Google Task ID列索引 public static final int VERSION_COLUMN = 16; // 版本号列索引 private Context mContext; // 上下文对象 private ContentResolver mContentResolver; // 内容解析器，用于数据库操作 private boolean mIsCreate; // 标记是否为新建笔记（true表示新建，false表示从数据库加载） private long mId; // 笔记ID private long mAlertDate; // 提醒日期 private int mBgColorId; // 背景颜色ID private long mCreatedDate; // 创建日期 private int mHasAttachment; // 是否有附件（0表示无，1表示有） 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; // 笔记内容数据列表（用于普通笔记类型） /** * 构造函数 - 创建新笔记对象 * 初始化所有字段为默认值，标记为创建状态 * @param context 上下文 */ public SqlNote(Context context) { mContext = context; mContentResolver = context.getContentResolver(); mIsCreate = true; // 标记为新建笔记 mId = INVALID_ID; // 使用无效ID mAlertDate = 0; // 默认无提醒 mBgColorId = ResourceParser.getDefaultBgId(context); // 获取默认背景颜色ID mCreatedDate = System.currentTimeMillis(); // 使用当前时间作为创建时间 mHasAttachment = 0; // 默认无附件 mModifiedDate = System.currentTimeMillis(); // 使用当前时间作为修改时间 mParentId = 0; // 默认父ID为0 mSnippet = ""; // 空摘要 mType = Notes.TYPE_NOTE; // 默认为普通笔记类型 mWidgetId = AppWidgetManager.INVALID_APPWIDGET_ID; // 无效的小部件ID mWidgetType = Notes.TYPE_WIDGET_INVALIDE; // 无效的小部件类型 mOriginParent = 0; // 默认原始父ID为0 mVersion = 0; // 初始版本为0 mDiffNoteValues = new ContentValues(); // 初始化更新字段容器 mDataList = new ArrayList(); // 初始化数据列表 } /** * 构造函数 - 从数据库游标加载笔记对象 * 从数据库查询结果中加载笔记数据，并加载关联的笔记内容 * @param context 上下文 * @param c 数据库游标，包含笔记数据 */ public SqlNote(Context context, Cursor c) { mContext = context; mContentResolver = context.getContentResolver(); mIsCreate = false; // 标记为从数据库加载 loadFromCursor(c); // 从游标加载数据 mDataList = new ArrayList(); // 初始化数据列表 if (mType == Notes.TYPE_NOTE) loadDataContent(); // 如果是普通笔记类型，加载笔记内容数据 mDiffNoteValues = new ContentValues(); // 初始化更新字段容器 } /** * 构造函数 - 通过笔记ID加载笔记对象 * 根据笔记ID查询数据库并加载笔记数据 * @param context 上下文 * @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(); // 初始化更新字段容器 } /** * 通过笔记ID从数据库加载笔记数据 * 根据ID查询数据库并将结果加载到对象字段中 * @param id 笔记ID */ private void loadFromCursor(long id) { Cursor c = null; try { // 查询指定ID的笔记 c = mContentResolver.query(Notes.CONTENT_NOTE_URI, PROJECTION_NOTE, "(_id=?)", new String[] { String.valueOf(id) }, null); if (c != null) { c.moveToNext(); // 移动到查询结果的第一行 loadFromCursor(c); // 从游标加载数据 } else { Log.w(TAG, "loadFromCursor: cursor = null"); // 日志记录游标为空 } } finally { if (c != null) c.close(); // 关闭游标 } } /** * 从游标加载数据到对象字段 * 将数据库游标中的数据赋值给对象的各个字段 * @param c 数据库游标 */ private void loadFromCursor(Cursor c) { mId = c.getLong(ID_COLUMN); // 获取笔记ID mAlertDate = c.getLong(ALERTED_DATE_COLUMN); // 获取提醒日期 mBgColorId = c.getInt(BG_COLOR_ID_COLUMN); // 获取背景颜色ID mCreatedDate = c.getLong(CREATED_DATE_COLUMN); // 获取创建日期 mHasAttachment = c.getInt(HAS_ATTACHMENT_COLUMN); // 获取是否有附件 mModifiedDate = c.getLong(MODIFIED_DATE_COLUMN); // 获取修改日期 mParentId = c.getLong(PARENT_ID_COLUMN); // 获取父文件夹ID mSnippet = c.getString(SNIPPET_COLUMN); // 获取笔记摘要 mType = c.getInt(TYPE_COLUMN); // 获取笔记类型 mWidgetId = c.getInt(WIDGET_ID_COLUMN); // 获取小部件ID mWidgetType = c.getInt(WIDGET_TYPE_COLUMN); // 获取小部件类型 mVersion = c.getLong(VERSION_COLUMN); // 获取版本号 } /** * 加载笔记的内容数据 * 查询笔记关联的内容数据（如文本内容）并加载到数据列表 */ private void loadDataContent() { Cursor c = null; mDataList.clear(); // 清空数据列表 try { // 查询笔记的内容数据 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; } while (c.moveToNext()) { SqlData data = new SqlData(mContext, c); // 创建SqlData对象 mDataList.add(data); // 添加到数据列表 } } else { Log.w(TAG, "loadDataContent: cursor = null"); // 日志记录游标为空 } } finally { if (c != null) c.close(); // 关闭游标 } } /** * 从JSON对象设置笔记内容 * 解析JSON数据并更新笔记对象的各个字段 * @param js 包含笔记数据的JSON对象 * @return 设置成功返回true，失败返回false */ public boolean setContent(JSONObject js) { try { JSONObject note = js.getJSONObject(GTaskStringUtils.META_HEAD_NOTE); // 获取笔记JSON对象 if (note.getInt(NoteColumns.TYPE) == Notes.TYPE_SYSTEM) { Log.w(TAG, "cannot set system folder"); // 系统文件夹不能设置 } else if (note.getInt(NoteColumns.TYPE) == Notes.TYPE_FOLDER) { // 对于文件夹类型，只能更新摘要和类型 String snippet = note.has(NoteColumns.SNIPPET) ? note .getString(NoteColumns.SNIPPET) : ""; // 获取摘要，如果不存在则为空字符串 if (mIsCreate || !mSnippet.equals(snippet)) { mDiffNoteValues.put(NoteColumns.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; // 获取笔记ID if (mIsCreate || mId != id) { mDiffNoteValues.put(NoteColumns.ID, id); // 如果ID发生变化，记录更新 } mId = id; // 更新ID字段 long alertDate = note.has(NoteColumns.ALERTED_DATE) ? note .getLong(NoteColumns.ALERTED_DATE) : 0; // 获取提醒日期 if (mIsCreate || mAlertDate != alertDate) { mDiffNoteValues.put(NoteColumns.ALERTED_DATE, alertDate); // 如果提醒日期变化，记录更新 } mAlertDate = alertDate; // 更新提醒日期字段 int bgColorId = note.has(NoteColumns.BG_COLOR_ID) ? note .getInt(NoteColumns.BG_COLOR_ID) : ResourceParser.getDefaultBgId(mContext); // 获取背景颜色ID if (mIsCreate || mBgColorId != bgColorId) { mDiffNoteValues.put(NoteColumns.BG_COLOR_ID, bgColorId); // 如果背景颜色变化，记录更新 } mBgColorId = bgColorId; // 更新背景颜色ID字段 long createDate = note.has(NoteColumns.CREATED_DATE) ? note .getLong(NoteColumns.CREATED_DATE) : System.currentTimeMillis(); // 获取创建日期 if (mIsCreate || mCreatedDate != createDate) { mDiffNoteValues.put(NoteColumns.CREATED_DATE, createDate); // 如果创建日期变化，记录更新 } mCreatedDate = createDate; // 更新创建日期字段 int hasAttachment = note.has(NoteColumns.HAS_ATTACHMENT) ? note .getInt(NoteColumns.HAS_ATTACHMENT) : 0; // 获取是否有附件 if (mIsCreate || mHasAttachment != hasAttachment) { mDiffNoteValues.put(NoteColumns.HAS_ATTACHMENT, hasAttachment); // 如果附件状态变化，记录更新 } mHasAttachment = hasAttachment; // 更新附件字段 long modifiedDate = note.has(NoteColumns.MODIFIED_DATE) ? note .getLong(NoteColumns.MODIFIED_DATE) : System.currentTimeMillis(); // 获取修改日期 if (mIsCreate || mModifiedDate != modifiedDate) { mDiffNoteValues.put(NoteColumns.MODIFIED_DATE, modifiedDate); // 如果修改日期变化，记录更新 } mModifiedDate = modifiedDate; // 更新修改日期字段 long parentId = note.has(NoteColumns.PARENT_ID) ? note .getLong(NoteColumns.PARENT_ID) : 0; // 获取父文件夹ID if (mIsCreate || mParentId != parentId) { mDiffNoteValues.put(NoteColumns.PARENT_ID, parentId); // 如果父ID变化，记录更新 } mParentId = parentId; // 更新父ID字段 String snippet = note.has(NoteColumns.SNIPPET) ? note .getString(NoteColumns.SNIPPET) : ""; // 获取摘要 if (mIsCreate || !mSnippet.equals(snippet)) { mDiffNoteValues.put(NoteColumns.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; // 更新类型字段 int widgetId = note.has(NoteColumns.WIDGET_ID) ? note.getInt(NoteColumns.WIDGET_ID) : AppWidgetManager.INVALID_APPWIDGET_ID; // 获取小部件ID if (mIsCreate || mWidgetId != widgetId) { mDiffNoteValues.put(NoteColumns.WIDGET_ID, widgetId); // 如果小部件ID变化，记录更新 } mWidgetId = widgetId; // 更新小部件ID字段 int widgetType = note.has(NoteColumns.WIDGET_TYPE) ? note .getInt(NoteColumns.WIDGET_TYPE) : Notes.TYPE_WIDGET_INVALIDE; // 获取小部件类型 if (mIsCreate || mWidgetType != widgetType) { mDiffNoteValues.put(NoteColumns.WIDGET_TYPE, widgetType); // 如果小部件类型变化，记录更新 } mWidgetType = widgetType; // 更新小部件类型字段 long originParent = note.has(NoteColumns.ORIGIN_PARENT_ID) ? note .getLong(NoteColumns.ORIGIN_PARENT_ID) : 0; // 获取原始父文件夹ID if (mIsCreate || mOriginParent != originParent) { mDiffNoteValues.put(NoteColumns.ORIGIN_PARENT_ID, originParent); // 如果原始父ID变化，记录更新 } mOriginParent = originParent; // 更新原始父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); // 获取内容数据ID // 在现有数据列表中查找匹配的内容数据 for (SqlData temp : mDataList) { if (dataId == temp.getId()) { sqlData = temp; // 找到已存在的数据 } } } if (sqlData == null) { sqlData = new SqlData(mContext); // 创建新的内容数据对象 mDataList.add(sqlData); // 添加到数据列表 } sqlData.setContent(data); // 设置内容数据 } } } catch (JSONException e) { Log.e(TAG, e.toString()); // 记录JSON解析异常 e.printStackTrace(); return false; // 返回失败 } return true; // 返回成功 } /** * 获取笔记的JSON表示 * 将笔记对象转换为JSON格式，用于同步或传输 * @return 包含笔记数据的JSON对象，失败返回null */ public JSONObject getContent() { try { JSONObject js = new JSONObject(); // 创建JSON对象 if (mIsCreate) { Log.e(TAG, "it seems that we haven't created this in database yet"); // 日志记录笔记尚未创建 return null; // 返回null } JSONObject note = new JSONObject(); // 创建笔记JSON对象 if (mType == Notes.TYPE_NOTE) { // 普通笔记类型，包含所有字段 note.put(NoteColumns.ID, mId); // 添加ID note.put(NoteColumns.ALERTED_DATE, mAlertDate); // 添加提醒日期 note.put(NoteColumns.BG_COLOR_ID, mBgColorId); // 添加背景颜色ID note.put(NoteColumns.CREATED_DATE, mCreatedDate); // 添加创建日期 note.put(NoteColumns.HAS_ATTACHMENT, mHasAttachment); // 添加附件状态 note.put(NoteColumns.MODIFIED_DATE, mModifiedDate); // 添加修改日期 note.put(NoteColumns.PARENT_ID, mParentId); // 添加父文件夹ID note.put(NoteColumns.SNIPPET, mSnippet); // 添加摘要 note.put(NoteColumns.TYPE, mType); // 添加类型 note.put(NoteColumns.WIDGET_ID, mWidgetId); // 添加小部件ID note.put(NoteColumns.WIDGET_TYPE, mWidgetType); // 添加小部件类型 note.put(NoteColumns.ORIGIN_PARENT_ID, mOriginParent); // 添加原始父文件夹ID js.put(GTaskStringUtils.META_HEAD_NOTE, note); // 将笔记对象添加到JSON // 添加笔记内容数据 JSONArray dataArray = new JSONArray(); // 创建内容数据数组 for (SqlData sqlData : mDataList) { JSONObject data = sqlData.getContent(); // 获取内容数据的JSON if (data != null) { dataArray.put(data); // 添加到数组 } } js.put(GTaskStringUtils.META_HEAD_DATA, dataArray); // 将内容数据数组添加到JSON } else if (mType == Notes.TYPE_FOLDER || mType == Notes.TYPE_SYSTEM) { // 文件夹或系统文件夹类型，只包含必要字段 note.put(NoteColumns.ID, mId); // 添加ID note.put(NoteColumns.TYPE, mType); // 添加类型 note.put(NoteColumns.SNIPPET, mSnippet); // 添加摘要 js.put(GTaskStringUtils.META_HEAD_NOTE, note); // 将笔记对象添加到JSON } return js; // 返回JSON对象 } catch (JSONException e) { Log.e(TAG, e.toString()); // 记录JSON异常 e.printStackTrace(); } return null; // 返回null } /** * 设置父文件夹ID * 更新笔记的父文件夹ID，并记录需要更新的字段 * @param id 父文件夹ID */ public void setParentId(long id) { mParentId = id; // 更新父文件夹ID字段 mDiffNoteValues.put(NoteColumns.PARENT_ID, id); // 记录需要更新的字段 } /** * 设置Google Task ID * 更新笔记的Google Task ID，用于同步 * @param gid Google Task ID */ public void setGtaskId(String gid) { mDiffNoteValues.put(NoteColumns.GTASK_ID, gid); // 记录需要更新的字段 } /** * 设置同步ID * 更新笔记的同步ID，用于同步控制 * @param syncId 同步ID */ public void setSyncId(long syncId) { mDiffNoteValues.put(NoteColumns.SYNC_ID, syncId); // 记录需要更新的字段 } /** * 重置本地修改标记 * 将本地修改标记设为0，表示笔记已同步 */ public void resetLocalModified() { mDiffNoteValues.put(NoteColumns.LOCAL_MODIFIED, 0); // 记录需要更新的字段 } /** * 获取笔记ID * @return 笔记ID */ public long getId() { return mId; } /** * 获取父文件夹ID * @return 父文件夹ID */ public long getParentId() { return mParentId; } /** * 获取笔记摘要 * @return 笔记摘要 */ public String getSnippet() { return mSnippet; } /** * 检查笔记是否为普通笔记类型 * @return 如果是普通笔记类型返回true，否则返回false */ public boolean isNoteType() { return mType == Notes.TYPE_NOTE; } /** * 提交笔记更改到数据库 * 将笔记对象的更改保存到数据库，包括新建或更新操作 * @param validateVersion 是否验证版本号（用于乐观锁控制） */ public void commit(boolean validateVersion) { if (mIsCreate) { // 新建笔记操作 if (mId == INVALID_ID && mDiffNoteValues.containsKey(NoteColumns.ID)) { mDiffNoteValues.remove(NoteColumns.ID); // 如果ID为无效值且存在于更新字段中，移除它 } Uri uri = mContentResolver.insert(Notes.CONTENT_NOTE_URI, mDiffNoteValues); // 插入新笔记到数据库 try { mId = Long.valueOf(uri.getPathSegments().get(1)); // 从返回的URI中获取新笔记的ID } catch (NumberFormatException e) { Log.e(TAG, "Get note id error :" + e.toString()); // 记录获取ID异常 throw new ActionFailureException("create note failed"); // 抛出创建失败异常 } if (mId == 0) { throw new IllegalStateException("Create thread id failed"); // 如果ID为0，抛出异常 } // 如果是普通笔记类型，提交笔记内容数据 if (mType == Notes.TYPE_NOTE) { for (SqlData sqlData : mDataList) { sqlData.commit(mId, false, -1); // 提交内容数据，不验证版本 } } } else { // 更新笔记操作 if (mId <= 0 && mId != Notes.ID_ROOT_FOLDER && mId != Notes.ID_CALL_RECORD_FOLDER) { Log.e(TAG, "No such note"); // 日志记录无效ID throw new IllegalStateException("Try to update note with invalid id"); // 抛出无效ID异常 } if (mDiffNoteValues.size() > 0) { mVersion ++; // 版本号递增 int result = 0; if (!validateVersion) { // 不验证版本号，直接更新 result = mContentResolver.update(Notes.CONTENT_NOTE_URI, mDiffNoteValues, "(" + NoteColumns.ID + "=?)", new String[] { String.valueOf(mId) }); } else { // 验证版本号，使用乐观锁控制 result = mContentResolver.update(Notes.CONTENT_NOTE_URI, mDiffNoteValues, "(" + NoteColumns.ID + "=?) AND (" + NoteColumns.VERSION + "<=?)", new String[] { String.valueOf(mId), String.valueOf(mVersion) }); } if (result == 0) { Log.w(TAG, "there is no update. maybe user updates note when syncing"); // 日志记录无更新 } } // 如果是普通笔记类型，提交笔记内容数据的更改 if (mType == Notes.TYPE_NOTE) { for (SqlData sqlData : mDataList) { sqlData.commit(mId, validateVersion, mVersion); // 提交内容数据，可能验证版本 } } } // 重新从数据库加载笔记数据，确保对象状态与数据库一致 loadFromCursor(mId); if (mType == Notes.TYPE_NOTE) loadDataContent(); // 重新加载笔记内容数据 mDiffNoteValues.clear(); // 清空更新字段容器 mIsCreate = false; // 标记为非新建状态 } }