diff --git a/src/Notes-master/src/net/micode/notes/tool/DataUtils.java b/src/Notes-master/src/net/micode/notes/tool/DataUtils.java index 2a14982..db4b5c8 100644 --- a/src/Notes-master/src/net/micode/notes/tool/DataUtils.java +++ b/src/Notes-master/src/net/micode/notes/tool/DataUtils.java @@ -34,87 +34,146 @@ import net.micode.notes.ui.NotesListAdapter.AppWidgetAttribute; import java.util.ArrayList; import java.util.HashSet; - +/** + * 该类包含了一系列用于操作笔记数据的工具方法， + * 如批量删除笔记、移动笔记到指定文件夹、获取用户文件夹数量等。 + */ public class DataUtils { + // 日志标签，用于在日志中标识该类的输出信息 public static final String TAG = "DataUtils"; + + /** + * 批量删除指定 ID 的笔记。 + * + * @param resolver 内容解析器，用于与内容提供者进行交互 + * @param ids 要删除的笔记 ID 集合 + * @return 如果删除成功返回 true，否则返回 false + */ public static boolean batchDeleteNotes(ContentResolver resolver, HashSet ids) { + // 检查传入的 ID 集合是否为空 if (ids == null) { Log.d(TAG, "the ids is null"); return true; } + // 检查 ID 集合中是否有元素 if (ids.size() == 0) { Log.d(TAG, "no id is in the hashset"); return true; } + // 用于存储批量操作的列表 ArrayList operationList = new ArrayList(); + // 遍历 ID 集合 for (long id : ids) { + // 不允许删除系统根文件夹 if(id == Notes.ID_ROOT_FOLDER) { Log.e(TAG, "Don't delete system folder root"); continue; } + // 创建一个删除操作的构建器 ContentProviderOperation.Builder builder = ContentProviderOperation .newDelete(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, id)); + // 将操作添加到操作列表中 operationList.add(builder.build()); } try { + // 执行批量操作 ContentProviderResult[] results = resolver.applyBatch(Notes.AUTHORITY, operationList); + // 检查操作结果是否有效 if (results == null || results.length == 0 || results[0] == null) { Log.d(TAG, "delete notes failed, ids:" + ids.toString()); return false; } return true; } catch (RemoteException e) { + // 捕获远程异常并记录日志 Log.e(TAG, String.format("%s: %s", e.toString(), e.getMessage())); } catch (OperationApplicationException e) { + // 捕获操作应用异常并记录日志 Log.e(TAG, String.format("%s: %s", e.toString(), e.getMessage())); } return false; } + /** + * 将指定 ID 的笔记移动到目标文件夹。 + * + * @param resolver 内容解析器，用于与内容提供者进行交互 + * @param id 要移动的笔记 ID + * @param srcFolderId 笔记当前所在的文件夹 ID + * @param desFolderId 笔记要移动到的目标文件夹 ID + */ public static void moveNoteToFoler(ContentResolver resolver, long id, long srcFolderId, long desFolderId) { + // 用于存储要更新的内容值 ContentValues values = new ContentValues(); + // 设置笔记的父文件夹 ID 为目标文件夹 ID values.put(NoteColumns.PARENT_ID, desFolderId); + // 设置笔记的原始父文件夹 ID 为当前文件夹 ID values.put(NoteColumns.ORIGIN_PARENT_ID, srcFolderId); + // 标记笔记已被本地修改 values.put(NoteColumns.LOCAL_MODIFIED, 1); + // 执行更新操作 resolver.update(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, id), values, null, null); } + /** + * 批量将指定 ID 的笔记移动到目标文件夹。 + * + * @param resolver 内容解析器，用于与内容提供者进行交互 + * @param ids 要移动的笔记 ID 集合 + * @param folderId 目标文件夹 ID + * @return 如果移动成功返回 true，否则返回 false + */ public static boolean batchMoveToFolder(ContentResolver resolver, HashSet ids, long folderId) { + // 检查传入的 ID 集合是否为空 if (ids == null) { Log.d(TAG, "the ids is null"); return true; } + // 用于存储批量操作的列表 ArrayList operationList = new ArrayList(); + // 遍历 ID 集合 for (long id : ids) { + // 创建一个更新操作的构建器 ContentProviderOperation.Builder builder = ContentProviderOperation .newUpdate(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, id)); + // 设置笔记的父文件夹 ID 为目标文件夹 ID builder.withValue(NoteColumns.PARENT_ID, folderId); + // 标记笔记已被本地修改 builder.withValue(NoteColumns.LOCAL_MODIFIED, 1); + // 将操作添加到操作列表中 operationList.add(builder.build()); } try { + // 执行批量操作 ContentProviderResult[] results = resolver.applyBatch(Notes.AUTHORITY, operationList); + // 检查操作结果是否有效 if (results == null || results.length == 0 || results[0] == null) { Log.d(TAG, "delete notes failed, ids:" + ids.toString()); return false; } return true; } catch (RemoteException e) { + // 捕获远程异常并记录日志 Log.e(TAG, String.format("%s: %s", e.toString(), e.getMessage())); } catch (OperationApplicationException e) { + // 捕获操作应用异常并记录日志 Log.e(TAG, String.format("%s: %s", e.toString(), e.getMessage())); } return false; } /** - * Get the all folder count except system folders {@link Notes#TYPE_SYSTEM}} + * 获取除系统文件夹外的用户文件夹数量。 + * + * @param resolver 内容解析器，用于与内容提供者进行交互 + * @return 用户文件夹的数量 */ public static int getUserFolderCount(ContentResolver resolver) { + // 执行查询操作，统计用户文件夹的数量 Cursor cursor =resolver.query(Notes.CONTENT_NOTE_URI, new String[] { "COUNT(*)" }, NoteColumns.TYPE + "=? AND " + NoteColumns.PARENT_ID + "<>?", @@ -122,13 +181,18 @@ public class DataUtils { null); int count = 0; + // 检查游标是否有效 if(cursor != null) { + // 移动游标到第一行 if(cursor.moveToFirst()) { try { + // 获取统计结果 count = cursor.getInt(0); } catch (IndexOutOfBoundsException e) { + // 捕获索引越界异常并记录日志 Log.e(TAG, "get folder count failed:" + e.toString()); } finally { + // 关闭游标 cursor.close(); } } @@ -136,7 +200,16 @@ public class DataUtils { return count; } + /** + * 检查指定类型的笔记是否在笔记数据库中可见。 + * + * @param resolver 内容解析器，用于与内容提供者进行交互 + * @param noteId 笔记的 ID + * @param type 笔记的类型 + * @return 如果笔记可见返回 true，否则返回 false + */ public static boolean visibleInNoteDatabase(ContentResolver resolver, long noteId, int type) { + // 执行查询操作，检查笔记是否可见 Cursor cursor = resolver.query(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId), null, NoteColumns.TYPE + "=? AND " + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER, @@ -144,60 +217,104 @@ public class DataUtils { null); boolean exist = false; + // 检查游标是否有效 if (cursor != null) { + // 检查游标中是否有数据 if (cursor.getCount() > 0) { exist = true; } + // 关闭游标 cursor.close(); } return exist; } + /** + * 检查指定 ID 的笔记是否存在于笔记数据库中。 + * + * @param resolver 内容解析器，用于与内容提供者进行交互 + * @param noteId 笔记的 ID + * @return 如果笔记存在返回 true，否则返回 false + */ public static boolean existInNoteDatabase(ContentResolver resolver, long noteId) { + // 执行查询操作，检查笔记是否存在 Cursor cursor = resolver.query(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId), null, null, null, null); boolean exist = false; + // 检查游标是否有效 if (cursor != null) { + // 检查游标中是否有数据 if (cursor.getCount() > 0) { exist = true; } + // 关闭游标 cursor.close(); } return exist; } + /** + * 检查指定 ID 的数据是否存在于数据数据库中。 + * + * @param resolver 内容解析器，用于与内容提供者进行交互 + * @param dataId 数据的 ID + * @return 如果数据存在返回 true，否则返回 false + */ public static boolean existInDataDatabase(ContentResolver resolver, long dataId) { + // 执行查询操作，检查数据是否存在 Cursor cursor = resolver.query(ContentUris.withAppendedId(Notes.CONTENT_DATA_URI, dataId), null, null, null, null); boolean exist = false; + // 检查游标是否有效 if (cursor != null) { + // 检查游标中是否有数据 if (cursor.getCount() > 0) { exist = true; } + // 关闭游标 cursor.close(); } return exist; } + /** + * 检查指定名称的可见文件夹是否存在于数据库中。 + * + * @param resolver 内容解析器，用于与内容提供者进行交互 + * @param name 文件夹的名称 + * @return 如果文件夹存在返回 true，否则返回 false + */ public static boolean checkVisibleFolderName(ContentResolver resolver, String name) { + // 执行查询操作，检查可见文件夹是否存在 Cursor cursor = resolver.query(Notes.CONTENT_NOTE_URI, null, NoteColumns.TYPE + "=" + Notes.TYPE_FOLDER + " AND " + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER + " AND " + NoteColumns.SNIPPET + "=?", new String[] { name }, null); boolean exist = false; + // 检查游标是否有效 if(cursor != null) { + // 检查游标中是否有数据 if(cursor.getCount() > 0) { exist = true; } + // 关闭游标 cursor.close(); } return exist; } + /** + * 获取指定文件夹下的笔记小部件集合。 + * + * @param resolver 内容解析器，用于与内容提供者进行交互 + * @param folderId 文件夹的 ID + * @return 包含笔记小部件属性的集合，如果没有则返回 null + */ public static HashSet getFolderNoteWidget(ContentResolver resolver, long folderId) { + // 执行查询操作，获取指定文件夹下的笔记小部件信息 Cursor c = resolver.query(Notes.CONTENT_NOTE_URI, new String[] { NoteColumns.WIDGET_ID, NoteColumns.WIDGET_TYPE }, NoteColumns.PARENT_ID + "=?", @@ -205,26 +322,43 @@ public class DataUtils { null); HashSet set = null; + // 检查游标是否有效 if (c != null) { + // 移动游标到第一行 if (c.moveToFirst()) { + // 创建一个集合用于存储笔记小部件属性 set = new HashSet(); do { try { + // 创建一个笔记小部件属性对象 AppWidgetAttribute widget = new AppWidgetAttribute(); + // 获取小部件 ID widget.widgetId = c.getInt(0); + // 获取小部件类型 widget.widgetType = c.getInt(1); + // 将小部件属性添加到集合中 set.add(widget); } catch (IndexOutOfBoundsException e) { + // 捕获索引越界异常并记录日志 Log.e(TAG, e.toString()); } } while (c.moveToNext()); } + // 关闭游标 c.close(); } return set; } + /** + * 根据笔记 ID 获取通话记录的电话号码。 + * + * @param resolver 内容解析器，用于与内容提供者进行交互 + * @param noteId 笔记的 ID + * @return 通话记录的电话号码，如果未找到则返回空字符串 + */ public static String getCallNumberByNoteId(ContentResolver resolver, long noteId) { + // 执行查询操作，获取通话记录的电话号码 Cursor cursor = resolver.query(Notes.CONTENT_DATA_URI, new String [] { CallNote.PHONE_NUMBER }, CallNote.NOTE_ID + "=? AND " + CallNote.MIME_TYPE + "=?", @@ -233,17 +367,29 @@ public class DataUtils { if (cursor != null && cursor.moveToFirst()) { try { + // 获取电话号码 return cursor.getString(0); } catch (IndexOutOfBoundsException e) { + // 捕获索引越界异常并记录日志 Log.e(TAG, "Get call number fails " + e.toString()); } finally { + // 关闭游标 cursor.close(); } } return ""; } + /** + * 根据电话号码和通话日期获取笔记 ID。 + * + * @param resolver 内容解析器，用于与内容提供者进行交互 + * @param phoneNumber 电话号码 + * @param callDate 通话日期 + * @return 笔记的 ID，如果未找到则返回 0 + */ public static long getNoteIdByPhoneNumberAndCallDate(ContentResolver resolver, String phoneNumber, long callDate) { + // 执行查询操作，根据电话号码和通话日期获取笔记 ID Cursor cursor = resolver.query(Notes.CONTENT_DATA_URI, new String [] { CallNote.NOTE_ID }, CallNote.CALL_DATE + "=? AND " + CallNote.MIME_TYPE + "=? AND PHONE_NUMBERS_EQUAL(" @@ -252,19 +398,31 @@ public class DataUtils { null); if (cursor != null) { + // 移动游标到第一行 if (cursor.moveToFirst()) { try { + // 获取笔记 ID return cursor.getLong(0); } catch (IndexOutOfBoundsException e) { + // 捕获索引越界异常并记录日志 Log.e(TAG, "Get call note id fails " + e.toString()); } } + // 关闭游标 cursor.close(); } return 0; } + /** + * 根据笔记 ID 获取笔记的摘要。 + * + * @param resolver 内容解析器，用于与内容提供者进行交互 + * @param noteId 笔记的 ID + * @return 笔记的摘要，如果未找到则抛出 IllegalArgumentException 异常 + */ public static String getSnippetById(ContentResolver resolver, long noteId) { + // 执行查询操作，获取笔记的摘要 Cursor cursor = resolver.query(Notes.CONTENT_NOTE_URI, new String [] { NoteColumns.SNIPPET }, NoteColumns.ID + "=?", @@ -273,23 +431,36 @@ public class DataUtils { if (cursor != null) { String snippet = ""; + // 移动游标到第一行 if (cursor.moveToFirst()) { + // 获取笔记摘要 snippet = cursor.getString(0); } + // 关闭游标 cursor.close(); return snippet; } + // 如果未找到笔记，抛出异常 throw new IllegalArgumentException("Note is not found with id: " + noteId); } + /** + * 格式化笔记摘要，去除首尾空格并截取第一行。 + * + * @param snippet 原始的笔记摘要 + * @return 格式化后的笔记摘要 + */ public static String getFormattedSnippet(String snippet) { if (snippet != null) { + // 去除首尾空格 snippet = snippet.trim(); + // 查找换行符的位置 int index = snippet.indexOf('\n'); if (index != -1) { + // 截取第一行 snippet = snippet.substring(0, index); } } return snippet; } -} +} \ No newline at end of file