/*
 * 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";

    // Singleton stuff
    /**
     * 单例模式，用于确保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; // 返回单例对象。
    }

    /**
     * 定义备份或恢复状态的常量。
     */
    // Currently, the sdcard is not mounted
    public static final int STATE_SD_CARD_UNMOUONTED = 0; // SD卡未挂载。
    // The backup file not exist
    public static final int STATE_BACKUP_FILE_NOT_EXIST = 1; // 备份文件不存在。
    // The data is not well formated, may be changed by other programs
    public static final int STATE_DATA_DESTROIED = 2; // 数据格式不正确，可能被其他程序修改。
    // Some run-time exception which causes restore or backup fails
    public static final int STATE_SYSTEM_ERROR = 3; // 运行时异常导致备份或恢复失败。
    // Backup or restore success
    public static final int STATE_SUCCESS = 4; // 备份或恢复成功。

    /**
     * TextExport类的实例，用于将数据导出为文本。
     */
    private TextExport mTextExport;

    /**
     * BackupUtils类的构造函数。
     * @param context 上下文对象，用于访问应用的资源和类。
     */
    private BackupUtils(Context context) {
        mTextExport = new TextExport(context); // 初始化TextExport对象。
    }

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

    /**
     * 导出数据为文本。
     * @return 返回导出操作的状态码。
     */
    public int exportToText() {
        return mTextExport.exportToText(); // 调用TextExport对象的exportToText方法。
    }

    /**
     * 获取导出文本文件的文件名。
     * @return 返回导出文本文件的文件名。
     */
    public String getExportedTextFileName() {
        return mTextExport.mFileName; // 返回TextExport对象的文件名。
    }

    /**
     * 获取导出文本文件的目录。
     * @return 返回导出文本文件的目录。
     */
    public String getExportedTextFileDir() {
        return mTextExport.mFileDirectory; // 返回TextExport对象的文件目录。
    }

    /**
 * 私有静态内部类，用于将数据导出为文本格式。
 */
    private static class TextExport {
    /**
     * 定义查询笔记时需要的列。
     */
    private static final String[] NOTE_PROJECTION = {
            NoteColumns.ID, // 笔记ID
            NoteColumns.MODIFIED_DATE, // 最后修改日期
            NoteColumns.SNIPPET, // 笔记摘要
            NoteColumns.TYPE // 笔记类型
    };

    /**
     * 定义NOTE_PROJECTION数组中各列的索引。
     */
    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 int NOTE_COLUMN_TYPE = 3; // 笔记类型列索引

    /**
     * 定义查询数据时需要的列。
     */
    private static final String[] DATA_PROJECTION = {
            DataColumns.CONTENT, // 数据内容
            DataColumns.MIME_TYPE, // 数据MIME类型
            DataColumns.DATA1, // 数据字段1
            DataColumns.DATA2, // 数据字段2
            DataColumns.DATA3, // 数据字段3
            DataColumns.DATA4 // 数据字段4
    };

    /**
     * 定义DATA_PROJECTION数组中各列的索引。
     */
    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; // 通话日期列索引（注意：这里应该是DATA3，因为DATA2和DATA3的索引被占用了）
    private static final int DATA_COLUMN_PHONE_NUMBER = 4; // 电话号码列索引（注意：这里应该是DATA4，因为DATA4的索引被占用了）

    /**
     * 定义导出文本的格式。
     */
    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;

    /**
     * TextExport类的构造函数。
     * @param context 上下文对象，用于访问应用的资源和类。
     */
    public TextExport(Context context) {
        TEXT_FORMAT = context.getResources().getStringArray(R.array.format_for_exported_note); // 从资源文件中获取导出文本的格式
        mContext = context; // 初始化上下文对象
        mFileName = ""; // 初始化文件名为空
        mFileDirectory = ""; // 初始化文件目录为空
    }

    /**
     * 根据ID获取对应的格式字符串。
     * @param id 格式ID。
     * @return 返回对应的格式字符串。
     */
    private String getFormat(int id) {
        return TEXT_FORMAT[id]; // 返回TEXT_FORMAT数组中对应ID的格式字符串
    }
    }

        /**
         * Export the folder identified by folder id to text
         */
        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的笔记导出到PrintStream。
         * @param noteId 笔记ID。
         * @param ps PrintStream对象，用于输出文本数据。
         */
        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());
            }
        }

        /**
         * Note will be exported as text which is user readable
         */
        public int exportToText() {
            // 检查外部存储是否可用
            if (!externalStorageAvailable()) {
                Log.d(TAG, "Media was not mounted"); // 如果外部存储不可用，则记录日志
                return STATE_SD_CARD_UNMOUONTED; // 返回SD卡未挂载的状态码
            }
        
            // 获取用于导出文本的PrintStream对象
            PrintStream ps = getExportToTextPrintStream();
            if (ps == null) {
                Log.e(TAG, "get print stream error"); // 如果获取PrintStream失败，则记录错误日志
                return STATE_SYSTEM_ERROR; // 返回系统错误的状态码
            }
            // 首先导出文件夹及其笔记
            Cursor folderCursor = mContext.getContentResolver().query(
                    Notes.CONTENT_NOTE_URI, // 笔记内容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, // 笔记内容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(); // 关闭PrintStream对象
        
            return STATE_SUCCESS; // 返回成功的状态码
        }

        /**
         * Get a print stream pointed to the file {@generateExportedTextFile}
         */
        private PrintStream getExportToTextPrintStream() {
            // 在SD卡上生成用于导出的文件
            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; // 返回null
            }
            mFileName = file.getName(); // 设置导出文件的文件名
            mFileDirectory = mContext.getString(R.string.file_path); // 设置导出文件的目录
            PrintStream ps = null; // 初始化PrintStream对象
            try {
                FileOutputStream fos = new FileOutputStream(file); // 创建文件输出流
                ps = new PrintStream(fos); // 创建PrintStream对象
            } catch (FileNotFoundException e) {
                e.printStackTrace(); // 如果发生文件未找到异常，则打印堆栈跟踪
                return null; // 返回null
            } catch (NullPointerException e) {
                e.printStackTrace(); // 如果发生空指针异常，则打印堆栈跟踪
                return null; // 返回null
            }
            return ps; // 返回PrintStream对象
        }
        
        /**
         * 在SD卡上生成用于存储导入数据的文本文件。
         */
        private static File generateFileMountedOnSDcard(Context context, int filePathResId, int fileNameFormatResId) {
            StringBuilder sb = new StringBuilder(); // 初始化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(); // 如果发生IO异常，则打印堆栈跟踪
            }
        
        return null; // 如果发生异常，则返回null
    }
}

