/*
 * 版权所有 (c) 2010-2011，MiCode 开源社区 (www.micode.net)
 * 根据 Apache 许可证 2.0 版本（"许可证"）授权；
 * 除非符合许可证的规定，否则不得使用本文件。
 * 您可以从以下网址获取许可证副本：
 * http://www.apache.org/licenses/LICENSE-2.0
 * 除非适用法律要求或书面同意，本软件按"原样"分发，
 * 没有任何明示或暗示的保证或条件。
 * 详见许可证中规定的权限和限制。
 * （注：这是一份标准的Apache许可证2.0版本的开源声明）
 */
// 定义备份工具类的包路径
package net.micode.notes.tool;

// 导入所需的Android类库
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;   // 笔记列定义

// 导入Java IO类
import java.io.File;                          // 文件操作类
import java.io.FileNotFoundException;        // 文件未找到异常
import java.io.FileOutputStream;             // 文件输出流
import java.io.IOException;                   // IO异常
import java.io.PrintStream;                   // 打印流

/**
 * 备份工具类，提供笔记导出为文本文件的功能
 */
public class BackupUtils {
    private static final String TAG = "BackupUtils"; // 日志标签

    // 单例实现部分
    private static BackupUtils sInstance;    // 单例实例

    /**
     * 获取备份工具单例
     * @param context 上下文对象
     * @return 备份工具实例
     */
    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 final TextExport mTextExport;         // 文本导出器

    /**
     * 私有构造函数
     * @param context 上下文对象
     */
    private BackupUtils(Context context) {
        mTextExport = new TextExport(context); // 初始化文本导出器
    }

    /**
     * 检查外部存储是否可用
     * @return 是否可用
     */
    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,           // 笔记ID
                NoteColumns.MODIFIED_DATE, // 修改日期
                NoteColumns.SNIPPET,      // 笔记摘要
                NoteColumns.TYPE          // 笔记类型
        };

        // 笔记表列索引常量
        private static final int NOTE_COLUMN_ID = 0;             // ID列索引
        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,       // 扩展数据1
                DataColumns.DATA2,       // 扩展数据2
                DataColumns.DATA3,       // 扩展数据3
                DataColumns.DATA4,       // 扩展数据4
        };

        // 数据表列索引常量
        private static final int DATA_COLUMN_CONTENT = 0;       // 内容列索引
        private static final int DATA_COLUMN_MIME_TYPE = 1;     // MIME类型列索引
        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 final 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 格式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();  // 关闭游标
            }
        }

        /**
         * 导出笔记内容到文本
         * @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() {
            // 检查SD卡是否挂载
            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 打印流对象
         */
        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 | NullPointerException e) {
                e.printStackTrace();
                return null;
            }
            return ps;
        }
    }

    /**
     * 在SD卡上生成导出文件
     * @param context 上下文对象
     * @param filePathResId 文件路径资源ID
     * @param fileNameFormatResId 文件名格式资源ID
     * @return 生成的文件对象
     */
    private static File generateFileMountedOnSDcard(Context context, int filePathResId, int fileNameFormatResId) {
        StringBuilder sb = new StringBuilder();
        // 构建文件路径
        sb.append(Environment.getExternalStorageDirectory());  // SD卡根目录
        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 | IOException e) {
            e.printStackTrace();
        }

        return null; // 创建失败返回null
    }
}


