/* * 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; public class SqlNote { private static final String TAG = SqlNote.class.getSimpleName(); private static final int INVALID_ID = -99999; /** * 1.作用:定义笔记查询的默认投影列 * 2.常量名:PROJECTION_NOTE * 3.类型:String[] * 4.功能: * 指定查询笔记表时默认返回的列 * 优化查询性能,避免返回不必要的列 * 统一数据访问接口,降低耦合度 */ 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 }; /** * 1.作用:定义笔记投影列的索引位置 * 2.常量类型:int * 3.功能: * 为PROJECTION_NOTE数组中的列定义固定索引 * 在Cursor操作中快速定位特定列 * 避免直接使用魔法数字,提高代码可读性 */ public static final int ID_COLUMN = 0; public static final int ALERTED_DATE_COLUMN = 1; public static final int BG_COLOR_ID_COLUMN = 2; public static final int CREATED_DATE_COLUMN = 3; public static final int HAS_ATTACHMENT_COLUMN = 4; public static final int MODIFIED_DATE_COLUMN = 5; public static final int NOTES_COUNT_COLUMN = 6; public static final int PARENT_ID_COLUMN = 7; public static final int SNIPPET_COLUMN = 8; public static final int TYPE_COLUMN = 9; public static final int WIDGET_ID_COLUMN = 10; public static final int WIDGET_TYPE_COLUMN = 11; public static final int SYNC_ID_COLUMN = 12; public static final int LOCAL_MODIFIED_COLUMN = 13; public static final int ORIGIN_PARENT_ID_COLUMN = 14; public static final int GTASK_ID_COLUMN = 15; public static final int VERSION_COLUMN = 16; /** * 1.作用:应用上下文引用 * 2.类型:Context * 3.功能: * 提供应用环境资源访问 * 初始化ContentResolver * 获取系统服务 */ private Context mContext; /** * 1.作用:内容解析器 * 2.类型:ContentResolver * 3.功能: * 执行数据库CRUD操作 * 发送数据变化通知 * 跨进程数据共享 */ private ContentResolver mContentResolver; /** * 1.作用:对象创建状态标识 * 2.类型:boolean * 3.功能: * 标记对象是否为新建状态 * 决定保存操作类型(插入/更新) * 控制差异值跟踪逻辑 */ private boolean mIsCreate; /** * 1.作用:笔记ID * 2.类型:long * 3.功能: * 笔记唯一标识 * 数据库主键 * 关联其他数据的外键 */ private long mId; /** * 1.作用:提醒日期 * 2.类型:long * 3.功能: * 存储笔记提醒时间戳 * 用于日历提醒功能 * 支持定时通知 */ private long mAlertDate; /** * 1.作用:背景颜色ID * 2.类型:int * 3.功能: * 存储笔记背景颜色标识 * 用于UI展示差异化 * 支持主题切换 */ private int mBgColorId; /** * 1.作用:创建日期 * 2.类型:long * 3.功能: * 记录笔记创建时间戳 * 用于排序和过滤 * 数据同步参考 */ private long mCreatedDate; /** * 1.作用:附件状态 * 2.类型:int * 3.功能: * 标记笔记是否包含附件 * 0表示无附件 * 1表示有附件 */ private int mHasAttachment; /** * 1.作用:修改日期 * 2.类型:long * 3.功能: * 记录笔记最后修改时间戳 * 用于排序和同步 * 版本控制参考 */ private long mModifiedDate; /** * 1.作用:父文件夹ID * 2.类型:long * 3.功能: * 定义笔记所属文件夹 * 支持笔记分类管理 * 构建笔记层级结构 */ private long mParentId; /** * 1.作用:笔记摘要 * 2.类型:String * 3.功能: * 存储笔记内容摘要 * 用于列表快速预览 * 搜索匹配字段 */ private String mSnippet; private int mType; private int mWidgetId; private int mWidgetType; private long mOriginParent; private long mVersion; private ContentValues mDiffNoteValues; private ArrayList mDataList; /** * 1.作用:创建新笔记对象 * 2.方法名:SqlNote * 3.参数: * Context context:应用上下文 * 4.功能: * 初始化新笔记对象 * 设置默认值 * 准备差异值跟踪 */ public SqlNote(Context context) { mContext = context; mContentResolver = context.getContentResolver(); mIsCreate = true; mId = INVALID_ID; mAlertDate = 0; mBgColorId = ResourceParser.getDefaultBgId(context); mCreatedDate = System.currentTimeMillis(); mHasAttachment = 0; mModifiedDate = System.currentTimeMillis(); mParentId = 0; mSnippet = ""; mType = Notes.TYPE_NOTE; mWidgetId = AppWidgetManager.INVALID_APPWIDGET_ID; mWidgetType = Notes.TYPE_WIDGET_INVALIDE; mOriginParent = 0; mVersion = 0; mDiffNoteValues = new ContentValues(); mDataList = new ArrayList(); } /** * 1.作用:从Cursor加载现有笔记对象 * 2.方法名:SqlNote * 3.参数: * Context context:应用上下文 * Cursor c:包含笔记数据的Cursor * 4.功能: * 从数据库查询结果初始化笔记对象 * 自动加载关联的内容数据 * 设置对象为已存在状态 */ 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(); } /** * 1.作用:根据ID加载现有笔记对象 * 2.方法名:SqlNote * 3.参数: * Context context:应用上下文 * long id:笔记ID */ public SqlNote(Context context, long id) { mContext = context; mContentResolver = context.getContentResolver(); mIsCreate = false; loadFromCursor(id); mDataList = new ArrayList(); if (mType == Notes.TYPE_NOTE) loadDataContent(); mDiffNoteValues = new ContentValues(); } /** * 1.作用:根据ID从数据库加载笔记数据 * 2.方法名:loadFromCursor * 3.参数: * long id:笔记ID * 4.功能: * 执行数据库查询获取笔记数据 * 调用loadFromCursor(Cursor)填充对象 * 管理Cursor生命周期 */ private void loadFromCursor(long id) { Cursor c = null; try { 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(); } } /** * 1.作用:从Cursor解析笔记数据到对象 * 2.方法名:loadFromCursor * 3.参数: * Cursor c:包含笔记数据的Cursor * 4.功能: * 将Cursor中的数据映射到对象字段 * 使用预定义的列索引常量定位数据 * 支持从数据库查询结果初始化对象 */ private void loadFromCursor(Cursor c) { mId = c.getLong(ID_COLUMN); mAlertDate = c.getLong(ALERTED_DATE_COLUMN); mBgColorId = c.getInt(BG_COLOR_ID_COLUMN); mCreatedDate = c.getLong(CREATED_DATE_COLUMN); mHasAttachment = c.getInt(HAS_ATTACHMENT_COLUMN); mModifiedDate = c.getLong(MODIFIED_DATE_COLUMN); mParentId = c.getLong(PARENT_ID_COLUMN); mSnippet = c.getString(SNIPPET_COLUMN); mType = c.getInt(TYPE_COLUMN); mWidgetId = c.getInt(WIDGET_ID_COLUMN); mWidgetType = c.getInt(WIDGET_TYPE_COLUMN); mVersion = c.getLong(VERSION_COLUMN); } /** * 1. 作用:加载笔记关联的内容数据 * 2. 方法名:loadDataContent * 3. 参数:无 * 4. 功能: * 从数据库查询并加载笔记的所有内容数据 * 初始化mDataList集合 * 处理空数据和异常情况 */ 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); mDataList.add(data); } } else { Log.w(TAG, "loadDataContent: cursor = null"); } } finally { if (c != null) c.close(); } } /** * 1. 作用:从JSON对象设置笔记数据 * 2. 方法名:setContent * 3. 参数: * JSONObject js:包含笔记数据的JSON对象 * 4. 返回类型:boolean * 5. 功能: * 解析JSON数据并映射到笔记对象 * 自动检测数据变化并记录差异 * 处理不同类型笔记的特殊逻辑 * 加载关联的内容数据 */ public boolean setContent(JSONObject js) { try { JSONObject note = js.getJSONObject(GTaskStringUtils.META_HEAD_NOTE); if (note.getInt(NoteColumns.TYPE) == Notes.TYPE_SYSTEM) { Log.w(TAG, "cannot set system folder"); } else if (note.getInt(NoteColumns.TYPE) == Notes.TYPE_FOLDER) { // for folder we can only update the snnipet and type String snippet = note.has(NoteColumns.SNIPPET) ? note .getString(NoteColumns.SNIPPET) : ""; if (mIsCreate || !mSnippet.equals(snippet)) { mDiffNoteValues.put(NoteColumns.SNIPPET, snippet); } mSnippet = snippet; 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); } mId = 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); if (mIsCreate || mBgColorId != bgColorId) { mDiffNoteValues.put(NoteColumns.BG_COLOR_ID, bgColorId); } mBgColorId = bgColorId; 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; if (mIsCreate || mParentId != parentId) { mDiffNoteValues.put(NoteColumns.PARENT_ID, parentId); } mParentId = parentId; 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; if (mIsCreate || mWidgetId != widgetId) { mDiffNoteValues.put(NoteColumns.WIDGET_ID, widgetId); } mWidgetId = widgetId; int widgetType = note.has(NoteColumns.WIDGET_TYPE) ? note .getInt(NoteColumns.WIDGET_TYPE) : Notes.TYPE_WIDGET_INVALIDE; if (mIsCreate || mWidgetType != widgetType) { mDiffNoteValues.put(NoteColumns.WIDGET_TYPE, widgetType); } mWidgetType = widgetType; long originParent = note.has(NoteColumns.ORIGIN_PARENT_ID) ? note .getLong(NoteColumns.ORIGIN_PARENT_ID) : 0; if (mIsCreate || mOriginParent != originParent) { mDiffNoteValues.put(NoteColumns.ORIGIN_PARENT_ID, originParent); } mOriginParent = originParent; for (int i = 0; i < dataArray.length(); i++) { JSONObject data = dataArray.getJSONObject(i); SqlData sqlData = null; if (data.has(DataColumns.ID)) { long dataId = data.getLong(DataColumns.ID); for (SqlData temp : mDataList) { if (dataId == temp.getId()) { sqlData = temp; } } } if (sqlData == null) { sqlData = new SqlData(mContext); mDataList.add(sqlData); } sqlData.setContent(data); } } } catch (JSONException e) { Log.e(TAG, e.toString()); e.printStackTrace(); return false; } return true; } /** * 1. 作用:将笔记对象转换为JSON格式,用于数据同步、导出或网络传输 * 2. 方法名:getContent * 3. 参数:无 * * 4. 返回类型:JSONObject * 5. 功能: * 若笔记为新建状态(未存入数据库),记录错误日志并返回null * 根据笔记类型(普通笔记、文件夹、系统文件夹)生成不同结构的JSON数据 */ public JSONObject getContent() { try { JSONObject js = new JSONObject(); if (mIsCreate) { Log.e(TAG, "it seems that we haven't created this in database yet"); return null; } JSONObject note = new JSONObject(); if (mType == Notes.TYPE_NOTE) { note.put(NoteColumns.ID, mId); note.put(NoteColumns.ALERTED_DATE, mAlertDate); note.put(NoteColumns.BG_COLOR_ID, mBgColorId); note.put(NoteColumns.CREATED_DATE, mCreatedDate); note.put(NoteColumns.HAS_ATTACHMENT, mHasAttachment); note.put(NoteColumns.MODIFIED_DATE, mModifiedDate); note.put(NoteColumns.PARENT_ID, mParentId); note.put(NoteColumns.SNIPPET, mSnippet); note.put(NoteColumns.TYPE, mType); note.put(NoteColumns.WIDGET_ID, mWidgetId); note.put(NoteColumns.WIDGET_TYPE, mWidgetType); note.put(NoteColumns.ORIGIN_PARENT_ID, mOriginParent); js.put(GTaskStringUtils.META_HEAD_NOTE, note); JSONArray dataArray = new JSONArray(); for (SqlData sqlData : mDataList) { JSONObject data = sqlData.getContent(); if (data != null) { dataArray.put(data); } } js.put(GTaskStringUtils.META_HEAD_DATA, dataArray); } else if (mType == Notes.TYPE_FOLDER || mType == Notes.TYPE_SYSTEM) { note.put(NoteColumns.ID, mId); note.put(NoteColumns.TYPE, mType); note.put(NoteColumns.SNIPPET, mSnippet); js.put(GTaskStringUtils.META_HEAD_NOTE, note); } return js; } catch (JSONException e) { Log.e(TAG, e.toString()); e.printStackTrace(); } return null; } /** * 1.作用:get/set函数 * */ public void setParentId(long id) { mParentId = id; mDiffNoteValues.put(NoteColumns.PARENT_ID, id); } public void setGtaskId(String gid) { mDiffNoteValues.put(NoteColumns.GTASK_ID, gid); } public void setSyncId(long syncId) { mDiffNoteValues.put(NoteColumns.SYNC_ID, syncId); } public void resetLocalModified() { mDiffNoteValues.put(NoteColumns.LOCAL_MODIFIED, 0); } public long getId() { return mId; } public long getParentId() { return mParentId; } public String getSnippet() { return mSnippet; } public boolean isNoteType() { return mType == Notes.TYPE_NOTE; } /** *1. 作用:将笔记数据提交到数据库,执行插入或更新操作,并同步关联的内容数据 * 2. 方法名:commit * 3. 参数:boolean validateVersion:是否验证版本号(用于并发冲突控制) * 4. 返回类型:void * 5. 功能: * - 新建笔记时:插入数据库并分配ID,同步内容数据 * 更新笔记时:根据版本号验证执行安全更新,防止并发冲突 * 自动刷新本地数据,确保内存中的数据与数据库一致 * */ public void commit(boolean validateVersion) { if (mIsCreate) { if (mId == INVALID_ID && mDiffNoteValues.containsKey(NoteColumns.ID)) { mDiffNoteValues.remove(NoteColumns.ID); } Uri uri = mContentResolver.insert(Notes.CONTENT_NOTE_URI, mDiffNoteValues); try { mId = Long.valueOf(uri.getPathSegments().get(1)); } catch (NumberFormatException e) { Log.e(TAG, "Get note id error :" + e.toString()); throw new ActionFailureException("create note failed"); } if (mId == 0) { throw new IllegalStateException("Create thread id failed"); } if (mType == Notes.TYPE_NOTE) { for (SqlData sqlData : mDataList) { sqlData.commit(mId, false, -1); } } } else { if (mId <= 0 && mId != Notes.ID_ROOT_FOLDER && mId != Notes.ID_CALL_RECORD_FOLDER) { Log.e(TAG, "No such note"); throw new IllegalStateException("Try to update note with invalid id"); } if (mDiffNoteValues.size() > 0) { mVersion ++; int result = 0; if (!validateVersion) { result = mContentResolver.update(Notes.CONTENT_NOTE_URI, mDiffNoteValues, "(" + NoteColumns.ID + "=?)", new String[] { String.valueOf(mId) }); } else { result = mContentResolver.update(Notes.CONTENT_NOTE_URI, mDiffNoteValues, "(" + NoteColumns.ID + "=?) AND (" + NoteColumns.VERSION + "<=?)", new String[] { String.valueOf(mId), String.valueOf(mVersion) }); } if (result == 0) { Log.w(TAG, "there is no update. maybe user updates note when syncing"); } } if (mType == Notes.TYPE_NOTE) { for (SqlData sqlData : mDataList) { sqlData.commit(mId, validateVersion, mVersion); } } } // refresh local info loadFromCursor(mId); if (mType == Notes.TYPE_NOTE) loadDataContent(); mDiffNoteValues.clear(); mIsCreate = false; } }