/*
 * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * 您可以在遵守 License 的前提下使用本文件。
 * 您可以从以下地址获取 License 副本：
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 * 除非适用法律要求或书面同意，本软件根据 License 分发时“按现状”提供，
 * 不附带任何明示或暗示的保证或条件。请参阅 License 了解具体的权限和限制。
 */

package net.micode.notes.tool; // 指定代码所属的包名

import android.content.Context; // 导入Context类，提供应用环境信息
import android.database.Cursor; // 导入Cursor类，用于查询数据库结果集
import android.os.Environment; // 导入Environment类，获取外部存储信息
import android.text.TextUtils; // 导入TextUtils类，提供文本处理工具
import android.text.format.DateFormat; // 导入DateFormat类，用于日期格式化
import android.util.Log; // 导入Log类，用于日志记录

import net.micode.notes.R; // 导入R资源类，访问应用资源
import net.micode.notes.data.Notes; // 导入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; // 导入File类，用于文件操作
import java.io.FileNotFoundException; // 导入文件未找到异常类
import java.io.FileOutputStream; // 导入文件输出流类
import java.io.IOException; // 导入IO异常类
import java.io.PrintStream; // 导入打印流类，用于文本输出

/**
 * 备份工具类，用于将笔记数据导出为文本文件
 * 支持导出到SD卡，提供备份状态反馈和文件管理功能
 */
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; // 文本导出器实例

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

    /**
     * 检查外部存储是否可用
     * @return 可用返回true，否则返回false
     */
    private static boolean externalStorageAvailable() {
        return Environment.MEDIA_MOUNTED.equals(Environment.getExternalStorageState()); // 检查SD卡挂载状态
    }

    /**
     * 导出笔记到文本文件
     * @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 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); // 获取MIME类型
                        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; // 返回SD卡未挂载状态
            }

            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); // 获取文件夹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); // 生成SD卡上的文件
            if (file == null) { // 检查文件是否生成成功
                Log.e(TAG, "create file to exported failed"); // 记录错误日志
                return null; // 返回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; // 返回null表示失败
            } catch (NullPointerException e) { // 处理空指针异常
                e.printStackTrace(); // 打印异常堆栈
                return null; // 返回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) { // 处理IO异常
            e.printStackTrace(); // 打印异常堆栈
        }

        return null; // 返回null表示失败
    }
}