From 1888befdc9bdade37da982b07e30b73e41701c45 Mon Sep 17 00:00:00 2001 From: STRIV1 <26755173368@qq.com> Date: Mon, 30 Dec 2024 20:16:32 +0800 Subject: [PATCH] =?UTF-8?q?=E4=BB=A3=E7=A0=81=E6=B3=A8=E9=87=8A?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- model/Note.java | 301 +++++++++++++++++++++++++++++++ model/WorkingNote.java | 401 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 702 insertions(+) create mode 100644 model/Note.java create mode 100644 model/WorkingNote.java diff --git a/model/Note.java b/model/Note.java new file mode 100644 index 0000000..980ac06 --- /dev/null +++ b/model/Note.java @@ -0,0 +1,301 @@ +/* + * 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. + */ + +// 定义了一个名为Note的类，用于表示笔记数据模型，并提供与数据库交互的方法。 +package net.micode.notes.model; +import android.content.ContentProviderOperation; +import android.content.ContentProviderResult; +import android.content.ContentUris; +import android.content.ContentValues; +import android.content.Context; +import android.content.OperationApplicationException; +import android.net.Uri; +import android.os.RemoteException; +import android.util.Log; + +import net.micode.notes.data.Notes; +import net.micode.notes.data.Notes.CallNote; +import net.micode.notes.data.Notes.DataColumns; +import net.micode.notes.data.Notes.NoteColumns; +import net.micode.notes.data.Notes.TextNote; + +import java.util.ArrayList; + +public class Note { + // 用于存储笔记的差异值，即需要更新到数据库的字段 + private ContentValues mNoteDiffValues; + // 存储笔记数据的内部类实例 + private NoteData mNoteData; + // 用于日志记录的标签 + private static final String TAG = "Note"; + + /** + * 创建一个新的笔记ID，用于将新笔记添加到数据库 + * @param context 上下文对象 + * @param folderId 笔记所属文件夹的ID + * @return 新创建的笔记ID + */ + public static synchronized long getNewNoteId(Context context, long folderId) { + // 创建一个新的ContentValues对象，用于存储笔记的初始数据 + ContentValues values = new ContentValues(); + long createdTime = System.currentTimeMillis(); + values.put(NoteColumns.CREATED_DATE, createdTime); + values.put(NoteColumns.MODIFIED_DATE, createdTime); + values.put(NoteColumns.TYPE, Notes.TYPE_NOTE); + values.put(NoteColumns.LOCAL_MODIFIED, 1); + values.put(NoteColumns.PARENT_ID, folderId); + // 将新笔记插入到数据库，并获取返回的URI + Uri uri = context.getContentResolver().insert(Notes.CONTENT_NOTE_URI, values); + + long noteId = 0; + try { + // 从URI中解析出新创建的笔记ID + noteId = Long.valueOf(uri.getPathSegments().get(1)); + } catch (NumberFormatException e) { + Log.e(TAG, "Get note id error :" + e.toString()); + noteId = 0; + } + // 如果解析出的笔记ID不正确，则抛出异常 + if (noteId == -1) { + throw new IllegalStateException("Wrong note id:" + noteId); + } + return noteId; + } + + // Note类的构造函数 + public Note() { + mNoteDiffValues = new ContentValues(); + mNoteData = new NoteData(); + } + + // 设置笔记的值 + public void setNoteValue(String key, String value) { + mNoteDiffValues.put(key, value); + mNoteDiffValues.put(NoteColumns.LOCAL_MODIFIED, 1); + mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis()); + } + + // 设置文本数据 + public void setTextData(String key, String value) { + mNoteData.setTextData(key, value); + } + + // 设置文本数据的ID + public void setTextDataId(long id) { + mNoteData.setTextDataId(id); + } + + // 获取文本数据的ID + public long getTextDataId() { + return mNoteData.mTextDataId; + } + + // 设置通话数据的ID + public void setCallDataId(long id) { + mNoteData.setCallDataId(id); + } + + // 设置通话数据 + public void setCallData(String key, String value) { + mNoteData.setCallData(key, value); + } + + // 检查笔记是否在本地被修改过 + public boolean isLocalModified() { + return mNoteDiffValues.size() > 0 || mNoteData.isLocalModified(); + } + + // 同步笔记到数据库 + public boolean syncNote(Context context, long noteId) { + if (noteId <= 0) { + throw new IllegalArgumentException("Wrong note id:" + noteId); + } + + if (!isLocalModified()) { + return true; + } + + /** + * 理论上，一旦数据发生变化，就应该更新笔记的LOCAL_MODIFIED和MODIFIED_DATE字段。 + * 为了数据安全，即使更新笔记失败，我们也应该更新笔记数据信息。 + */ + if (context.getContentResolver().update( + ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId), mNoteDiffValues, null, + null) == 0) { + Log.e(TAG, "Update note error, should not happen"); + // 不要返回，继续执行 + } + mNoteDiffValues.clear(); + + if (mNoteData.isLocalModified() + && (mNoteData.pushIntoContentResolver(context, noteId) == null)) { + return false; + } + + return true; + } + + // 笔记数据的内部类 + private class NoteData { + // 存储文本数据的ID + private long mTextDataId; + // 存储文本数据的ContentValues对象 + private ContentValues mTextDataValues; + // 存储通话数据的ID + private long mCallDataId; + // 存储通话数据的ContentValues对象 + private ContentValues mCallDataValues; + // 用于日志记录的标签 + private static final String TAG = "NoteData"; + + // NoteData类的构造函数 + public NoteData() { + mTextDataValues = new ContentValues(); + mCallDataValues = new ContentValues(); + mTextDataId = 0; + mCallDataId = 0; + } + + // 检查笔记数据是否在本地被修改过 + boolean isLocalModified() { + return mTextDataValues.size() > 0 || mCallDataValues.size() > 0; + } + + // 设置文本数据的ID + void setTextDataId(long id) { + if(id <= 0) { + throw new IllegalArgumentException("Text data id should larger than 0"); + } + mTextDataId = id; + } + + // 设置通话数据的ID + void setCallDataId(long id) { + if (id <= 0) { + throw new IllegalArgumentException("Call data id should larger than 0"); + } + mCallDataId = id; + } + + // 设置通话数据 + void setCallData(String key, String value) { + mCallDataValues.put(key, value); + mNoteDiffValues.put(NoteColumns.LOCAL_MODIFIED, 1); + mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis()); + } + + // 设置文本数据 + void setTextData(String key, String value) { + mTextDataValues.put(key, value); + mNoteDiffValues.put(NoteColumns.LOCAL_MODIFIED, 1); + mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis()); + } + + // 将笔记数据推送到内容解析器 + Uri pushIntoContentResolver(Context context, long noteId) { + /** + * 检查参数的安全性 + */ + // 检查传入的笔记ID是否有效，如果笔记ID小于或等于0，则抛出IllegalArgumentException异常 +if (noteId <= 0) { + throw new IllegalArgumentException("Wrong note id:" + noteId); +} + +// 创建一个ArrayList来存储ContentProviderOperation对象，这些对象代表要执行的数据库操作 +ArrayList operationList = new ArrayList(); +// 初始化一个ContentProviderOperation.Builder对象，用于构建数据库操作 +ContentProviderOperation.Builder builder = null; + +// 如果文本数据的ContentValues对象中有数据 +if(mTextDataValues.size() > 0) { + // 将笔记ID放入文本数据的ContentValues对象中 + mTextDataValues.put(DataColumns.NOTE_ID, noteId); + // 如果文本数据ID为0，表示这是一个新的文本数据，需要插入新的数据项 + if (mTextDataId == 0) { + // 设置文本数据的MIME类型 + mTextDataValues.put(DataColumns.MIME_TYPE, TextNote.CONTENT_ITEM_TYPE); + // 将文本数据插入到数据库，并获取返回的URI + Uri uri = context.getContentResolver().insert(Notes.CONTENT_DATA_URI, mTextDataValues); + // 尝试从URI中解析出新插入的文本数据ID + try { + setTextDataId(Long.valueOf(uri.getPathSegments().get(1))); + } catch (NumberFormatException e) { + // 如果解析失败，记录错误日志，并清除文本数据的ContentValues对象，返回null + Log.e(TAG, "Insert new text data fail with noteId" + noteId); + mTextDataValues.clear(); + return null; + } + } else { + // 如果文本数据ID不为0，表示这是更新现有文本数据 + builder = ContentProviderOperation.newUpdate(ContentUris.withAppendedId(Notes.CONTENT_DATA_URI, mTextDataId)); + builder.withValues(mTextDataValues); + operationList.add(builder.build()); + } + // 清空文本数据的ContentValues对象，准备下一次操作 + mTextDataValues.clear(); +} + +// 如果通话数据的ContentValues对象中有数据 +if(mCallDataValues.size() > 0) { + // 将笔记ID放入通话数据的ContentValues对象中 + mCallDataValues.put(DataColumns.NOTE_ID, noteId); + // 如果通话数据ID为0，表示这是一个新的通话数据，需要插入新的数据项 + if (mCallDataId == 0) { + // 设置通话数据的MIME类型 + mCallDataValues.put(DataColumns.MIME_TYPE, CallNote.CONTENT_ITEM_TYPE); + // 将通话数据插入到数据库，并获取返回的URI + Uri uri = context.getContentResolver().insert(Notes.CONTENT_DATA_URI, mCallDataValues); + // 尝试从URI中解析出新插入的通话数据ID + try { + setCallDataId(Long.valueOf(uri.getPathSegments().get(1))); + } catch (NumberFormatException e) { + // 如果解析失败，记录错误日志，并清除通话数据的ContentValues对象，返回null + Log.e(TAG, "Insert new call data fail with noteId" + noteId); + mCallDataValues.clear(); + return null; + } + } else { + // 如果通话数据ID不为0，表示这是更新现有通话数据 + builder = ContentProviderOperation.newUpdate(ContentUris.withAppendedId(Notes.CONTENT_DATA_URI, mCallDataId)); + builder.withValues(mCallDataValues); + operationList.add(builder.build()); + } + // 清空通话数据的ContentValues对象，准备下一次操作 + mCallDataValues.clear(); +} + +// 如果有数据库操作需要执行 +if (operationList.size() > 0) { + try { + // 执行批量数据库操作 + ContentProviderResult[] results = context.getContentResolver().applyBatch(Notes.AUTHORITY, operationList); + // 如果操作成功，返回更新的笔记URI，否则返回null + return (results == null || results.length == 0 || results[0] == null) ? null : ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId); + } catch (RemoteException e) { + // 如果发生远程异常，记录错误日志，并返回null + Log.e(TAG, String.format("%s: %s", e.toString(), e.getMessage())); + return null; + } catch (OperationApplicationException e) { + // 如果发生操作应用异常，记录错误日志，并返回null + Log.e(TAG, String.format("%s: %s", e.toString(), e.getMessage())); + return null; + } +} +// 如果没有数据库操作需要执行，返回null +return null; + } + } +} \ No newline at end of file diff --git a/model/WorkingNote.java b/model/WorkingNote.java new file mode 100644 index 0000000..88b5afb --- /dev/null +++ b/model/WorkingNote.java @@ -0,0 +1,401 @@ +/* + * 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.model; + +import android.appwidget.AppWidgetManager; +import android.content.ContentUris; +import android.content.Context; +import android.database.Cursor; +import android.text.TextUtils; +import android.util.Log; + +import net.micode.notes.data.Notes; +import net.micode.notes.data.Notes.CallNote; +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.Notes.TextNote; +import net.micode.notes.tool.ResourceParser.NoteBgResources; + +// 表示一个工作笔记的类 +public class WorkingNote { + // 笔记对象 + private Note mNote; + // 笔记ID + private long mNoteId; + // 笔记内容 + private String mContent; + // 笔记模式 + private int mMode; + + // 笔记提醒日期 + private long mAlertDate; + + // 笔记修改日期 + private long mModifiedDate; + + // 笔记背景颜色ID + private int mBgColorId; + + // 笔记小部件ID + private int mWidgetId; + + // 笔记小部件类型 + private int mWidgetType; + + // 笔记文件夹ID + private long mFolderId; + + // 上下文对象 + private Context mContext; + + // 日志标签 + private static final String TAG = "WorkingNote"; + + // 笔记是否被删除 + private boolean mIsDeleted; + + // 笔记设置改变监听器 + private NoteSettingChangedListener mNoteSettingStatusListener; + + // 数据库查询使用的字段数组 + public static final String[] DATA_PROJECTION = new String[] { + DataColumns.ID, + DataColumns.CONTENT, + DataColumns.MIME_TYPE, + DataColumns.DATA1, + DataColumns.DATA2, + DataColumns.DATA3, + DataColumns.DATA4, + }; + + // 笔记查询使用的字段数组 + public static final String[] NOTE_PROJECTION = new String[] { + NoteColumns.PARENT_ID, + NoteColumns.ALERTED_DATE, + NoteColumns.BG_COLOR_ID, + NoteColumns.WIDGET_ID, + NoteColumns.WIDGET_TYPE, + NoteColumns.MODIFIED_DATE + }; + + // 数据库查询结果的列索引 + private static final int DATA_ID_COLUMN = 0; + private static final int DATA_CONTENT_COLUMN = 1; + private static final int DATA_MIME_TYPE_COLUMN = 2; + private static final int DATA_MODE_COLUMN = 3; + private static final int NOTE_PARENT_ID_COLUMN = 0; + private static final int NOTE_ALERTED_DATE_COLUMN = 1; + private static final int NOTE_BG_COLOR_ID_COLUMN = 2; + private static final int NOTE_WIDGET_ID_COLUMN = 3; + private static final int NOTE_WIDGET_TYPE_COLUMN = 4; + private static final int NOTE_MODIFIED_DATE_COLUMN = 5; + + // 创建一个新的工作笔记 + private WorkingNote(Context context, long folderId) { + mContext = context; + mAlertDate = 0; + mModifiedDate = System.currentTimeMillis(); + mFolderId = folderId; + mNote = new Note(); + mNoteId = 0; + mIsDeleted = false; + mMode = 0; + mWidgetType = Notes.TYPE_WIDGET_INVALIDE; + } + + // 根据ID加载一个已存在的工作笔记 + private WorkingNote(Context context, long noteId, long folderId) { + mContext = context; + mNoteId = noteId; + mFolderId = folderId; + mIsDeleted = false; + mNote = new Note(); + loadNote(); + } + + // 加载笔记数据 + private void loadNote() { + Cursor cursor = mContext.getContentResolver().query( + ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, mNoteId), NOTE_PROJECTION, null, + null, null); + + if (cursor != null) { + if (cursor.moveToFirst()) { + mFolderId = cursor.getLong(NOTE_PARENT_ID_COLUMN); + mBgColorId = cursor.getInt(NOTE_BG_COLOR_ID_COLUMN); + mWidgetId = cursor.getInt(NOTE_WIDGET_ID_COLUMN); + mWidgetType = cursor.getInt(NOTE_WIDGET_TYPE_COLUMN); + mAlertDate = cursor.getLong(NOTE_ALERTED_DATE_COLUMN); + mModifiedDate = cursor.getLong(NOTE_MODIFIED_DATE_COLUMN); + } + cursor.close(); + } else { + Log.e(TAG, "No note with id:" + mNoteId); + throw new IllegalArgumentException("Unable to find note with id " + mNoteId); + } + loadNoteData(); + } + + // 加载笔记的具体内容数据 + private void loadNoteData() { + Cursor cursor = mContext.getContentResolver().query(Notes.CONTENT_DATA_URI, DATA_PROJECTION, + DataColumns.NOTE_ID + "=?", new String[] { + String.valueOf(mNoteId) + }, null); + + if (cursor != null) { + if (cursor.moveToFirst()) { + do { + String type = cursor.getString(DATA_MIME_TYPE_COLUMN); + if (DataConstants.NOTE.equals(type)) { + mContent = cursor.getString(DATA_CONTENT_COLUMN); + mMode = cursor.getInt(DATA_MODE_COLUMN); + mNote.setTextDataId(cursor.getLong(DATA_ID_COLUMN)); + } else if (DataConstants.CALL_NOTE.equals(type)) { + mNote.setCallDataId(cursor.getLong(DATA_ID_COLUMN)); + } else { + Log.d(TAG, "Wrong note type with type:" + type); + } + } while (cursor.moveToNext()); + } + cursor.close(); + } else { + Log.e(TAG, "No data with id:" + mNoteId); + throw new IllegalArgumentException("Unable to find note's data with id " + mNoteId); + } + } + + // 创建一个空的工作笔记 + public static WorkingNote createEmptyNote(Context context, long folderId, int widgetId, + int widgetType, int defaultBgColorId) { + WorkingNote note = new WorkingNote(context, folderId); + note.setBgColorId(defaultBgColorId); + note.setWidgetId(widgetId); + note.setWidgetType(widgetType); + return note; + } + + // 根据ID加载工作笔记 + public static WorkingNote load(Context context, long id) { + return new WorkingNote(context, id, 0); + } + + // 保存笔记到数据库 + public synchronized boolean saveNote() { + if (isWorthSaving()) { + if (!existInDatabase()) { + if ((mNoteId = Note.getNewNoteId(mContext, mFolderId)) == 0) { + Log.e(TAG, "Create new note fail with id:" + mNoteId); + return false; + } + } + + mNote.syncNote(mContext, mNoteId); + + /** + * 如果存在任何小部件，则更新小部件内容 + */ + if (mWidgetId != AppWidgetManager.INVALID_APPWIDGET_ID + && mWidgetType != Notes.TYPE_WIDGET_INVALIDE + && mNoteSettingStatusListener != null) { + mNoteSettingStatusListener.onWidgetChanged(); + } + return true; + } else { + return false; + } + } + + // 检查笔记是否在数据库中存在 + public boolean existInDatabase() { + return mNoteId > 0; + } + + // 检查笔记是否值得保存 + private boolean isWorthSaving() { + if (mIsDeleted || (!existInDatabase() && TextUtils.isEmpty(mContent)) + || (existInDatabase() && !mNote.isLocalModified())) { + return false; + } else { + return true; + } + } + + // 设置笔记设置状态改变的监听器 +public void setOnSettingStatusChangedListener(NoteSettingChangedListener l) { + mNoteSettingStatusListener = l; +} + +// 设置提醒日期，并根据参数决定是否设置提醒 +public void setAlertDate(long date, boolean set) { + if (date != mAlertDate) { + mAlertDate = date; + mNote.setNoteValue(NoteColumns.ALERTED_DATE, String.valueOf(mAlertDate)); + } + if (mNoteSettingStatusListener != null) { + mNoteSettingStatusListener.onClockAlertChanged(date, set); + } +} + +// 标记笔记为删除或未删除状态 +public void markDeleted(boolean mark) { + mIsDeleted = mark; + if (mWidgetId != AppWidgetManager.INVALID_APPWIDGET_ID + && mWidgetType != Notes.TYPE_WIDGET_INVALIDE && mNoteSettingStatusListener != null) { + mNoteSettingStatusListener.onWidgetChanged(); + } +} + +// 设置笔记的背景颜色ID +public void setBgColorId(int id) { + if (id != mBgColorId) { + mBgColorId = id; + if (mNoteSettingStatusListener != null) { + mNoteSettingStatusListener.onBackgroundColorChanged(); + } + mNote.setNoteValue(NoteColumns.BG_COLOR_ID, String.valueOf(id)); + } +} + +// 设置笔记的 checklist 模式 +public void setCheckListMode(int mode) { + if (mMode != mode) { + if (mNoteSettingStatusListener != null) { + mNoteSettingStatusListener.onCheckListModeChanged(mMode, mode); + } + mMode = mode; + mNote.setTextData(TextNote.MODE, String.valueOf(mMode)); + } +} + +// 设置笔记的小部件类型 +public void setWidgetType(int type) { + if (type != mWidgetType) { + mWidgetType = type; + mNote.setNoteValue(NoteColumns.WIDGET_TYPE, String.valueOf(mWidgetType)); + } +} + +// 设置笔记的小部件ID +public void setWidgetId(int id) { + if (id != mWidgetId) { + mWidgetId = id; + mNote.setNoteValue(NoteColumns.WIDGET_ID, String.valueOf(mWidgetId)); + } +} + +// 设置笔记的工作文本 +public void setWorkingText(String text) { + if (!TextUtils.equals(mContent, text)) { + mContent = text; + mNote.setTextData(DataColumns.CONTENT, mContent); + } +} + +// 将笔记转换为通话记录笔记 +public void convertToCallNote(String phoneNumber, long callDate) { + mNote.setCallData(CallNote.CALL_DATE, String.valueOf(callDate)); + mNote.setCallData(CallNote.PHONE_NUMBER, phoneNumber); + mNote.setNoteValue(NoteColumns.PARENT_ID, String.valueOf(Notes.ID_CALL_RECORD_FOLDER)); +} + +// 检查笔记是否有闹钟提醒 +public boolean hasClockAlert() { + return (mAlertDate > 0 ? true : false); +} + +// 获取笔记内容 +public String getContent() { + return mContent; +} + +// 获取提醒日期 +public long getAlertDate() { + return mAlertDate; +} + +// 获取修改日期 +public long getModifiedDate() { + return mModifiedDate; +} + +// 获取背景颜色资源ID +public int getBgColorResId() { + return NoteBgResources.getNoteBgResource(mBgColorId); +} + +// 获取背景颜色ID +public int getBgColorId() { + return mBgColorId; +} + +// 获取标题背景资源ID +public int getTitleBgResId() { + return NoteBgResources.getNoteTitleBgResource(mBgColorId); +} + +// 获取checklist模式 +public int getCheckListMode() { + return mMode; +} + +// 获取笔记ID +public long getNoteId() { + return mNoteId; +} + +// 获取文件夹ID +public long getFolderId() { + return mFolderId; +} + +// 获取小部件ID +public int getWidgetId() { + return mWidgetId; +} + +// 获取小部件类型 +public int getWidgetType() { + return mWidgetType; +} + +// 笔记设置改变监听器接口 +public interface NoteSettingChangedListener { + /** + * 当前笔记的背景颜色刚刚改变时调用 + */ + void onBackgroundColorChanged(); + + /** + * 用户设置闹钟时调用 + */ + void onClockAlertChanged(long date, boolean set); + + /** + * 用户从小部件创建笔记时调用 + */ + void onWidgetChanged(); + + /** + * 在checklist模式和普通模式之间切换时调用 + * @param oldMode 改变前的模式 + * @param newMode 新的模式 + */ + void onCheckListModeChanged(int oldMode, int newMode); + } +}