/* * 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; // 导入Android框架和Java标准库中的类 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; // Notes类内部的一个静态内部类，定义了数据表的列名 import net.micode.notes.data.Notes.DataConstants; // Notes类内部的一个静态内部类，定义了数据相关的常量 import net.micode.notes.data.Notes.NoteColumns; // Notes类内部的一个静态内部类，定义了笔记数据表的列名 import java.io.File; // 表示文件和目录路径名的抽象表示形式 import java.io.FileNotFoundException; // 当尝试打开文件失败时抛出的异常 import java.io.FileOutputStream; // 文件输出流，用于将数据写入文件 import java.io.IOException; // 发生I/O错误时抛出的通用异常类 import java.io.PrintStream; // 打印流，用于打印各种数据表示形式 // 声明BackupUtils类 public class BackupUtils { // 定义一个静态常量TAG，用于日志记录中的标签 private static final String TAG = "BackupUtils"; // 定义一个静态变量sInstance，用于存储BackupUtils类的单例实例 private static BackupUtils sInstance; // 定义一个私有构造函数，防止外部通过new关键字创建实例 // 注意：构造函数在这段代码中并未直接给出，但它是单例模式实现的关键部分 // 定义一个公开的静态同步方法getInstance，用于获取BackupUtils类的实例 public static synchronized BackupUtils getInstance(Context context) { // 如果sInstance为null，说明还没有创建实例，则创建一个新的实例并赋值给sInstance if (sInstance == null) { sInstance = new BackupUtils(context); // 注意：这里的构造函数是假设的，实际代码中需要定义 } // 返回sInstance，即BackupUtils类的单例实例 return sInstance; } } /** * Following states are signs to represents backup or restore * status */ // Currently, the sdcard is not mounted // 定义一些静态常量，用于表示不同的状态 public static final int STATE_SD_CARD_UNMOUONTED = 0; // SD卡未挂载的状态码 // 备注：这里有一个拼写错误，应该是"UNMOUNTED"而不是"UNMOUONTED" public static final int STATE_BACKUP_FILE_NOT_EXIST = 1; // 备份文件不存在的状态码 public static final int STATE_DATA_DESTROIED = 2; // 数据被破坏（可能由其他程序更改）的状态码 // 备注：这里有一个拼写错误，应该是"DESTROYED"而不是"DESTROIED" public static final int STATE_SYSTEM_ERROR = 3; // 系统错误导致备份或恢复失败的状态码 public static final int STATE_SUCCESS = 4; // 备份或恢复成功的状态码 // 定义一个私有成员变量，用于文本导出功能 private TextExport mTextExport; // 私有构造函数，防止外部直接实例化BackupUtils类 // 备注：这是单例模式实现的一部分，构造函数接受一个Context参数 private BackupUtils(Context context) { mTextExport = new TextExport(context); // 初始化mTextExport成员变量 } // 定义一个私有静态方法，用于检查外部存储是否可用 private static boolean externalStorageAvailable() { // 通过比较Environment.getExternalStorageState()的返回值和Environment.MEDIA_MOUNTED来判断 return Environment.MEDIA_MOUNTED.equals(Environment.getExternalStorageState()); } // 定义一个公开的方法，用于导出数据到文本文件 // 备注：这个方法返回的是一个状态码，表示导出操作的结果 public int exportToText() { return mTextExport.exportToText(); // 调用TextExport类的exportToText方法 } // 定义一个公开的方法，用于获取导出的文本文件的文件名 public String getExportedTextFileName() { return mTextExport.mFileName; // 直接访问TextExport类的mFileName成员变量 } // 定义一个公开的方法，用于获取导出的文本文件的目录 public String getExportedTextFileDir() { return mTextExport.mFileDirectory; // 直接访问TextExport类的mFileDirectory成员变量 } // 定义一个私有静态内部类，用于实现文本导出的具体逻辑 private static class TextExport { // 定义一个静态常量数组，用于指定从数据库查询时需要返回的列 private static final String[] NOTE_PROJECTION = { NoteColumns.ID, // 笔记的ID NoteColumns.MODIFIED_DATE, // 笔记的最后修改日期 NoteColumns.SNIPPET, // 笔记的摘要或简短内容 NoteColumns.TYPE // 笔记的类型 }; // 备注：TextExport类的其他部分（如构造函数、exportToText方法以及mFileName和mFileDirectory成员变量） // 在这段代码中未给出，但我们可以推断它们存在并用于实现文本导出的功能。 } // 定义静态常量，用于表示数据库查询结果中笔记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, // MIME类型 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; // 这里有一个问题：DATA_COLUMN_CALL_DATE（电话日期）与DATA_PROJECTION数组不匹配 // 因为DATA_PROJECTION中没有与电话日期对应的列，这可能会导致索引越界错误 private static final int DATA_COLUMN_CALL_DATE = 2; // 定义静态常量，用于表示数据查询结果中电话号码列的索引位置 // 但这里也有问题：根据DATA_PROJECTION数组，DATA_COLUMN_PHONE_NUMBER应该指向索引4， // 这个定义是正确的，但是之前的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; // 定义一个实例变量，用于存储上下文（Context）对象 private Context mContext; // 定义一个实例变量，用于存储导出的文本文件的文件名 private String mFileName; // 定义一个实例变量，用于存储导出的文本文件的目录 private String mFileDirectory; // 构造函数，用于初始化TextExport对象 public TextExport(Context context) { // 从资源文件中获取格式化字符串数组，并赋值给TEXT_FORMAT实例变量 TEXT_FORMAT = context.getResources().getStringArray(R.array.format_for_exported_note); // 将传入的上下文对象赋值给mContext实例变量 mContext = context; // 初始化mFileName和mFileDirectory实例变量为空字符串 mFileName = ""; mFileDirectory = ""; } // 定义一个私有方法，接收一个文件夹ID（字符串）和一个打印流（PrintStream）作为参数，无返回值 private void exportFolderToText(String folderId, PrintStream ps) { // 使用getContentResolver()方法从内容提供者处查询属于指定文件夹的笔记 // Notes.CONTENT_NOTE_URI是内容提供者的URI，NOTE_PROJECTION是查询返回的列投影 // NoteColumns.PARENT_ID + "=?"是查询的选择条件，new String[] { folderId }是选择条件的参数 Cursor notesCursor = mContext.getContentResolver().query(Notes.CONTENT_NOTE_URI, NOTE_PROJECTION, NoteColumns.PARENT_ID + "=?", new String[] { folderId }, null); // 检查查询返回的Cursor是否不为null if (notesCursor != null) { // 移动Cursor到第一行，如果查询结果不为空，则进入if语句 if (notesCursor.moveToFirst()) { // 使用do-while循环遍历查询结果集 do { // 打印笔记的最后修改日期 // 使用getFormat(FORMAT_NOTE_DATE)获取格式化字符串，然后使用DateFormat.format()和getString(R.string.format_datetime_mdhm) // 格式化最后修改日期，最后通过PrintStream的println方法打印出来 ps.println(String.format(getFormat(FORMAT_NOTE_DATE), DateFormat.format( mContext.getString(R.string.format_datetime_mdhm), notesCursor.getLong(NOTE_COLUMN_MODIFIED_DATE)))); // 查询属于当前笔记的数据 // 从Cursor中获取笔记的ID String noteId = notesCursor.getString(NOTE_COLUMN_ID); // 调用exportNoteToText方法导出当前笔记的文本内容到PrintStream中 // 注意：exportNoteToText方法需要在当前类中定义，但您没有提供其实现 exportNoteToText(noteId, ps); } while (notesCursor.moveToNext()); // 循环直到Cursor遍历完所有行 } // 关闭Cursor，释放资源 notesCursor.close(); } } /** * Export note identified by id to a print stream */ // 定义一个私有方法，用于将指定笔记ID的笔记内容导出到文本输出流（PrintStream）中 private void exportNoteToText(String noteId, PrintStream ps) { // 使用内容解析器查询与指定笔记ID匹配的笔记数据 // 这里的Notes.CONTENT_DATA_URI是内容提供者的URI，DATA_PROJECTION是我们要查询的列投影 // DataColumns.NOTE_ID + "=?"是查询条件，表示我们要查询的笔记ID // new String[] { noteId }是查询条件的参数，即具体的笔记ID值 Cursor dataCursor = mContext.getContentResolver().query(Notes.CONTENT_DATA_URI, DATA_PROJECTION, DataColumns.NOTE_ID + "=?", new String[] { noteId }, null); // 检查查询返回的Cursor是否不为空 if (dataCursor != null) { // 移动Cursor到第一行数据（如果有的话） if (dataCursor.moveToFirst()) { // 使用do-while循环遍历Cursor中的所有行 do { // 从当前行中获取MIME类型 String mimeType = dataCursor.getString(DATA_COLUMN_MIME_TYPE); // 判断MIME类型是否为CALL_NOTE，即电话笔记 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); // 这里location可能表示电话笔记的附加信息或位置，但命名可能有些误导 // 如果电话号码不为空，则按照指定格式打印电话号码 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))); // 如果location（附加信息）不为空，则按照指定格式打印它 if (!TextUtils.isEmpty(location)) { ps.println(String.format(getFormat(FORMAT_NOTE_CONTENT), location)); } } // 判断MIME类型是否为普通笔记 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()); // 移动到下一行，继续循环 } // 关闭Cursor以释放资源 dataCursor.close(); } } // print a line separator between note try {//这段代码尝试向PrintStream对象ps写入一个字节数组， //该数组包含一个换行符（Character.LINE_SEPARATOR）和一个字符（Character.LETTER_NUMBER， //如果写入过程中发生IOException，则捕获异常并通过日志打印错误信息。 ps.write(new byte[] { Character.LINE_SEPARATOR, Character.LETTER_NUMBER }); } catch (IOException e) { Log.e(TAG, e.toString()); } } /** * Note will be exported as text which is user readable */ public int exportToText() { //这是一个方法的声明，名为exportToText，它返回一个整型值，表示导出操作的状态。方法上方的注释说明笔记将被导出为用户可读的文本格式。 if (!externalStorageAvailable()) { //这段代码检查外部存储是否可用。如果不可用，则记录一条调试日志，并返回表示SD卡未挂载的状态码。 Log.d(TAG, "Media was not mounted"); return STATE_SD_CARD_UNMOUONTED; } PrintStream ps = getExportToTextPrintStream(); //获取一个PrintStream对象，用于将文本写入文件。如果获取失败（即ps为null），则记录一条错误日志，并返回表示系统错误的状态码。 if (ps == null) { Log.e(TAG, "get print stream error"); return STATE_SYSTEM_ERROR; } // First export folder and its notes //使用ContentResolver查询数据库，获取所有文件夹（不包括垃圾文件夹）和通话记录文件夹的游标。 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 { // Print folder's name 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(); } // Export notes in root's folder //再次使用ContentResolver查询数据库，这次获取所有根目录下的笔记的游标。 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)))); // Query data belong to this note String noteId = noteCursor.getString(NOTE_COLUMN_ID); exportNoteToText(noteId, ps); } while (noteCursor.moveToNext()); } noteCursor.close(); } ps.close();//关闭PrintStream对象，完成文件写入。 return STATE_SUCCESS;//返回表示操作成功的状态码。 } /** * Get a print stream pointed to the file {@generateExportedTextFile} */ private PrintStream getExportToTextPrintStream() { //这是一个私有方法，返回一个PrintStream对象，用于将文本写入文件。 File file = generateFileMountedOnSDcard(mContext, R.string.file_path, R.string.file_name_txt_format); //调用generateFileMountedOnSDcard方法生成一个文件，并返回该文件的File对象。 //这个方法需要三个参数：上下文mContext，文件路径的资源IDR.string.file_path，和文件名格式的资源IDR.string.file_name_txt_format。 if (file == null) { Log.e(TAG, "create file to exported failed"); return null;//如果generateFileMountedOnSDcard方法返回null，表示文件创建失败，则记录一条错误日志，并返回null。 } mFileName = file.getName(); mFileDirectory = mContext.getString(R.string.file_path);//获取文件的名称和文件所在的目录路径，并将它们分别赋值给mFileName和mFileDirectory变量。 PrintStream ps = null;//声明一个PrintStream对象ps，初始化为null。 try { //尝试创建一个FileOutputStream对象fos，用于向文件写入数据。然后，使用fos创建一个PrintStream对象ps。 //如果在创建FileOutputStream或PrintStream时发生FileNotFoundException或NullPointerException，则捕获异常，打印堆栈跟踪，并返回null。 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;//返回PrintStream对象ps。 } } /** * Generate the text file to store imported data */ private static File generateFileMountedOnSDcard(Context context, int filePathResId, int fileNameFormatResId) { //这是一个私有静态方法，返回一个File对象，表示在SD卡上创建的文件。 StringBuilder sb = new StringBuilder();//创建一个StringBuilder对象sb，并向其中追加SD卡的根目录路径。 sb.append(Environment.getExternalStorageDirectory()); sb.append(context.getString(filePathResId));//向sb中追加文件路径字符串，该字符串是从资源文件中获取的。 File filedir = new File(sb.toString());//使用sb.toString()创建一个表示文件目录的File对象filedir。 sb.append(context.getString( //向sb中追加文件名，文件名是根据提供的格式资源ID和当前时间格式化的。 fileNameFormatResId, DateFormat.format(context.getString(R.string.format_date_ymd), System.currentTimeMillis()))); File file = new File(sb.toString());//使用sb.toString()创建一个表示文件的File对象file。 try { //尝试检查文件目录是否存在，如果不存在则创建它。然后，检查文件是否存在，如果不存在则创建新文件。 //如果在检查或创建目录/文件时发生SecurityException或IOException，则捕获异常，打印堆栈跟踪。 if (!filedir.exists()) { filedir.mkdir(); } if (!file.exists()) { file.createNewFile(); } return file; } catch (SecurityException e) { e.printStackTrace(); } catch (IOException e) { e.printStackTrace(); } return null;//如果方法执行过程中出现任何异常，或者文件无法被创建，则返回null。 } }