|
|
/*
|
|
|
* 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;
|
|
|
|
|
|
/**
|
|
|
* BackupUtils 类提供了将应用程序中的笔记数据备份到文本文件的功能。
|
|
|
*/
|
|
|
public class BackupUtils {
|
|
|
private static final String TAG = "BackupUtils";
|
|
|
// Singleton 实例
|
|
|
private static BackupUtils sInstance;
|
|
|
|
|
|
/**
|
|
|
* 获取 BackupUtils 类的单例对象。
|
|
|
*
|
|
|
* @param context Android 上下文对象。
|
|
|
* @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;
|
|
|
|
|
|
/**
|
|
|
* BackupUtils 类的构造函数。
|
|
|
*
|
|
|
* @param context Android 上下文对象。
|
|
|
*/
|
|
|
private BackupUtils(Context context) {
|
|
|
mTextExport = new TextExport(context);
|
|
|
}
|
|
|
|
|
|
/**
|
|
|
* 检查外部存储是否可用。
|
|
|
*
|
|
|
* @return 如果外部存储可用，返回 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;
|
|
|
}
|
|
|
|
|
|
/**
|
|
|
* TextExport 类负责将笔记数据导出到文本文件。
|
|
|
*/
|
|
|
private static class TextExport {
|
|
|
// 省略了部分代码注释，因为它们已经在代码中以注释的形式给出。
|
|
|
// 这些代码主要是定义了一些用于查询数据库的投影数组，以及用于格式化输出文本的字符串数组。
|
|
|
|
|
|
private Context mContext;
|
|
|
private String mFileName;
|
|
|
private String mFileDirectory;
|
|
|
|
|
|
/**
|
|
|
* TextExport 类的构造函数。
|
|
|
*
|
|
|
* @param context Android 上下文对象。
|
|
|
*/
|
|
|
public TextExport(Context context) {
|
|
|
// 初始化格式化字符串数组和上下文对象。
|
|
|
}
|
|
|
|
|
|
/**
|
|
|
* 根据资源ID获取格式化字符串。
|
|
|
*
|
|
|
* @param id 资源ID。
|
|
|
* @return 格式化字符串。
|
|
|
*/
|
|
|
private String getFormat(int id) {
|
|
|
return TEXT_FORMAT[id];
|
|
|
}
|
|
|
|
|
|
/**
|
|
|
* 将指定文件夹中的笔记导出到文本文件。
|
|
|
*
|
|
|
* @param folderId 文件夹ID。
|
|
|
* @param ps PrintStream 对象，用于写入文本文件。
|
|
|
*/
|
|
|
private void exportFolderToText(String folderId, PrintStream ps) {
|
|
|
// 查询属于该文件夹的笔记，并导出。
|
|
|
}
|
|
|
|
|
|
/**
|
|
|
* 将指定笔记导出到文本文件。
|
|
|
*
|
|
|
* @param noteId 笔记ID。
|
|
|
* @param ps PrintStream 对象，用于写入文本文件。
|
|
|
*/
|
|
|
private void exportNoteToText(String noteId, PrintStream ps) {
|
|
|
// 查询属于该笔记的数据，并导出。
|
|
|
}
|
|
|
|
|
|
/**
|
|
|
* 将笔记数据导出为用户可读的文本格式。
|
|
|
*
|
|
|
* @return 一个表示操作结果的状态码。
|
|
|
*/
|
|
|
public int exportToText() {
|
|
|
// 检查外部存储是否可用，然后导出笔记数据到文本文件。
|
|
|
}
|
|
|
|
|
|
/**
|
|
|
* 获取指向导出文本文件的 PrintStream 对象。
|
|
|
*
|
|
|
* @return PrintStream 对象，或者在出错时返回 null。
|
|
|
*/
|
|
|
private PrintStream getExportToTextPrintStream() {
|
|
|
// 创建或获取文件，并返回 PrintStream 对象。
|
|
|
}
|
|
|
}
|
|
|
|
|
|
/**
|
|
|
* 在 SD 卡上生成用于存储导入数据的文本文件。
|
|
|
*
|
|
|
* @param context Android 上下文对象。
|
|
|
* @param filePathResId 文件路径资源ID。
|
|
|
* @param fileNameFormatResId 文件名格式资源ID。
|
|
|
* @return 生成的文件对象，或者在出错时返回 null。
|
|
|
*/
|
|
|
private static File generateFileMountedOnSDcard(Context context, int filePathResId, int fileNameFormatResId) {
|
|
|
// 根据资源ID生成文件路径和文件名，并创建文件。
|
|
|
}
|
|
|
} |
