diff --git a/doc/计算机2201 张萌妤 泛读报告.docx b/doc/计算机2201 张萌妤 泛读报告.docx new file mode 100644 index 0000000..8b64e50 Binary files /dev/null and b/doc/计算机2201 张萌妤 泛读报告.docx differ diff --git a/doc/计算机2201 张萌妤 运行截图.png b/doc/计算机2201 张萌妤 运行截图.png new file mode 100644 index 0000000..15d9b3f Binary files /dev/null and b/doc/计算机2201 张萌妤 运行截图.png differ diff --git a/src/tool/BackupUtils.java b/src/tool/BackupUtils.java new file mode 100644 index 0000000..1eef43b --- /dev/null +++ b/src/tool/BackupUtils.java @@ -0,0 +1,419 @@ +/* + * 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.tool; + +import android.content.Context; +import android.database.Cursor; +import android.os.Environment; +import android.text.TextUtils; +import android.text.format.DateFormat; +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.DataConstants; +import net.micode.notes.data.Notes.NoteColumns; + +import java.io.File; +import java.io.FileNotFoundException; +import java.io.FileOutputStream; +import java.io.IOException; +import java.io.PrintStream; + +/** + * 该类用于处理笔记的备份功能，将笔记数据导出为文本文件。 + * 它采用单例模式，确保在应用程序中只有一个实例存在。 + */ +public class BackupUtils { + // 日志标签，用于在日志中标识该类的相关信息 + private static final String TAG = "BackupUtils"; + // 单例实例 + private static BackupUtils sInstance; + + /** + * 获取 BackupUtils 的单例实例。 + * 如果实例不存在，则创建一个新的实例。 + * + * @param context 应用程序上下文 + * @return BackupUtils 的单例实例 + */ + public static synchronized BackupUtils getInstance(Context context) { + if (sInstance == null) { + sInstance = new BackupUtils(context); + } + return sInstance; + } + + /** + * 以下状态码用于表示备份或恢复操作的状态。 + */ + // 当前 SD 卡未挂载 + public static final int STATE_SD_CARD_UNMOUONTED = 0; + // 备份文件不存在 + public static final int STATE_BACKUP_FILE_NOT_EXIST = 1; + // 数据格式不正确，可能被其他程序修改 + public static final int STATE_DATA_DESTROIED = 2; + // 运行时异常导致备份或恢复失败 + public static final int STATE_SYSTEM_ERROR = 3; + // 备份或恢复成功 + public static final int STATE_SUCCESS = 4; + + // 文本导出工具类实例 + private TextExport mTextExport; + + /** + * 私有构造函数，确保只能通过 getInstance 方法获取实例。 + * + * @param context 应用程序上下文 + */ + private BackupUtils(Context context) { + mTextExport = new TextExport(context); + } + + /** + * 检查外部存储（SD 卡）是否可用。 + * + * @return 如果 SD 卡已挂载，则返回 true；否则返回 false + */ + private static boolean externalStorageAvailable() { + return Environment.MEDIA_MOUNTED.equals(Environment.getExternalStorageState()); + } + + /** + * 将笔记数据导出为文本文件。 + * + * @return 导出操作的状态码 + */ + public int exportToText() { + return mTextExport.exportToText(); + } + + /** + * 获取导出的文本文件的文件名。 + * + * @return 导出的文本文件的文件名 + */ + public String getExportedTextFileName() { + return mTextExport.mFileName; + } + + /** + * 获取导出的文本文件的目录。 + * + * @return 导出的文本文件的目录 + */ + public String getExportedTextFileDir() { + return mTextExport.mFileDirectory; + } + + /** + * 内部类，用于处理文本导出的具体逻辑。 + */ + private static class TextExport { + // 查询笔记时使用的投影列 + private static final String[] NOTE_PROJECTION = { + NoteColumns.ID, + NoteColumns.MODIFIED_DATE, + NoteColumns.SNIPPET, + NoteColumns.TYPE + }; + + // 笔记 ID 列的索引 + private static final int NOTE_COLUMN_ID = 0; + // 笔记修改日期列的索引 + private static final int NOTE_COLUMN_MODIFIED_DATE = 1; + // 笔记摘要列的索引 + private static final int NOTE_COLUMN_SNIPPET = 2; + + // 查询笔记数据时使用的投影列 + private static final String[] DATA_PROJECTION = { + DataColumns.CONTENT, + DataColumns.MIME_TYPE, + DataColumns.DATA1, + DataColumns.DATA2, + DataColumns.DATA3, + DataColumns.DATA4, + }; + + // 数据内容列的索引 + private static final int DATA_COLUMN_CONTENT = 0; + // 数据 MIME 类型列的索引 + private static final int DATA_COLUMN_MIME_TYPE = 1; + // 通话日期列的索引 + private static final int DATA_COLUMN_CALL_DATE = 2; + // 电话号码列的索引 + private static final int DATA_COLUMN_PHONE_NUMBER = 4; + + // 导出笔记的文本格式数组 + private final String[] TEXT_FORMAT; + // 文件夹名称格式的索引 + private static final int FORMAT_FOLDER_NAME = 0; + // 笔记日期格式的索引 + private static final int FORMAT_NOTE_DATE = 1; + // 笔记内容格式的索引 + private static final int FORMAT_NOTE_CONTENT = 2; + + // 应用程序上下文 + private Context mContext; + // 导出的文本文件的文件名 + private String mFileName; + // 导出的文本文件的目录 + private String mFileDirectory; + + /** + * 构造函数，初始化上下文、文本格式和文件名、目录。 + * + * @param context 应用程序上下文 + */ + public TextExport(Context context) { + TEXT_FORMAT = context.getResources().getStringArray(R.array.format_for_exported_note); + mContext = context; + mFileName = ""; + mFileDirectory = ""; + } + + /** + * 根据索引获取文本格式字符串。 + * + * @param id 格式字符串的索引 + * @return 对应的文本格式字符串 + */ + private String getFormat(int id) { + return TEXT_FORMAT[id]; + } + + /** + * 将指定文件夹下的笔记导出为文本，并写入指定的打印流。 + * + * @param folderId 文件夹的 ID + * @param ps 打印流，用于写入导出的文本 + */ + private void exportFolderToText(String folderId, PrintStream ps) { + // 查询属于该文件夹的笔记 + Cursor notesCursor = mContext.getContentResolver().query(Notes.CONTENT_NOTE_URI, + NOTE_PROJECTION, NoteColumns.PARENT_ID + "=?", new String[]{ + folderId + }, null); + + if (notesCursor != null) { + if (notesCursor.moveToFirst()) { + do { + // 打印笔记的最后修改日期 + ps.println(String.format(getFormat(FORMAT_NOTE_DATE), DateFormat.format( + mContext.getString(R.string.format_datetime_mdhm), + notesCursor.getLong(NOTE_COLUMN_MODIFIED_DATE)))); + // 查询属于该笔记的数据 + String noteId = notesCursor.getString(NOTE_COLUMN_ID); + exportNoteToText(noteId, ps); + } while (notesCursor.moveToNext()); + } + notesCursor.close(); + } + } + + /** + * 将指定 ID 的笔记导出为文本，并写入指定的打印流。 + * + * @param noteId 笔记的 ID + * @param ps 打印流，用于写入导出的文本 + */ + private void exportNoteToText(String noteId, PrintStream ps) { + // 查询属于该笔记的数据 + Cursor dataCursor = mContext.getContentResolver().query(Notes.CONTENT_DATA_URI, + DATA_PROJECTION, DataColumns.NOTE_ID + "=?", new String[]{ + noteId + }, null); + + if (dataCursor != null) { + if (dataCursor.moveToFirst()) { + do { + String mimeType = dataCursor.getString(DATA_COLUMN_MIME_TYPE); + if (DataConstants.CALL_NOTE.equals(mimeType)) { + // 打印电话号码 + String phoneNumber = dataCursor.getString(DATA_COLUMN_PHONE_NUMBER); + long callDate = dataCursor.getLong(DATA_COLUMN_CALL_DATE); + String location = dataCursor.getString(DATA_COLUMN_CONTENT); + + if (!TextUtils.isEmpty(phoneNumber)) { + ps.println(String.format(getFormat(FORMAT_NOTE_CONTENT), + phoneNumber)); + } + // 打印通话日期 + ps.println(String.format(getFormat(FORMAT_NOTE_CONTENT), DateFormat + .format(mContext.getString(R.string.format_datetime_mdhm), + callDate))); + // 打印通话附件位置 + if (!TextUtils.isEmpty(location)) { + ps.println(String.format(getFormat(FORMAT_NOTE_CONTENT), + location)); + } + } else if (DataConstants.NOTE.equals(mimeType)) { + String content = dataCursor.getString(DATA_COLUMN_CONTENT); + if (!TextUtils.isEmpty(content)) { + ps.println(String.format(getFormat(FORMAT_NOTE_CONTENT), + content)); + } + } + } while (dataCursor.moveToNext()); + } + dataCursor.close(); + } + // 在笔记之间打印换行符 + try { + ps.write(new byte[]{ + Character.LINE_SEPARATOR, Character.LETTER_NUMBER + }); + } catch (IOException e) { + Log.e(TAG, e.toString()); + } + } + + /** + * 将笔记数据导出为用户可读的文本文件。 + * + * @return 导出操作的状态码 + */ + public int exportToText() { + if (!externalStorageAvailable()) { + Log.d(TAG, "Media was not mounted"); + return STATE_SD_CARD_UNMOUONTED; + } + + PrintStream ps = getExportToTextPrintStream(); + if (ps == null) { + Log.e(TAG, "get print stream error"); + return STATE_SYSTEM_ERROR; + } + // 首先导出文件夹及其包含的笔记 + Cursor folderCursor = mContext.getContentResolver().query( + Notes.CONTENT_NOTE_URI, + NOTE_PROJECTION, + "(" + NoteColumns.TYPE + "=" + Notes.TYPE_FOLDER + " AND " + + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER + ") OR " + + NoteColumns.ID + "=" + Notes.ID_CALL_RECORD_FOLDER, null, null); + + if (folderCursor != null) { + if (folderCursor.moveToFirst()) { + do { + // 打印文件夹的名称 + String folderName = ""; + if (folderCursor.getLong(NOTE_COLUMN_ID) == Notes.ID_CALL_RECORD_FOLDER) { + folderName = mContext.getString(R.string.call_record_folder_name); + } else { + folderName = folderCursor.getString(NOTE_COLUMN_SNIPPET); + } + if (!TextUtils.isEmpty(folderName)) { + ps.println(String.format(getFormat(FORMAT_FOLDER_NAME), folderName)); + } + String folderId = folderCursor.getString(NOTE_COLUMN_ID); + exportFolderToText(folderId, ps); + } while (folderCursor.moveToNext()); + } + folderCursor.close(); + } + + // 导出根文件夹下的笔记 + Cursor noteCursor = mContext.getContentResolver().query( + Notes.CONTENT_NOTE_URI, + NOTE_PROJECTION, + NoteColumns.TYPE + "=" + Notes.TYPE_NOTE + " AND " + NoteColumns.PARENT_ID + + "=0", null, null); + + if (noteCursor != null) { + if (noteCursor.moveToFirst()) { + do { + ps.println(String.format(getFormat(FORMAT_NOTE_DATE), DateFormat.format( + mContext.getString(R.string.format_datetime_mdhm), + noteCursor.getLong(NOTE_COLUMN_MODIFIED_DATE)))); + // 查询属于该笔记的数据 + String noteId = noteCursor.getString(NOTE_COLUMN_ID); + exportNoteToText(noteId, ps); + } while (noteCursor.moveToNext()); + } + noteCursor.close(); + } + ps.close(); + + return STATE_SUCCESS; + } + + /** + * 获取一个指向导出文本文件的打印流。 + * + * @return 打印流，如果创建文件失败则返回 null + */ + private PrintStream getExportToTextPrintStream() { + File file = generateFileMountedOnSDcard(mContext, R.string.file_path, + R.string.file_name_txt_format); + if (file == null) { + Log.e(TAG, "create file to exported failed"); + return null; + } + mFileName = file.getName(); + mFileDirectory = mContext.getString(R.string.file_path); + PrintStream ps = null; + try { + FileOutputStream fos = new FileOutputStream(file); + ps = new PrintStream(fos); + } catch (FileNotFoundException e) { + e.printStackTrace(); + return null; + } catch (NullPointerException e) { + e.printStackTrace(); + return null; + } + return ps; + } + } + + /** + * 在 SD 卡上生成用于存储导入数据的文本文件。 + * + * @param context 应用程序上下文 + * @param filePathResId 文件路径的资源 ID + * @param fileNameFormatResId 文件名格式的资源 ID + * @return 生成的文件，如果创建失败则返回 null + */ + private static File generateFileMountedOnSDcard(Context context, int filePathResId, int fileNameFormatResId) { + StringBuilder sb = new StringBuilder(); + sb.append(Environment.getExternalStorageDirectory()); + sb.append(context.getString(filePathResId)); + File filedir = new File(sb.toString()); + sb.append(context.getString( + fileNameFormatResId, + DateFormat.format(context.getString(R.string.format_date_ymd), + System.currentTimeMillis()))); + File file = new File(sb.toString()); + + try { + if (!filedir.exists()) { + filedir.mkdir(); + } + if (!file.exists()) { + file.createNewFile(); + } + return file; + } catch (SecurityException e) { + e.printStackTrace(); + } catch (IOException e) { + e.printStackTrace(); + } + + return null; + } +} \ No newline at end of file diff --git a/src/tool/DataUtils.java b/src/tool/DataUtils.java new file mode 100644 index 0000000..0a6e5f6 --- /dev/null +++ b/src/tool/DataUtils.java @@ -0,0 +1,445 @@ +/* + * 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.tool; + +import android.content.ContentProviderOperation; +import android.content.ContentProviderResult; +import android.content.ContentResolver; +import android.content.ContentUris; +import android.content.ContentValues; +import android.content.OperationApplicationException; +import android.database.Cursor; +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.NoteColumns; +import net.micode.notes.ui.NotesListAdapter.AppWidgetAttribute; + +import java.util.ArrayList; +import java.util.HashSet; + +/** + * 该类包含一系列用于处理笔记数据的实用方法，如批量删除笔记、移动笔记到文件夹等。 + */ +public class DataUtils { + // 日志标签，用于调试和记录信息 + public static final String TAG = "DataUtils"; + + /** + * 批量删除笔记的方法。 + * + * @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; + } + + /** + * 将笔记移动到指定文件夹的方法。 + * + * @param resolver 内容解析器，用于与内容提供者进行交互 + * @param id 要移动的笔记 ID + * @param srcFolderId 笔记当前所在的文件夹 ID + * @param desFolderId 笔记要移动到的目标文件夹 ID + */ + public static void moveNoteToFoler(ContentResolver resolver, long id, long srcFolderId, long desFolderId) { + // 创建一个 ContentValues 对象，用于存储要更新的数据 + ContentValues values = new ContentValues(); + // 设置新的父文件夹 ID + values.put(NoteColumns.PARENT_ID, desFolderId); + // 设置原始父文件夹 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); + } + + /** + * 批量将笔记移动到指定文件夹的方法。 + * + * @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 + 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; + } + + /** + * 获取用户文件夹的数量（不包括系统文件夹）。 + * + * @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 + "<>?", + new String[] { String.valueOf(Notes.TYPE_FOLDER), String.valueOf(Notes.ID_TRASH_FOLER)}, + 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(); + } + } + } + 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, + new String [] {String.valueOf(type)}, + null); + + boolean exist = false; + // 检查游标是否有效 + if (cursor != null) { + // 检查是否有查询结果 + if (cursor.getCount() > 0) { + exist = true; + } + // 关闭游标 + cursor.close(); + } + return exist; + } + + /** + * 检查笔记是否存在于数据库中。 + * + * @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; + } + + /** + * 检查数据是否存在于数据库中。 + * + * @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 笔记小部件属性的集合 + */ + 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 + "=?", + new String[] { String.valueOf(folderId) }, + 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 + "=?", + new String [] { String.valueOf(noteId), CallNote.CONTENT_ITEM_TYPE }, + null); + + 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(" + + CallNote.PHONE_NUMBER + ",?)", + new String [] { String.valueOf(callDate), CallNote.CONTENT_ITEM_TYPE, phoneNumber }, + 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 笔记摘要 + * @throws IllegalArgumentException 如果未找到指定 ID 的笔记 + */ + public static String getSnippetById(ContentResolver resolver, long noteId) { + // 查询指定笔记的摘要 + Cursor cursor = resolver.query(Notes.CONTENT_NOTE_URI, + new String [] { NoteColumns.SNIPPET }, + NoteColumns.ID + "=?", + new String [] { String.valueOf(noteId)}, + null); + + 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); + } \ No newline at end of file diff --git a/src/tool/GTaskStringUtils.java b/src/tool/GTaskStringUtils.java new file mode 100644 index 0000000..a3dc220 --- /dev/null +++ b/src/tool/GTaskStringUtils.java @@ -0,0 +1,162 @@ +/* + * 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.tool; + +/** + * 该类定义了一系列用于处理 Google 任务（GTask）相关 JSON 数据的常量字符串。 + * 这些常量可用于解析和生成与 GTask 交互时所需的 JSON 数据。 + */ +public class GTaskStringUtils { + + // 定义 JSON 数据中表示动作 ID 的键名 + public final static String GTASK_JSON_ACTION_ID = "action_id"; + + // 定义 JSON 数据中表示动作列表的键名 + public final static String GTASK_JSON_ACTION_LIST = "action_list"; + + // 定义 JSON 数据中表示动作类型的键名 + public final static String GTASK_JSON_ACTION_TYPE = "action_type"; + + // 定义 JSON 数据中表示创建动作类型的值 + public final static String GTASK_JSON_ACTION_TYPE_CREATE = "create"; + + // 定义 JSON 数据中表示获取所有数据动作类型的值 + public final static String GTASK_JSON_ACTION_TYPE_GETALL = "get_all"; + + // 定义 JSON 数据中表示移动动作类型的值 + public final static String GTASK_JSON_ACTION_TYPE_MOVE = "move"; + + // 定义 JSON 数据中表示更新动作类型的值 + public final static String GTASK_JSON_ACTION_TYPE_UPDATE = "update"; + + // 定义 JSON 数据中表示创建者 ID 的键名 + public final static String GTASK_JSON_CREATOR_ID = "creator_id"; + + // 定义 JSON 数据中表示子实体的键名 + public final static String GTASK_JSON_CHILD_ENTITY = "child_entity"; + + // 定义 JSON 数据中表示客户端版本的键名 + public final static String GTASK_JSON_CLIENT_VERSION = "client_version"; + + // 定义 JSON 数据中表示任务是否完成的键名 + public final static String GTASK_JSON_COMPLETED = "completed"; + + // 定义 JSON 数据中表示当前列表 ID 的键名 + public final static String GTASK_JSON_CURRENT_LIST_ID = "current_list_id"; + + // 定义 JSON 数据中表示默认列表 ID 的键名 + public final static String GTASK_JSON_DEFAULT_LIST_ID = "default_list_id"; + + // 定义 JSON 数据中表示任务是否删除的键名 + public final static String GTASK_JSON_DELETED = "deleted"; + + // 定义 JSON 数据中表示目标列表的键名 + public final static String GTASK_JSON_DEST_LIST = "dest_list"; + + // 定义 JSON 数据中表示目标父级的键名 + public final static String GTASK_JSON_DEST_PARENT = "dest_parent"; + + // 定义 JSON 数据中表示目标父级类型的键名 + public final static String GTASK_JSON_DEST_PARENT_TYPE = "dest_parent_type"; + + // 定义 JSON 数据中表示实体变化量的键名 + public final static String GTASK_JSON_ENTITY_DELTA = "entity_delta"; + + // 定义 JSON 数据中表示实体类型的键名 + public final static String GTASK_JSON_ENTITY_TYPE = "entity_type"; + + // 定义 JSON 数据中表示获取已删除数据的键名 + public final static String GTASK_JSON_GET_DELETED = "get_deleted"; + + // 定义 JSON 数据中表示 ID 的键名 + public final static String GTASK_JSON_ID = "id"; + + // 定义 JSON 数据中表示索引的键名 + public final static String GTASK_JSON_INDEX = "index"; + + // 定义 JSON 数据中表示最后修改时间的键名 + public final static String GTASK_JSON_LAST_MODIFIED = "last_modified"; + + // 定义 JSON 数据中表示最新同步点的键名 + public final static String GTASK_JSON_LATEST_SYNC_POINT = "latest_sync_point"; + + // 定义 JSON 数据中表示列表 ID 的键名 + public final static String GTASK_JSON_LIST_ID = "list_id"; + + // 定义 JSON 数据中表示列表集合的键名 + public final static String GTASK_JSON_LISTS = "lists"; + + // 定义 JSON 数据中表示名称的键名 + public final static String GTASK_JSON_NAME = "name"; + + // 定义 JSON 数据中表示新 ID 的键名 + public final static String GTASK_JSON_NEW_ID = "new_id"; + + // 定义 JSON 数据中表示备注的键名 + public final static String GTASK_JSON_NOTES = "notes"; + + // 定义 JSON 数据中表示父级 ID 的键名 + public final static String GTASK_JSON_PARENT_ID = "parent_id"; + + // 定义 JSON 数据中表示前一个兄弟节点 ID 的键名 + public final static String GTASK_JSON_PRIOR_SIBLING_ID = "prior_sibling_id"; + + // 定义 JSON 数据中表示结果的键名 + public final static String GTASK_JSON_RESULTS = "results"; + + // 定义 JSON 数据中表示源列表的键名 + public final static String GTASK_JSON_SOURCE_LIST = "source_list"; + + // 定义 JSON 数据中表示任务集合的键名 + public final static String GTASK_JSON_TASKS = "tasks"; + + // 定义 JSON 数据中表示类型的键名 + public final static String GTASK_JSON_TYPE = "type"; + + // 定义 JSON 数据中表示组类型的值 + public final static String GTASK_JSON_TYPE_GROUP = "GROUP"; + + // 定义 JSON 数据中表示任务类型的值 + public final static String GTASK_JSON_TYPE_TASK = "TASK"; + + // 定义 JSON 数据中表示用户的键名 + public final static String GTASK_JSON_USER = "user"; + + // 定义 MIUI 文件夹前缀 + public final static String MIUI_FOLDER_PREFFIX = "[MIUI_Notes]"; + + // 定义默认文件夹名称 + public final static String FOLDER_DEFAULT = "Default"; + + // 定义通话记录文件夹名称 + public final static String FOLDER_CALL_NOTE = "Call_Note"; + + // 定义元数据文件夹名称 + public final static String FOLDER_META = "METADATA"; + + // 定义元数据头部的 GTask ID 键名 + public final static String META_HEAD_GTASK_ID = "meta_gid"; + + // 定义元数据头部的备注键名 + public final static String META_HEAD_NOTE = "meta_note"; + + // 定义元数据头部的数据键名 + public final static String META_HEAD_DATA = "meta_data"; + + // 定义元数据备注名称，提示不要更新和删除 + public final static String META_NOTE_NAME = "[META INFO] DON'T UPDATE AND DELETE"; +} \ No newline at end of file diff --git a/src/tool/ResourceParser.java b/src/tool/ResourceParser.java new file mode 100644 index 0000000..e4d9136 --- /dev/null +++ b/src/tool/ResourceParser.java @@ -0,0 +1,272 @@ +/* + * 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.tool; + +import android.content.Context; +import android.preference.PreferenceManager; + +import net.micode.notes.R; +import net.micode.notes.ui.NotesPreferenceActivity; + +/** + * ResourceParser 类用于解析和管理与笔记相关的资源，包括背景颜色、字体大小和不同视图的背景资源。 + */ +public class ResourceParser { + + // 定义笔记背景颜色的常量 + public static final int YELLOW = 0; + public static final int BLUE = 1; + public static final int WHITE = 2; + public static final int GREEN = 3; + public static final int RED = 4; + + // 默认的笔记背景颜色 + public static final int BG_DEFAULT_COLOR = YELLOW; + + // 定义笔记文本大小的常量 + public static final int TEXT_SMALL = 0; + public static final int TEXT_MEDIUM = 1; + public static final int TEXT_LARGE = 2; + public static final int TEXT_SUPER = 3; + + // 默认的笔记文本大小 + public static final int BG_DEFAULT_FONT_SIZE = TEXT_MEDIUM; + + /** + * NoteBgResources 类用于管理笔记编辑视图的背景资源。 + */ + public static class NoteBgResources { + // 笔记编辑视图的背景资源数组 + private final static int [] BG_EDIT_RESOURCES = new int [] { + R.drawable.edit_yellow, + R.drawable.edit_blue, + R.drawable.edit_white, + R.drawable.edit_green, + R.drawable.edit_red + }; + + // 笔记编辑视图标题的背景资源数组 + private final static int [] BG_EDIT_TITLE_RESOURCES = new int [] { + R.drawable.edit_title_yellow, + R.drawable.edit_title_blue, + R.drawable.edit_title_white, + R.drawable.edit_title_green, + R.drawable.edit_title_red + }; + + /** + * 根据给定的颜色 ID 获取笔记编辑视图的背景资源。 + * @param id 颜色 ID + * @return 对应的背景资源 ID + */ + public static int getNoteBgResource(int id) { + return BG_EDIT_RESOURCES[id]; + } + + /** + * 根据给定的颜色 ID 获取笔记编辑视图标题的背景资源。 + * @param id 颜色 ID + * @return 对应的标题背景资源 ID + */ + public static int getNoteTitleBgResource(int id) { + return BG_EDIT_TITLE_RESOURCES[id]; + } + } + + /** + * 获取默认的笔记背景颜色 ID。 + * 如果在偏好设置中设置了随机背景颜色，则随机返回一个颜色 ID； + * 否则返回默认的背景颜色 ID。 + * @param context 上下文对象 + * @return 默认的背景颜色 ID + */ + public static int getDefaultBgId(Context context) { + if (PreferenceManager.getDefaultSharedPreferences(context).getBoolean( + NotesPreferenceActivity.PREFERENCE_SET_BG_COLOR_KEY, false)) { + // 如果设置了随机背景颜色，随机生成一个颜色 ID + return (int) (Math.random() * NoteBgResources.BG_EDIT_RESOURCES.length); + } else { + // 否则返回默认的背景颜色 ID + return BG_DEFAULT_COLOR; + } + } + + /** + * NoteItemBgResources 类用于管理笔记列表项的背景资源。 + */ + public static class NoteItemBgResources { + // 笔记列表项第一个的背景资源数组 + private final static int [] BG_FIRST_RESOURCES = new int [] { + R.drawable.list_yellow_up, + R.drawable.list_blue_up, + R.drawable.list_white_up, + R.drawable.list_green_up, + R.drawable.list_red_up + }; + + // 笔记列表项中间的背景资源数组 + private final static int [] BG_NORMAL_RESOURCES = new int [] { + R.drawable.list_yellow_middle, + R.drawable.list_blue_middle, + R.drawable.list_white_middle, + R.drawable.list_green_middle, + R.drawable.list_red_middle + }; + + // 笔记列表项最后一个的背景资源数组 + private final static int [] BG_LAST_RESOURCES = new int [] { + R.drawable.list_yellow_down, + R.drawable.list_blue_down, + R.drawable.list_white_down, + R.drawable.list_green_down, + R.drawable.list_red_down, + }; + + // 笔记列表项只有一个时的背景资源数组 + private final static int [] BG_SINGLE_RESOURCES = new int [] { + R.drawable.list_yellow_single, + R.drawable.list_blue_single, + R.drawable.list_white_single, + R.drawable.list_green_single, + R.drawable.list_red_single + }; + + /** + * 根据给定的颜色 ID 获取笔记列表项第一个的背景资源。 + * @param id 颜色 ID + * @return 对应的背景资源 ID + */ + public static int getNoteBgFirstRes(int id) { + return BG_FIRST_RESOURCES[id]; + } + + /** + * 根据给定的颜色 ID 获取笔记列表项最后一个的背景资源。 + * @param id 颜色 ID + * @return 对应的背景资源 ID + */ + public static int getNoteBgLastRes(int id) { + return BG_LAST_RESOURCES[id]; + } + + /** + * 根据给定的颜色 ID 获取笔记列表项只有一个时的背景资源。 + * @param id 颜色 ID + * @return 对应的背景资源 ID + */ + public static int getNoteBgSingleRes(int id) { + return BG_SINGLE_RESOURCES[id]; + } + + /** + * 根据给定的颜色 ID 获取笔记列表项中间的背景资源。 + * @param id 颜色 ID + * @return 对应的背景资源 ID + */ + public static int getNoteBgNormalRes(int id) { + return BG_NORMAL_RESOURCES[id]; + } + + /** + * 获取文件夹的背景资源。 + * @return 文件夹的背景资源 ID + */ + public static int getFolderBgRes() { + return R.drawable.list_folder; + } + } + + /** + * WidgetBgResources 类用于管理小部件的背景资源。 + */ + public static class WidgetBgResources { + // 2x 小部件的背景资源数组 + private final static int [] BG_2X_RESOURCES = new int [] { + R.drawable.widget_2x_yellow, + R.drawable.widget_2x_blue, + R.drawable.widget_2x_white, + R.drawable.widget_2x_green, + R.drawable.widget_2x_red, + }; + + /** + * 根据给定的颜色 ID 获取 2x 小部件的背景资源。 + * @param id 颜色 ID + * @return 对应的背景资源 ID + */ + public static int getWidget2xBgResource(int id) { + return BG_2X_RESOURCES[id]; + } + + // 4x 小部件的背景资源数组 + private final static int [] BG_4X_RESOURCES = new int [] { + R.drawable.widget_4x_yellow, + R.drawable.widget_4x_blue, + R.drawable.widget_4x_white, + R.drawable.widget_4x_green, + R.drawable.widget_4x_red + }; + + /** + * 根据给定的颜色 ID 获取 4x 小部件的背景资源。 + * @param id 颜色 ID + * @return 对应的背景资源 ID + */ + public static int getWidget4xBgResource(int id) { + return BG_4X_RESOURCES[id]; + } + } + + /** + * TextAppearanceResources 类用于管理文本外观资源。 + */ + public static class TextAppearanceResources { + // 文本外观资源数组 + private final static int [] TEXTAPPEARANCE_RESOURCES = new int [] { + R.style.TextAppearanceNormal, + R.style.TextAppearanceMedium, + R.style.TextAppearanceLarge, + R.style.TextAppearanceSuper + }; + + /** + * 根据给定的 ID 获取文本外观资源。 + * 如果 ID 超出了资源数组的长度，返回默认的字体大小对应的资源。 + * @param id 文本外观 ID + * @return 对应的文本外观资源 ID + */ + public static int getTexAppearanceResource(int id) { + /** + * HACKME: Fix bug of store the resource id in shared preference. + * The id may larger than the length of resources, in this case, + * return the {@link ResourceParser#BG_DEFAULT_FONT_SIZE} + */ + if (id >= TEXTAPPEARANCE_RESOURCES.length) { + return BG_DEFAULT_FONT_SIZE; + } + return TEXTAPPEARANCE_RESOURCES[id]; + } + + /** + * 获取文本外观资源数组的长度。 + * @return 文本外观资源数组的长度 + */ + public static int getResourcesSize() { + return TEXTAPPEARANCE_RESOURCES.length; + } + } +} \ No newline at end of file